post
https://sandbox.xfers.io/api/v4/disbursements
Creates a disbursement that will send funds from your account to an intended recipient.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Transferring to a Bank Account
This section applies only to scenarios where you intend to transfer funds to a bank account.
{
"data":{
"attributes":{
"amount":"1000",
"currency":"SGD",
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"disbursementMethod":{
"type":"bank_transfer",
"bankShortCode":"DBS",
"bankAccountNo":"0102030405",
"bankAccountHolderName":"Gracius"
}
}
}
}{
"data":{
"id":"order_86dd84f9-bd2e-4bee-a882-3ee310a3ac1a",
"type":"disbursement",
"attributes":{
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"currency":"SGD",
"amount":"1000",
"status":"completed",
"createdAt":"2020-08-20T10:19:49+08:00",
"fees":"0.20",
"disbursementMethod":{
"type":"bank_transfer",
"bankAccountNo":"511000000000",
"bankAccountHolderName":"FAZZ",
"bankShortCode":"OCBC",
"bankName":"Oversea-Chinese Banking Corporation Limited",
"endToEndId":"f2fcfd075b3a5bd53a8b-Deposit",
"failureCode":null,
"failureReason":null
}
}
}
}Transferring to a PayNow Proxy
This section applies only to scenarios where you intend to transfer funds to a PayNow proxy. The paynow option is currently accessible only to our Beta merchants.
{
"data":{
"attributes":{
"currency":"SGD",
"amount":"100",
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"disbursementMethod":{
"type":"paynow",
"endToEndId":"remarks for recipient",
"proxyType":"mobile_number",
"proxyValue":"+6512345678"
}
}
}
}// PayNow disbursement method on Create a Disbursement API
{
"data":{
"attributes":{
"currency":"SGD",
"amount":"100",
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"disbursementMethod":{
"type":"paynow",
"endToEndId":"remarks for recipient",
"proxyType":"nric",
"proxyValue":"S1234567W"
}
}
}
}// PayNow disbursement method on Create a Disbursement API
{
"data":{
"attributes":{
"currency":"SGD",
"amount":"100",
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"disbursementMethod":{
"type":"paynow",
"endToEndId":"remarks for recipient",
"proxyType":"uen",
"proxyValue":"201411660R"
}
}
}
}// PayNow disbursement method on Create a Disbursement API
{
"data":{
"attributes":{
"currency":"SGD",
"amount":"100",
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"disbursementMethod":{
"type":"paynow",
"endToEndId":"remarks for recipient",
"proxyType":"vpa",
"proxyValue":"UEN201411660R#FAZZ"
}
}
}
}// PayNow disbursement method on Create a Disbursement API
{
"data":{
"attributes":{
"currency":"SGD",
"amount":"100",
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"disbursementMethod":{
"type":"paynow",
"endToEndId":"remarks for recipient",
"proxyType":"vpa",
"proxyValue":"+6512345678#FAZZ"
}
}
}
}// Changes on create disbursement response, get disbursement and Send webhook
{
"data":{
"id":"order_947c5768-b5e8-48b7-be4d-e6654fe1ef93",
"type":"disbursement",
"attributes":{
"referenceId":"order_id_123456",
"description":"Your delivery payout.",
"currency":"SGD",
"amount":"1000.0",
"status":"completed",
"createdAt":"2023-11-06T15:48:12+08:00",
"fees":"0.0",
"disbursementMethod":{
"type":"paynow",
"proxyType":"mobile_number", //The value may vary depending on the request
"proxyValue":"+6512345678", //The value may vary depending on the request
"failureCode":null,
"failureReason":null,
"endToEndId":"c5c1968c274faba63410-Withdrawal"
}
}
}
}