Skip to content

Изменение вебхука карты

Grant Makyan edited this page Apr 11, 2024 · 2 revisions

Изменение вебхука карты

Не забывайте про аутентификацию!


На вебхук будут отправляться все новые транзакции связанные с картой.
Данные будут отправлены через POST запрос.

Запрос:

PUT https://spworlds.ru/api/public/card/webhook

Тело запроса:

{
  "url": "https://example.ru/webhook"
}

Ответ будет содержать ID карты и обновленный webhook в формате JSON:

Название Тип Описание
id Строка Уникальный ID карты.
webhook Строка Обновленный webhook карты.

Получение данных об транзакции

После создания новой транзакции связанной с вашей картой, наш сервер отправит POST запрос на URL, который вы указали.

Тело запроса будет в формате JSON:

Название Тип Описание
id Строка Уникальный ID транзакции.
amount Число Сумма транзакции.
type Строка Тип транзакции.
sender.username Строка или undefined Ник отправителя (если есть).
sender.number Строка или undefined Номер карты отправителя (если есть).
receiver.username Строка или undefined Ник получателя (если есть).
receiver.number Строка или undefined Номер карты получателя (если есть).
comment Строка Комментарий к транзакции.
createdAt Строка Дата создания транзакции.

Важно! При обработке этого запроса надо подтвердить, что данные пришли из нашего сервера. Для этого в хедерах запроса есть хедер X-Body-Hash который содержит закодированный в base64 SHA256 HMAC хеш тела запроса, использующий как ключ API токен вашей карты. При приеме запроса вы сначала должны сгенерировать свой хеш и убедиться что он совпадает с хедером, прежде чем обрабатывать запрос.