Webhook платежа

Когда статус платежа меняется, KassaGO отправляет POST-запрос с JSON на ваш адрес. Адрес задаётся в настройках интеграции кассы или в параметре hook_url при создании платежа.

Когда приходит

Событиеstatustypecode
Платёж оплаченsuccess11
Счёт истёкexpired131
Счёт закрыт с ошибкойfail132
Возвратrefund220
status
success
type
1
code
1
status
expired
type
1
code
31
status
fail
type
1
code
32
status
refund
type
2
code
20
Все события приходят на один и тот же адрес, а набор полей зависит от события. Определяйте событие по полям status и type.

Как обработать

  1. Проверьте подпись из заголовка x-api-sha256-signature — как это сделать.
  2. Найдите заказ по order_id и убедитесь, что сумма и валюта совпадают.
  3. Обрабатывайте webhook идемпотентно: повторное уведомление по уже обработанному заказу не должно менять его состояние.
  4. Отвечайте кодом 200 как можно быстрее, а долгую обработку выполняйте асинхронно.
  5. Если сомневаетесь в статусе — запросите информацию о платеже.

Заголовки

  1. 1.Accept: application/json
  2. 2.Content-Type: application/json
  3. 3.x-api-sha256-signature: {Signature}

Поля

invoice_iduuid
Идентификатор платежа
order_idstring
Идентификатор заказа в вашей системе
statusstring
success, fail, expired или refund. Описание статусов
typeint
1 — платёж, 2 — возврат
codeint
Код события — см. таблицу выше
amountstring
Сумма счёта
currencystring
Валюта счёта
custom_fieldsobject
Данные, переданные в custom_fields при создании
pay_servicestring
Метод оплаты. Только для success
payer_detailsstring
Реквизиты плательщика. Только для success, может быть пустым
creditedstring
Сумма, зачисленная на баланс (в рублях). Только для success
pay_timeY-m-d H:i:s
Время оплаты. Только для success
reject_timeY-m-d H:i:s
Время закрытия счёта. Только для fail и expired
refund_amountstring
Сумма возврата. Только для refund
refund_reasonstring | null
Причина возврата. Только для refund
refund_timeY-m-d H:i:s
Время возврата. Только для refund