Веб-хуки
Веб-хук представляет собой механизм, который позволяет вашему серверу получать уведомления о событиях, связанных с платежами и возвратами. Когда происходит одно из указанных событий, наш сервис отправляет POST-запрос на указанный вами URL-адрес. Тело запроса содержит данные в формате JSON, которые имеют следующую структуру:
{
"type": "payment.succeeded" | "payment.canceled" | "refund.succeeded" | "refund.canceled",
"object": "зависит от того какой тип event, либо объект платежа, либо объект рефанда",
"secret_key": "секретный ключ из личного кабинета"
}
Параметры запроса:
- type: Этот параметр указывает тип события, произошедшего в системе. Возможные значения:
Значение | Описание |
---|---|
payment.succeeded |
Платеж оплачен |
payment.canceled |
Платеж отменен |
refund.succeeded |
Возврат успешно проведен |
regund.canceled |
Возврат отменен |
-
object: Значение этого параметра зависит от типа события. Оно может содержать либо объект платежа, если событие связано с платежом, либо объект возврата, если событие касается возврата средств. Структура объекта будет различаться в зависимости от типа события, и вы можете обратиться к соответствующей документации для получения более подробной информации о каждом из них.
-
secret_key: Это секретный ключ, который вы получите в своем личном кабинете. Он необходим для аутентификации и проверки подлинности запроса. Рекомендуем хранить его в безопасном месте и не передавать третьим лицам.