Список API
1. API «Заказ карты»
POST /cards/order
Создаёт заявку на выпуск или обновление карты клиента в банке.
Подробное описание эндпоинта
Запрос:
| № | Поле | Тип | Обяз. | Описание |
| 1 | id | UUID | + | ID запроса |
| 2 | params | Object | + | Объект запроса |
| 2.1 | externalId | String | + | Внешний ID заявки |
| 2.2 | productId | Long | + | ID продукта |
| 2.3 | phoneNumber | String | + | Номер телефона пользователя |
| 2.4 | owner | Object | + | Данные клиента |
| 2.5 | privacyPolicyAccepted | Boolean | + | Принятие политики |
| 2.6 | termsAndConditionsAccepted | Boolean | + | Принятие условий |
Ответ:
| № | Поле | Описание |
| 1 | id | ID запроса |
| 2 | result | Объект ответа |
| 2.1 | orderId | ID заявки |
| 2.2 | externalId | Сообщение об успешной регистрации заявки |
| 3 | error | Объект ошибки |
| 3.1 | code | Уникальный код ошибки |
| 3.2 | message | Сообщение ошибки |
2. API «Получение информации по заявке»
POST /cards/order/info
Возвращает детальную информацию о существующей заявке.
Подробное описание эндпоинта
Запрос:
| № | Поле | Тип | Обяз. | Описание |
| 1 | id | UUID | + | ID запроса |
| 2 | params | Object | + | Объект запроса |
| 2.1 | orderId | UUID | + | ID заявки |
Ответ:
| № | Поле | Описание |
| 1 | id | ID запроса |
| 2 | result | Объект ответа |
| 2.1 | order | Информация по заявке |
| 2.1.1 | status | NEW, PENDING, IN_PROGRESS, COMPLETED, CANCELED |
| 2.1.2 | description | Описание |
| 2.2 | card | Информация по карте |
| 2.2.1 | id | ID карты |
| 2.2.2 | pan | Номер карты |
| 2.2.3 | expiry | Срок годности карты |
| 3 | error | Объект ошибки |
| 3.1 | code | Уникальный код ошибки |
| 3.2 | message | Сообщение ошибки |
3. API «Получение статуса карты»
POST /cards/status
Возвращает текущий статус заявки на выпуск карты.
Подробное описание эндпоинта
Запрос:
| № | Поле | Тип | Обяз. | Описание |
| 1 | id | UUID | + | ID запроса |
| 2 | params | Object | + | Объект запроса |
| 2.1 | cardId | UUID | + | ID карты |
Ответ:
| № | Поле | Описание |
| 1 | id | ID запроса |
| 2 | result | Объект ответа |
| 2.1 | cardId | ID карты |
| 2.1.1 | status | ACTIVE, BLOCKED, UNVERIFIED, DELETED, CLOSED |
| 2.1.2 | reason | Причина ошибки |
| 3 | error | Объект ошибки |
| 3.1 | code | Уникальный код ошибки |
| 3.2 | message | Сообщение ошибки |
4. API «Изменение статуса карты»
PUT /cards/status
Обновляет статус уже выпущенной или подключённой карты.
Подробное описание эндпоинта
Запрос:
| № | Поле | Тип | Обяз. | Описание |
| 1 | id | UUID | + | ID запроса |
| 2 | params | Object | + | Объект запроса |
| 2.1 | cardId | UUID | + | ID карты |
| 2.2 | status | Enum | + | Новый статус карты (ACTIVE, BLOCKED, UNVERIFIED, DELETED, CLOSED) |
| 2.3 | reason | String | + | Причина |
Ответ:
| № | Поле | Описание |
| 1 | id | ID запроса |
| 2 | result | Объект ответа |
| 2.1 | cardId | ID карты |
| 2.1.1 | status | ACTIVE, BLOCKED, UNVERIFIED, DELETED, CLOSED |
| 2.1.2 | reason | Причина ошибки |
| 3 | error | Объект ошибки |
| 3.1 | code | Уникальный код ошибки |
| 3.2 | message | Сообщение ошибки |
