Webhook Notification - Transaction Failed

View as Markdown
Example webhook notification sent by SQRIL when a transaction is finalized as failed. **When it is sent:** - After provider processing marks the transaction failed. - Sent to all active webhook configs whose event filter matches `transaction.failed`. **Payload notes:** - Required fields: `tx_id`, `status` (`FAILED`). - Optional fields: `error_message`, `sender`, `recipient`, and fee fields (if present). - `error_message` describes why the transaction failed. **Headers:** - `Content-Type: application/json` - `User-Agent: SQRIL-Webhook/` - `X-SQRIL-Signature` only when a webhook secret is configured.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Headers

X-SQRIL-SignaturestringOptional

HMAC-SHA256 when webhook secret configured

Request

This endpoint expects an object.
tx_idstringRequired
statusenumRequired
Allowed values:
error_messagestringOptional
sendermap from strings to anyOptional
recipientmap from strings to anyOptional

Response

OK