Payouts

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`	Payout order request has been successfully initiated.
Payment Scheduled	Order	`fund_scheduled`	Payout order has been successfully scheduled.
Payment Completed	Order	`fund_settled`	User has received the funds and the confirmation is received from the bank.
Payment Failed	Order	`fund_failed`	Fund has been failed to send to the user's account.
Payment Returned	Order	`fund_returned`	Fund has been returned from the user's bank to TransFi.

Sample Event For Order:

{

  "entityId": "OR-2408090959",
  "entityType": "order",
  "orgId": "OG-231207102120",
  "eventId": "EV-240809100004273",
  "order": {
    "orderId": "OR-2408090959",
    "type": "payout",
    "fiatTicker": "EUR",
    "cryptoTicker": "",
    "cryptoNetwork": "",
    "fiatAmount": 100,
    "paymentType": "sepa_bank",
    "txnHash": "",
    "walletAddress": "",
    "destinationWalletAddress": "",
    "createdAt": "2024-11-27T05:09:15.027Z",
    "customerOrderId": "",
    "failureCode": ""
  },
  "partnerContext": {},
  "status": "initiated",
  "user": {
    "userId": "UX-240625104122",
    "firstName": "test",
    "lastName": "user",
    "country": "DE",
    "createdAt": "2024-11-27T05:09:15.027Z"
  }
}

{

  "entityId": "OR-2408090959",
  "entityType": "order",
  "orgId": "OG-231207102120",
  "eventId": "EV-240809100004274",
  "order": {
    "orderId": "OR-2408090959",
    "type": "payout",
    "fiatTicker": "EUR",
    "cryptoTicker": "",
    "cryptoNetwork": "",
    "fiatAmount": 100,
    "paymentType": "sepa_bank",
    "txnHash": "",
    "walletAddress": "",
    "destinationWalletAddress": "",
    "createdAt": "2024-11-27T05:09:15.027Z",
    "customerOrderId": "",
    "failureCode": ""
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "status": "fund_settled",
  "user": {
    "userId": "UX-240625104122",
    "firstName": "test",
    "lastName": "user",
    "country": "DE",
    "createdAt": "2024-11-27T05:09:15.027Z"
  }
}

{

  "entityId": "OR-2408090959",
  "entityType": "order",
  "orgId": "OG-231207102120",
  "eventId": "EV-240809100004275",
  "order": {
    "orderId": "OR-2408090959",
    "type": "payout",
    "fiatTicker": "EUR",
    "cryptoTicker": "",
    "cryptoNetwork": "",
    "fiatAmount": 100,
    "paymentType": "sepa_bank",
    "txnHash": "",
    "walletAddress": "",
    "destinationWalletAddress": "",
    "createdAt": "2024-11-27T05:09:15.027Z",
    "customerOrderId": "",
    "failureCode": ""
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "status": "fund_failed",
  "user": {
    "userId": "UX-240625104122",
    "firstName": "test",
    "lastName": "user",
    "country": "DE",
    "createdAt": "2024-11-27T05:09:15.027Z"
  }
}