WebHook оплаты

WebHook

Важно

Наша система имеет возможность уведомления об изменении статуса платежа.

Вам требуется добавить необходимый URL для отправки http-уведомлений на страницу интеграции кассы.

Уведомление об успешной оплате, закрытии инвойса (пользователь не завершил процесс оплаты) и возврате отличается по отправляемым данным.
Уведомления о успешной оплате, закрытии инвойса (пользователь не завершил процесс оплаты) и возврате уходят по одному url, будьте внимательны при определении статуса платежа.

Заголовки запроса ( Headers )

  1. 1.'Accept: application/json'
  2. 2.'Content-Type: application/json'
  3. 3.'x-api-sha256-signature: {Signature}'
В заголовке x-api-sha256-signature содержится сигнатура подтверждающая валидность (подробнее в инструкции по формированию сигнатуры).
Имя поляТип поляОписание
invoice_iduuidID транзакции
statusstringСтатус транзакции
Варианты: success - успех,
fail - транзакция отклонена,
expired - истек по времени
refund - возвращен
amountstringСумма заказа
currencystringВалюта заказа (RUB, USD, EUR, UAH)
order_idstringID платежа в вашей системе
pay_servicestringМетод оплаты (В случае успеха)
payer_detailsstringРеквизиты плательщика (Может быть пустым) (В случае успеха)
custom_fieldsJSONСтрока, которую вы передавали в параметрах при создании платежа
typeintТип хуки
Варианты:
1 - Платеж
2 - Возврат
creditednumberСумма зачисленная вам на баланс (В рублях) (В случае успеха)
pay_timedatetime
2023-03-21 14:00		Время оплаты (В случае успеха)
codeintСтатус код
1 - Успех
20 - Успешный возврат
31 - Закрыт из-за окончания времени жизни
32 - Ошибочное закрытие инвойса
reject_timedatetime
2023-03-21 14:00		Время закрытия заказа (В случае неуспешного платежа)
refund_amountstringСумма возврата (В случае возврата)
refund_reasonstring|nullПричина возврата (В случае возврата)
refund_timedatetime 2023-03-21 14:00Время возврата (В случае возврата)
Тип поля
uuid
Описание
ID транзакции
Тип поля
string
Описание
Статус транзакции
Варианты: success - успех,
fail - транзакция отклонена,
expired - истек по времени
refund - возвращен
Тип поля
string
Описание
Сумма заказа
Тип поля
string
Описание
Валюта заказа (RUB, USD, EUR, UAH)
Тип поля
string
Описание
ID платежа в вашей системе
Тип поля
string
Описание
Метод оплаты (В случае успеха)
Тип поля
string
Описание
Реквизиты плательщика (Может быть пустым) (В случае успеха)
Тип поля
JSON
Описание
Строка, которую вы передавали в параметрах при создании платежа
Тип поля
int
Описание
Тип хуки
Варианты:
1 - Платеж
2 - Возврат
Тип поля
number
Описание
Сумма зачисленная вам на баланс (В рублях) (В случае успеха)
Тип поля
datetime
2023-03-21 14:00
Описание
Время оплаты (В случае успеха)
Тип поля
int
Описание
Статус код
1 - Успех
20 - Успешный возврат
31 - Закрыт из-за окончания времени жизни
32 - Ошибочное закрытие инвойса
Тип поля
datetime
2023-03-21 14:00
Описание
Время закрытия заказа (В случае неуспешного платежа)
Тип поля
string
Описание
Сумма возврата (В случае возврата)
Тип поля
string|null
Описание
Причина возврата (В случае возврата)
Тип поля
datetime 2023-03-21 14:00
Описание
Время возврата (В случае возврата)

Пример webhook:

Успешная оплата:

  1. 1.{
  2. 2. "invoice_id": "a750dced-0f08-384a-a441-d0a4dba0cae8",
  3. 3. "status": "success",
  4. 4. "amount": "100.00",
  5. 5. "currency": "RUB",
  6. 6. "order_id": "89f2634c-afa9-3b16-bbde-e4a59ee94639",
  7. 7. "custom_fields": { "user": 1 },
  8. 8. "type": 1,
  9. 9. "pay_time": "2023-04-06 15:53:28",
  10. 10. "pay_service": "card",
  11. 11. "payer_details": "553691******1279",
  12. 12. "code": 1,
  13. 13. "credited": "95.50"
  14. 14.}

Не успешная оплата:

  1. 1.{
  2. 2. "invoice_id": "e8e872cd-a37a-376e-b88c-b48151ea8d59",
  3. 3. "status": "expired",
  4. 4. "amount": "100.00",
  5. 5. "currency": "RUB",
  6. 6. "order_id": "299961cc-ab7c-3d7c-aa06-e6b026e1cc10",
  7. 7. "custom_fields": { "user": 1 },
  8. 8. "type": 1,
  9. 9. "code": 31,
  10. 10. "reject_time": "2023-04-06 15:39:19"
  11. 11.}

Возврат:

  1. 1.{
  2. 2. "invoice_id": "e8e872cd-a37a-376e-b88c-b48151ea8d59",
  3. 3. "status": "refund",
  4. 4. "amount": "100.00",
  5. 5. "currency": "RUB",
  6. 6. "order_id": "299961cc-ab7c-3d7c-aa06-e6b026e1cc10",
  7. 7. "custom_fields": { "user": 1 },
  8. 8. "type": 2,
  9. 9. "code": 20,
  10. 10. "refund_amount": "100.00",
  11. 11. "refund_reason": "По просьбе клиента",
  12. 12. "refund_time": "2023-04-06 15:39:19"
  13. 13.}