Webhook Notification - Transaction Success | SQRIL

Example webhook notification sent by SQRIL when a transaction is finalized as success.

When it is sent:

After provider webhook processing marks the transaction successful.
Sent to all active webhook configs whose event filter matches transaction.success.

Payload notes:

Required fields: tx_id, status (SUCCESS).
Optional fields: amount, fee, percentage_fee, fixed_fee, sender, recipient.
Fee fields are taken from transaction data and formatted for API/webhook output.
Sender/recipient objects are included only when those details are available on transaction qr_data.

Headers:

Content-Type: application/json
User-Agent: SQRIL-Webhook/<APP_VERSION>
X-SQRIL-Signature only when a webhook secret is configured.

Example webhook notification sent by SQRIL when a transaction is finalized as success. **When it is sent:** - After provider webhook processing marks the transaction successful. - Sent to all active webhook configs whose event filter matches `transaction.success`. **Payload notes:** - Required fields: `tx_id`, `status` (`SUCCESS`). - Optional fields: `amount`, `fee`, `percentage_fee`, `fixed_fee`, `sender`, `recipient`. - Fee fields are taken from transaction data and formatted for API/webhook output. - Sender/recipient objects are included only when those details are available on transaction `qr_data`. **Headers:** - `Content-Type: application/json` - `User-Agent: SQRIL-Webhook/<APP_VERSION>` - `X-SQRIL-Signature` only when a webhook secret is configured.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Request

This endpoint expects an object.

tx_idstringRequired

statusenumRequired

Allowed values:

amountdoubleOptional

feedoubleOptional

percentage_feedoubleOptional

fixed_feedoubleOptional

sendermap from strings to anyOptional

recipientmap from strings to anyOptional

Response

Example webhook notification sent by SQRIL when a transaction is finalized as success.

When it is sent:

After provider webhook processing marks the transaction successful.
Sent to all active webhook configs whose event filter matches transaction.success.

Payload notes:

Required fields: tx_id, status (SUCCESS).
Optional fields: amount, fee, percentage_fee, fixed_fee, sender, recipient.
Fee fields are taken from transaction data and formatted for API/webhook output.
Sender/recipient objects are included only when those details are available on transaction qr_data.

Headers:

Content-Type: application/json
User-Agent: SQRIL-Webhook/<APP_VERSION>
X-SQRIL-Signature only when a webhook secret is configured.

$	curl -X POST https://stg-api.sqril.io/webhooks/transactions/success \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"tx_id": "string",
>	"status": "SUCCESS"
>	}'