К содержимому

Запрос кода подтверждения

Код подтверждения запрашивается и уходит покупателю одним вызовом:

  • метод: 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)Идентификатор инструмента подтверждения оплаты
languageIdstring(2) enumЯзык плательщикаru, en
customer *CustomerИнформация о плательщике

CodeResponse

СвойствоТипОписание
data *PaymentResponseИнформация об оплате

PaymentResponse

СвойствоТипОписание
type *enumТип действия: none
result *enumСтатус проверки (см. ниже)
resultData *objectCode

Возможные статусы:

  • error - ошибка
  • codeAlreadySent - код уже был отправлен ранее, срок повторной отправки кода не истёк
  • success - успешно

Code

СвойствоТипОписание
publicCode *stringПубличный идентификатор кода
leftAttempt *intКоличество оставшихся попыток отправки кода
Страница помогла?