Вебхуки

Протокол имеет поддержку обратных запросов (Webhooks, Callbacks) которые позволяют осуществлять доставку информации на указанные клиентом адреса. Сразу после изменения ордера в статус success(Успешно) сервер попытается отправить информацию о событии на сервер клиента, на URL вебхука указанного в запросе на создание ордера.

Клиент может настроить индивидуальные адреса для вебхуков или использовать один и тот же адрес для всех вебхуков. Так же можно не указывать адреса для вебхуков, в таком случае они не будут срабатывать.

Вебхуки имеют базовый формат данных:

{
    id: "lux01993328-a828-7581-b3a9-e712a6a0e88c"
    order_id: "uE4wBDWPEN77F9FzXA1w8NbVSB",
    type: "card",
    amount: 2300,
    status: "success",
    created_at: "2025-02-06 13:00:13.276",
}
Поле
Тип
Описание

id

string (uuid)

Уникальный идентификатор внутренней системы (internal_id)

order_id

string (uuid)

Уникальный идентификатор

на стороне мерчанта (external_id)

type

string (enum)

Тип платежа:

  • card - карта РФ

  • sim - СБП РФ

  • sngs - сбп трансграничный

amount

Integer

Сумма платежа в RUB

status

string (enum)

Статус платежа

  • pending - заявка в работе либо не была завершена по каким то причинам

  • success - заявка успешно закрыта

  • error - заявка не была принята / отменена по каким то причинам

created_at

string (datetime)

Дата и время создания заявки

Также вебхук имеет заголовок x-api-key содержащий тот же ключ API что используется для реквестов в зашифрованном виде.

В ответ на запрос вебхук ожидает код 200 в качестве подтверждения получения информации. Если код ответа будет иным, вебхук попытается повторно доставить информацию с задержкой в:

  • 15 секунд

  • 1 минуту

  • 5 минут

  • 15 минут

  • 1 час

после чего прекратит пытаться доставить информацию.

Последнее обновление