Exchange Webhook
Asynchronous exchange status notification.
Endpoint
POST/callback_urlAuthentication
Merchant Credential. See Authentication.
Important Notes
WARNING
You must respond within 3 seconds. Responses slower than 3s are treated as callback failures!
Request headers
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
Content-Type | header | string | Yes | application/json | |
X-Nonce | header | string | Yes | a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e | |
X-Merchant-Id | header | string | Yes | 2492265300 | |
X-Timestamp | header | string | Yes | 1638123456 | |
Digest | header | string | Yes | SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q= | |
Authorization | header | string | Yes | Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY=" |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
mchOrderNo | string | Yes | Merchant order number |
platOrderNo | string | Yes | Platform order number |
orderStatus | string | Yes | Order status (enum=PENDING, SUCCESS, FAILED, REFUND) |
amount | number | Yes | Amount credited |
fee | number | Yes | Fee |
toPix | string | Yes | |
toIspb | string | Yes | |
toName | string | Yes | |
fromBank | string | Yes | |
fromCnpj | string | Yes | |
fromName | string | Yes | |
toCpfCnpj | string | Yes | |
ispbName | string | Yes | |
msg | string | Yes | Message — Error message |
event | string | Yes | Event (enum=PIX_OUT_SUCCESS, PIX_OUT_ERR, PIX_OUT_REFUND) |
payTime | number | Yes | |
e2eId | string | Yes | |
price | number | No | Exchange rate |
pair | string | No |
Request example
json
{
"event": "PIX_OUT_SUCCESS",
"mchOrderNo": "payout_1662104438",
"platOrderNo": "wussXUCOoXO3yptr7rQV",
"orderStatus": "PENDING",
"e2eId": "E20259930123438389IOs9ewKop39s",
"payTime": 1669080985,
"amount": 180.34,
"fee": 200.36,
"toPix": "47***112",
"toIspb": "22896431",
"toName": "SEBASTIAO CONCEICAO SANTOS",
"fromBank": "Adox IP",
"fromCnpj": "***.820.307/0002**",
"fromName": "DX MEIOS DE PAGAMENTOS LTDA",
"toCpfCnpj": "473******53",
"ispbName": "-",
"price": 5.21,
"pair": "USDT_BRL"
}