🌐 Webhooks
Note
The webhook payload is sent in an encrypted format. To access it, you must decrypt it using your ACCESS_TOKEN which you can generate one using our Refresh Token endpoint. To learn more, click here.
Below is the list of the events when we send the webhook:
On Ramp, NFT Checkout and Transak One
| Webhook Event Code | Description | Status Code |
|---|---|---|
| ORDER_PROCESSING | Orders in the PROCESSING state have passed the checks and the user's payment information has been validated. | PROCESSING |
| ORDER_FAILED | When the user failed to make the payment within the timeframe. | EXPIRED |
| ORDER_FAILED | When the order is failed because of the card decline. | FAILED |
| ORDER_FAILED | When the user cancels the order. | CANCELLED |
| ORDER_COMPLETED | When we have received the payment and the crypto is sent successfully to the user. | COMPLETED |
| ORDER_PROCESSING | When the payment is received and being exchanged & transferred via us or our liquidity partner. | PENDING_DELIVERY_FROM_TRANSAK |
| ORDER_PAYMENT_VERIFYING | When the user marks the payment as done but it is not received by us yet. | PAYMENT_DONE_MARKED_BY_USER |
| ORDER_CREATED | When the order is created but the payment still not received. | AWAITING_PAYMENT_FROM_USER |
| ORDER_REFUNDED | When fiat payment received from user is refunded back to the user's payment instrument as cryptocurrency could not be fulfilled due to some reason. | REFUNDED |
Off Ramp
| WebSocket Event Code | Description | Status Code |
|---|---|---|
| ORDER_CREATED | When the order is created but the payment still not received. | AWAITING_PAYMENT_FROM_USER |
| ORDER_PAYMENT_VERIFYING | When the user marks the payment as done but it is not received by us yet. | PAYMENT_DONE_MARKED_BY_USER |
| ORDER_PROCESSING | When the payment is received and reconciled and we have initiated fiat transfer to the user. | PENDING_DELIVERY_FROM_TRANSAK |
| ORDER_PROCESSING | When the crypto payment is received & fiat being transferred via our banking partner but because of some issue our system is unable to send the fiat to the user. | ON_HOLD_PENDING_DELIVERY_FROM_TRANSAK |
| ORDER_COMPLETED | When we have received the crypto payment and fiat is sent successfully to the user’s bank account. | COMPLETED |
| ORDER_FAILED | When the user failed to make the payment within the timeframe. | EXPIRED |
| ORDER_FAILED | Due to third party failure. | FAILED |
| ORDER_FAILED | When the user manually cancels the order. | CANCELLED |
| ORDER_REFUNDED | When cryptocurrency payment received from user is refunded back to the user's wallet as fiat payout could not be fulfilled due to some reason. | REFUNDED |
Quick Links:
Updated about 2 months ago