๐ŸŒ 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.

On Ramp, NFT Checkout, and Transak One

Below is the list of events when we send the webhook:

Screens

Webhook Events Code

Status Code

Description

Response JSON

ORDER_CREATED

AWAITING_PAYMENT_FROM_USER

When the order is created, but the payment has not been received yet.

{ webhookData: { id: '37969614-900e-4032-af62-c1e558137f4e', ... }, eventID: 'ORDER_CREATED', }

ORDER_PAYMENT_VERIFYING

PAYMENT_DONE_MARKED_BY_USER

When the user marks the payment as done but it is not received by us yet.

ORDER_PROCESSING

PROCESSING

Orders in the PROCESSING state have passed the checks and the user's payment information has been validated.

{ webhookData: { id: 'e0d9f47a-0bbc-406d-99db-c4dec1faa350', ...}, eventID: 'ORDER_PROCESSING', }

ORDER_PROCESSING

PENDING_DELIVERY_FROM_TRANSAK

When the payment is received and is being exchanged & transferred via us or our liquidity partner.

{ webhookData: { id: 'e0d9f47a-0bbc-406d-99db-c4dec1faa350', ...}, eventID: 'ORDER_PROCESSING', }

ORDER_COMPLETED

COMPLETED

When we have received the payment and the crypto is sent successfully to the user.

{ webhookData: { id: 'e0d9f47a-0bbc-406d-99db-c4dec1faa350', ...}, eventID: 'ORDER_COMPLETED', }

ORDER_FAILED

CANCELLED

When the user cancels the order.

{ webhookData: { id: '08c570cf-f600-4219-af55-9f134b022615', ...}, eventID: 'ORDER_FAILED', }

ORDER_FAILED

FAILED

When the order is failed because of the card decline.

{ webhookData: { id: '08c570cf-f600-4219-af55-9f134b022615', ...}, eventID: 'ORDER_FAILED', }

ORDER_REFUNDED

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.

{ webhookData: { id: '08c570cf-f600-4219-af55-9f134b022615', ...}, eventID: 'ORDER_REFUNDED', }

ORDER_FAILED

EXPIRED

When the user failed to make the payment within the timeframe.

{ webhookData: { id: '08c570cf-f600-4219-af55-9f134b022615', ...}, eventID: 'ORDER_EXPIRED', }


Off Ramp

ScreensWebhook Events CodeStatus CodeDescription
ORDER_CREATEDAWAITING_PAYMENT_FROM_USERWhen the order is created but the payment still not received.
ORDER_PAYMENT_VERIFYINGPAYMENT_DONE_MARKED_BY_USERWhen the user marks the payment as done but it is not received by us yet.
ORDER_PROCESSINGPENDING_DELIVERY_FROM_TRANSAKWhen the payment is received and reconciled and we have initiated fiat transfer to the user.
ORDER_PROCESSINGON_HOLD_PENDING_DELIVERY_FROM_TRANSAKWhen 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. .
ORDER_COMPLETEDCOMPLETEDWhen we have received the payment and the crypto is sent successfully to the user.
ORDER_FAILEDEXPIREDWhen the user failed to make the payment within the timeframe.
ORDER_FAILEDFAILEDDue to third party failure.
ORDER_FAILEDCANCELLEDWhen the user manually cancels the order.
ORDER_REFUNDEDREFUNDEDWhen cryptocurrency payment received from user is refunded back to the user's wallet as fiat payout could not be fulfilled due to some reason.

Quick Links: