Webhooks

Transak uses webhooks to push real-time event notifications to your server. Instead of polling the API for updates, Transak sends event data directly to a URL you provide to ensure faster updates and fewer unnecessary API calls.

Supported Webhook Types

Add or Update Webhook

Order Webhooks

Notify the partner’s backend in real time when an order’s status changes. These events allow partners to track order creation, status updates, completion, and failures.

Events

On Ramp / NFT Checkout

Off Ramp

Screen	Webhook Event Code	Status	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-...', ... }, 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-...', ... }, 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-...', ... }, eventID: 'ORDER_PROCESSING' }
	ORDER_COMPLETED	COMPLETED	When we have received the payment and the crypto is sent successfully to the user.	{ webhookData: { id: 'e0d9f47a-...', ... }, eventID: 'ORDER_COMPLETED' }
	ORDER_FAILED	CANCELLED	When the user cancels the order.	{ webhookData: { id: '08c570cf-...', ... }, eventID: 'ORDER_FAILED' }
	ORDER_FAILED	FAILED	When the order failed because of a card decline.	{ webhookData: { id: '08c570cf-...', ... }, eventID: 'ORDER_FAILED' }
	ORDER_REFUNDED	REFUNDED	When fiat payment received from the user is refunded back to their payment instrument as cryptocurrency could not be fulfilled due to some reason.	{ webhookData: { id: '08c570cf-...', ... }, eventID: 'ORDER_REFUNDED' }
	ORDER_FAILED	EXPIRED	When the user failed to make the payment within the timeframe.	{ webhookData: { id: '08c570cf-...', ... }, eventID: 'ORDER_EXPIRED' }

Decrypting the Webhook Payload

The webhook data field is a signed JWT that should be verified using your Partner Access Token before you process it on your backend.

KYC Webhooks

Notify partner’s backend in real-time when a user’s KYC verification status changes. These events allow to track KYC submissions, approvals and rejections.

Events

The following Event IDs are triggered during the KYC lifecycle and sent via webhook

Webhook Response

Schema

1
{
2
  "data": {
3
    "kycStatus": "string",
4
    "eventID": "string",
5
    "partnerUserId": "string",
6
    "partnerCustomerId": "string" //Optional
7
  }
8
}

Sample Response

1
{
2
  "data": {
3
    "kycStatus": "SUBMITTED",
4
    "eventID": "KYC_SUBMITTED",
5
    "partnerUserId": "0870c29f-75a8-4091-a068-775fa4577172",
6
    "partnerCustomerId": "12345"
7
  }
8
}

1
{
2
  "data": {
3
    "kycStatus": "APPROVED",
4
    "eventID": "KYC_APPROVED",
5
    "partnerUserId": "0870c29f-75a8-4091-a068-775fa4577172",
6
    "partnerCustomerId": "12345"
7
  }
8
}

1
{
2
  "data": {
3
    "kycStatus": "REJECTED",
4
    "eventID": "KYC_REJECTED",
5
    "partnerUserId": "0870c29f-75a8-4091-a068-775fa4577172",
6
    "partnerCustomerId": "12345"
7
  }
8
}