Guides

Disbursements

Suggest Edits

📘

Before you begin:

Make sure that you have a Fazz Business account with API keys generated. Go to Getting Started learn how to setup your business account.

Overview

The Send API enables you to perform fund transfers to your recipients' bank accounts. You will need to make sure that there are sufficient funds in your account for payouts to be possible. Get started with the steps below.

1. Ensure you have sufficient funds in your account

Before making any disbursements, check that you have sufficient funds in your account. If there isn't enough funds, make a deposit by following the instructions from your dashboard.

  1. Log into your Fazz Business account.
  2. Click on the Deposit icon on your dashboard.
  3. Follow the instructions to make a deposit to your account.
  4. Check your account balance to ensure the funds have been successfully deposited.

2. Create a Disbursement

Send a disbursement request by calling the Disbursements API with the following parameters:

  • amount
  • referenceId
  • description
  • disbursementMethod
  • customerProfile
curl https://www.xfers.com/api/v4/disbursements/ \
  --header 'content-type: application/vnd.api+json' \
  -u test_xxxx:password \
  -d '
  {
    "data": {
      "attributes": {
        "amount": 1000,
        "referenceId": "order_id_123456",
        "description": "Your delivery payout.",
        "disbursementMethod": {
          "type": "bank_transfer",
          "bankShortCode": "OCBC",
          "bankAccountNo": "511000000000",
          "bankAccountHolderName": "FAZZ",
          "endToEndId": "Transaction Remarks"
        }
      }
    }
  }
'

3. Get notified of the disbursement status

Once the disbursement status is confirmed, we will notify you of the disbursement status through callback notifications. Make sure to set callback URLs on your Fazz Business dashboard.

{
  "data": {
    "id": "order_86dd84f9-bd2e-4bee-a882-3ee310a3ac1a",
    "type": "disbursement",
    "attributes": {
      "referenceId": "order_id_123456",
      "description": "Your delivery payout.",
      "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"
      }
    }
  }
}

Updated over 1 year ago