Payout callback

SiQURO sends payout callbacks to the webhookUrl provided in the Create batch payout request.

Callbacks are sent only if webhookUrl was provided when the payout batch was created. Both payout status updates and payout batch status updates are sent to the same URL.

Any 2xx response means the callback was accepted successfully. Otherwise SiQURO will retry sending it later.


HEADER PARAMETERS

ParameterValue
X-SIQ-SIGNATURE stringSigned hash to verify that callback is sent by SiQURO. How to verify signature?
X-SIQ-TIMESTAMP stringExample: 1700045550848 Callback timestamp

REQUEST BODT SCHEMA: application/json

Information about payout or payout batch status update

Parameter
event string Callback event type: payout_update or batch_update
batchId string SiQURO payout batch ID returned in Create batch payout response.
externalPaymentId string Payout ID from merchant system. Present only for payout_update event type.
externalUserIdstring User ID from merchant system. Present only for payout_update event type.
oldStatus string Previous payout or payout batch status.
newStatus string New payout or payout batch status.
amount number Payout amount. Present only for payout_update event type.
currency string Payout currency. Present only for payout_update event type.
createdAt string <date-time> Callback creation date.

REQUEST SAMPLES

{
  "event": "payout_update",
  "externalPaymentId": "payout-webhook-003",
  "externalUserId": "user-webhook-002",
  "oldStatus": "CREATED",
  "newStatus": "VALIDATED",
  "amount": 100.5,
  "currency": "EUR",
  "createdAt": "2026-05-22T14:38:10.454Z"
}
{
  "event": "batch_update",
  "batchId": "71caeb89-fb91-415a-bba5-70383d8971ad",
  "oldStatus": "CREATED",
  "newStatus": "APPROVED",
  "createdAt": "2026-05-22T14:38:10.458Z"
}