Plateshka
APIВебхуки

Счёт: Обрабатывается

Уходит, когда счёт переходит в статус `processing` — «Обрабатывается». Тело подписано; редиректы не выполняются. Успехом считается любой 2xx — всё остальное ставится в очередь на повтор.

Уходит, когда счёт переходит в статус processing — «Обрабатывается». Тело подписано; редиректы не выполняются. Успехом считается любой 2xx — всё остальное ставится в очередь на повтор.

Заголовки

x-plateshka-signature*string

Подпись вида t=<секунды эпохи>,v1=<hex>, где hex — HMAC-SHA256 по строке <t>.<сырое тело> с секретом endpoint'а. Значений v1 может быть несколько — так проходит ротация секрета. Метка времени входит внутрь подписываемой строки; окно приёма у SDK — 300 секунд в обе стороны. Подпись пересчитывается на каждой попытке со свежей меткой.

x-plateshka-event-id*string

Идентификатор события — по нему мерчант дедуплицирует, не разбирая тело. Детерминирован: одно и то же событие всегда несёт один и тот же UUID.

x-plateshka-event-type?string

Тип события. Ставится только на первой попытке (её шлёт API); повторы из воркера этот заголовок не несут — тип надо читать из тела.

Value in

  • "invoice.created"
  • "invoice.processing"
  • "invoice.success"
  • "invoice.failed"
  • "invoice.expired"
  • "invoice.refunded"
  • "invoice.chargeback"
x-plateshka-delivery-attempt?integer

Номер попытки. Ставится только повторами из воркера; на первой попытке его нет.

Range1 <= value

Тело запроса

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Тело события, которое уходит на endpoint мерчанта.

Тело ответа

Примеры запросов

Тело события, которое уходит на endpoint мерчанта.

POST/invoice.processing

Счёт: Ожидает оплаты

Уходит, когда счёт переходит в статус `created` — «Ожидает оплаты». Тело подписано; редиректы не выполняются. Успехом считается любой 2xx — всё остальное ставится в очередь на повтор.

Счёт: Оплачен

Уходит, когда счёт переходит в статус `success` — «Оплачен». Тело подписано; редиректы не выполняются. Успехом считается любой 2xx — всё остальное ставится в очередь на повтор.