Offramp
This section provides a list of possible events that can be received as webhooks for Collections.
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 |
| Crypto Recieved | Order | asset_deposited | TransFi has recieved the crypto from the user. |
| Crypto Recieve Failed | Order | asset_deposit_failed | TransFi has not recieved the crypto from the user. |
| Payment Sent | Order | fund_settled | User has recieved the fiat. |
| Payment Failed | Order | fund_failed | The payment is declined from the user's bank. |
| Expired | Order | expired | Order expired due to inactivity. |
Sample Event For Order:
{
"orgId": "OG-2209271015019",
"eventId": "EV-2303251340569",
"entityId": "OR-2303251339358",
"entityType": "order",
"status": "initiated",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456789",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1358,
"cryptoAmount": 22.98670591,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNkabcd",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-2209271015019",
"eventId": "EV-2303251340569",
"entityId": "OR-2303251339358",
"entityType": "order",
"status": "asset_deposited",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456789",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1358,
"cryptoAmount": 22.98670591,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNkabcd",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-2209271015019",
"eventId": "EV-2303251340569",
"entityId": "OR-2303251339358",
"entityType": "order",
"status": "asset_deposit_failed",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456789",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1358,
"cryptoAmount": 22.98670591,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNkabcd",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-2209271015019",
"eventId": "EV-2303251340569",
"entityId": "OR-2303251339358",
"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-123456789",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1358,
"cryptoAmount": 22.98670591,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNkabcd",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-2209271015019",
"eventId": "EV-2303251340569",
"entityId": "OR-2303251339358",
"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-123456789",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1358,
"cryptoAmount": 22.98670591,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNkabcd",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}{
"orgId": "OG-2209271015019",
"eventId": "EV-2303251340569",
"entityId": "OR-2303251339358",
"entityType": "order",
"status": "expired",
"user": {
"userId": "UX-2302140112529",
"firstName": "Nandy",
"lastName": "Rajan",
"country": "PH",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"order": {
"orderId": "OR-123456789",
"type": "buy",
"fiatTicker": "PHP",
"cryptoTicker": "USDTTRC20",
"fiatAmount": 1358,
"cryptoAmount": 22.98670591,
"walletAddress": "TBZmSS1Phxy8jJ9aK3Q6PyxYeNkabcd",
"createdAt": "2024-11-27T05:09:15.027Z"
},
"partnerContext": {}
}Updated 4 months ago