Onramp
This section provides a list of possible events that can be received as webhooks for Onramp transactions.
To have the real-time updates between TransFi and Customers, we are configuring the webhook events to be sent to Customers on below events.
| Events | Event Type | Status | Descriptions |
|---|---|---|---|
| Payment Initiated | Order | initiated | Post confirming the order details and payment method selection, the user will be redirecting to the payment checkout page |
| Payment Authorised | Order | fund_settled | User has submitted the payment details on the payment checkout page and the confirmation is received from the bank |
| Payment Unauthorised | Order | fund_failed | User has submitted the payment details on the payment checkout page and the payment is declined from the bank |
| Crypto Settled | Order | asset_settled | User has received the crypto |
| Crypto Settle Failed | Order | asset_settle_failed | User has failed received the crypto |
| Expired | Order | expired | Order expired due to inactivity |
Sample Event For Order:
{
"orgId": "OG-220927101501",
"entityId": "OR-2302271108092",
"entityType": "order",
"status": "initiated",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456790",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1390,
"cryptoAmount": 23.16390181,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNk2abcde",
"paymentType": null,
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-220927101501",
"entityId": "OR-2302271108092",
"entityType": "order",
"status": "fund_settled",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456790",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1390,
"cryptoAmount": 23.16390181,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNk2abcde",
"paymentType": null,
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-220927101501",
"entityId": "OR-2302271108092",
"entityType": "order",
"status": "fund_failed",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456790",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1390,
"cryptoAmount": 23.16390181,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNk2abcde",
"paymentType": null,
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-220927101501",
"entityId": "OR-2302271108092",
"entityType": "order",
"status": "asset_settled",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456790",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1390,
"cryptoAmount": 23.16390181,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNk2abcde",
"paymentType": null,
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-220927101501",
"entityId": "OR-2302271108092",
"entityType": "order",
"status": "asset_settle_failed",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456790",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1390,
"cryptoAmount": 23.16390181,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNk2abcde",
"paymentType": null,
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-220927101501",
"entityId": "OR-2302271108092",
"entityType": "order",
"status": "expired",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456790",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1390,
"cryptoAmount": 23.16390181,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNk2abcde",
"paymentType": null,
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}Updated 4 months ago