Link Поиск Меню Развернуть Документ

Подтверждение оплаты заказа

Для подтверждения оплаты заказа необходимо вызвать метод:

  • метод: POST
  • ресурс: /v3/billing/api/order/{uuid}/payment-method-action/pay
  • тело запроса - объект PayRequest
  • тело ответа - объект PayResponse
  • Возможные ошибки
Пример запроса и ответа
POST /v3/billing/api/order/{uuid}/payment-method-action/pay
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"
  },
  "customerPaymentData" : {
    "publicCode" : "string",
    "code" : "string"
  }
}
{
  "data": {
    "type": "none",
    "result": "success",
    "resultData": {}
  }
}

PayRequest

СвойствоОбязательноеТипОписаниеПример
paymentMethodIdдаstring(36)Идентификатор инструмента подтверждения оплаты 
languageIdнетstring(2) enumЯзык плательщикаru, en
customerдаCustomerИнформация о плательщике 
customerPaymentDataдаcustomerPaymentDataДанные ддя подтверждения оплаты заказа 

#CustomerPaymentData

СвойствоОбязательноеТипОписание
publicCodeдаstringПубличный идентификатор кода
codeдаstringПолученный плательщиком от системы Инвойсбокс код

PayResponse

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

PaymentResponse

СвойствоОбязательноеТипОписание
typeдаenumТип действия к выполнению: none, message
resultдаenumСтатус проверки (см. ниже)
resultDataдаobjectОбъект, в зависимости от типа действия (type) и результата (result), см. ниже

Message

СвойствоОбязательноеТипОписание
titleдаstringЗаголовок сообщения
messageдаstringСообщние

Если type = message, требуется отобразить пользователю информацию от системы Инвойсбокс. Информация будет передана в объекте resultData и будет содеражать вложенный объект message, пример:

{
  "message": {
    "title": "Недостаточно средств",
    "message": "Для подтверждения выбранного заказа недостаточно средств. Пожалуйста, восстановите баланс гарантийного фонда."
  }
}

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

  • alreadyPaid - Оплата заказа уже подтверждена
  • wrongCode - Передан неверный код, повторите попытку оплаты
  • limitReached - Превышено кол-во попыток оплаты
  • notEnoughMoney - Недостаточно средств на счету
  • error - Непредвиденная ошибка
  • success - Оплата прошла

Читать далее »