Запрос кода подтверждения
Код подтверждения запрашивается и уходит покупателю одним вызовом:
- метод:
POST - ресурс:
/v3/billing/api/order/{uuid}/payment-method-action/send-code - тело запроса - объект CodeRequest
- тело ответа - объект CodeResponse
- Возможные ошибки
Пример запроса и ответа
POST /v3/billing/api/order/{uuid}/payment-method-action/send-code
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
"paymentMethodId": "39363265",
"languageId": "ru",
"customer": {
"name": "ООО Компания",
"email": "email@gmail.com",
"type": "legal",
"phone": "79611234567",
"vatNumber": "1233123",
"registrationAddress": "123123123"
}
}
Ответ:
{
"data": {
"type": "none",
"result": "success",
"resultData": {
"publicCode": "aaaaaaa123",
"leftAttempt" : 5
}
}
}
CodeRequest
| Свойство | Тип | Описание | Пример |
|---|---|---|---|
| paymentMethodId * | string(36) | Идентификатор инструмента подтверждения оплаты | |
| languageId | string(2) enum | Язык плательщика | ru, en |
| customer * | Customer | Информация о плательщике |
CodeResponse
| Свойство | Тип | Описание |
|---|---|---|
| data * | PaymentResponse | Информация об оплате |
PaymentResponse
| Свойство | Тип | Описание |
|---|---|---|
| type * | enum | Тип действия: none |
| result * | enum | Статус проверки (см. ниже) |
| resultData * | object | Code |
Возможные статусы:
- error - ошибка
- codeAlreadySent - код уже был отправлен ранее, срок повторной отправки кода не истёк
- success - успешно
Code
| Свойство | Тип | Описание |
|---|---|---|
| publicCode * | string | Публичный идентификатор кода |
| leftAttempt * | int | Количество оставшихся попыток отправки кода |