Подтверждение оплаты заказа
Оплата заказа подтверждается одним вызовом:
- метод:
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 - Оплата прошла