Webhook Notifications
Webhook notifications allow your server to receive real-time updates about events such as payment and withdrawal status changes. These notifications are sent as HTTP POST requests to endpoints on your server and include an HMAC signature for verification.
Withdrawal Webhook
HTTP Method: POST
Endpoint URL: https://your-server/withdrawal
Description: Notifies your server about the creation or status change of a withdrawal request.
Security: Requires the X-HMAC header.
Request Body (JSON):
{
"id": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
"txnId": "0xe7238caa68382485141be0443d6ba7efd0bd9f6bac5a624bd059acc53af1bf1d19",
"amount": "1.00000000",
"receivedAmount": "1.00000000",
"asset": {
"short": "USDT",
"name": "Tether",
"logoUrl": "https://cryptologos.cc/logos/tether-usdt-logo.png",
"network": "tron"
},
"addressTo": "0x5D8D9C7f68A46634BCEaD2a6FF166A0BdFb08540",
"addressFrom": "0x5D8D9C7f68A46634BCEaD2a6FF166A0BdFb08540",
"destTag": "optional_tag",
"status": "OPEN",
"customer": {
"id": 12312312,
"name": "John Dou",
"email": "[email protected]"
},
"merchant": {
"id": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
"name": "Company Name",
"siteUrl": "company.com",
"logoUrl": "https://example.com/logo.svg",
"email": "[email protected]"
},
"invoice": "INV-001",
"createdAt": "2017-07-21T17:32:28Z",
"updatedAt": "2017-07-21T17:32:28Z"
}
Response:
Upon successful processing, your server should respond with an HTTP 200 OK status and no response body.
Payment Webhook
HTTP Method: POST
Endpoint URL: https://your-server/payment
Description: Notifies your server about the creation or status change of a payment.
Security: Requires the X-HMAC header.
Request Body (JSON):
{
"id": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
"transactions": [
{
"paymentId": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
"txnId": "0xe7238caa68382485141be0443d6ba7efd0bd9f6bac5a624bd059acc53af1bf1d19",
"receivedAmount": "20.00",
"asset": {
"short": "USDT",
"name": "Tether",
"logoUrl": "https://cryptologos.cc/logos/tether-usdt-logo.png",
"network": "tron"
},
"destTag": null,
"addressFrom": "0x5D8D9C7f68A46634BCEaD2a6FF166A0BdFb08540",
"addressTo": "0x5D8D9C7f68A46634BCEaD2a6FF166A0BdFb08540",
"date": "2017-07-21T17:32:28Z"
}
],
"amount": "100.00",
"totalReceivedAmount": "20.00",
"asset": {
"short": "USDT",
"name": "Tether",
"logoUrl": "https://cryptologos.cc/logos/tether-usdt-logo.png",
"network": "tron"
},
"addressTo": "0x5D8D9C7f68A46634BCEaD2a6FF166A0BdFb08540",
"confirmsNeeded": 10,
"timeout": 9000,
"checkoutUrl": "https://www.merchant.com/",
"status": "OPEN",
"customer": {
"id": 12312312,
"name": "John Dou",
"email": "[email protected]"
},
"merchant": {
"id": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
"name": "Company Name",
"siteUrl": "company.com",
"logoUrl": "https://example.com/logo.svg",
"email": "[email protected]"
},
"invoice": "INV-001",
"paymentRedirectUrl": "https://a-pay-system.com/en/invoice?id=285d8dce-7663-4580-ba7f-8afb2f2d3292",
"createdAt": "2017-07-21T17:32:28Z",
"updatedAt": "2017-07-21T17:32:28Z"
}
Response:
Upon successful processing, your server should respond with an HTTP 200 OK status and no response body.