Webhook for Merchant Notifications
When the status of a payment request changes to one of the following final states:
-
FAILED
-
EXPIRED
-
PAID
the system automatically sends a webhook notification to the merchant.
The notification is delivered as an HTTP POST request to the webhook_url provided during the creation of the payment request.
Webhook Endpoint
The merchant must provide a valid HTTPS URL in the webhook_url parameter when creating a payment request. All status‑change notifications will be sent to this URL.
Event Trigger
A webhook is triggered whenever the payment request transitions into one of the following statuses:
-
FAILED — the payment could not be completed
-
EXPIRED — the payment request expired before completion
-
PAID — the expected amount was successfully received
Payload Structure
{
"payment_request_id": "string",
"amount": "string",
"network_id": integer,
"payout_address": "string",
"status": "string",
"currency": "string",
"payload": "JSON Object"
}
| Field | Type | Description |
|---|---|---|
| payment_request_id | string | Unique identifier of the payment request |
| amount | string | Expected payment amount |
| network_id | integer | Blockchain network ID associated with the payment |
| payout_address | string | Merchant’s payout wallet address |
| status | string | Final status of the payment request (FAILED, EXPIRED, PAID) |
| currency | string | Currency code of the payment (Only USD is currently supported) |
| payload | string | JSON object with custom fields required for merchant notifications. |
Merchant Response Requirements
HTTP 201 CREATED