Входящие уведомления

Если вы хотите отслеживать состояние объектов, например платежей или возвратов, вы можете подписаться на уведомления (webhook, callback) о таких событиях, указав ссылку на обработчик уведомлений в настройках магазина.

Уведомления пригодятся в тех случаях, когда объект API изменяется без вашего участия. Например, если пользователю нужно оплатить счет, процесс оплаты может занять от нескольких минут до нескольких часов. Вместо того, чтобы всё это время периодически отправлять GET-запросы, чтобы узнать статус платежа, вы можете просто дожидаться уведомления от Payvo.

События в Payvo

Событие в Payvo — изменение статуса объекта. Вы можете отслеживать события платежей и возвратов.

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

Название события формируется по шаблону <объект>.<статус> и состоит из двух частей:

• объект, с которым произошло событие: payment — платеж, refund — возврат;

• статус, в который перешел объект, например succeeded или canceled.

Пример: payment.succeeded — платеж перешел в статус succeeded.

Использование

Как только произойдет событие, на URL, который вы указали при настройке, придет уведомление POST-запросом с телом в формате JSON.

Параметры тела уведомления

Параметр	Тип	Описание
event	string	Событие, о котором уведомляет Payvo. Пример: payment.succeeded. Обязательный параметр
object	object	Объект, с которым произошло указанное событие. Например, если в параметре event указано событие payment.succeeded, то в object вернется объект платежа, статус которого изменился на succeeded. Объект содержит данные, актуальные на тот момент, когда произошло событие. Обязательный параметр
secret_key	string	Секретный ключ вашего магазина из ЛК