Disbursements

📘

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, both to regular bank account number and virtual account number. 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 aren'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. Check the validity of the destination bank account

Before you request a fund transfer, make sure to check that the receiving bank account belongs to the person you intend to send to! You can do this using our Bank Account Validation API. Check that the name of the bank account owner is the name of the person you intend to send money to.

# POST /api/v4/validation_services/bank_account_validation
{
  "data": {
    "attributes": {
      "accountName": "INKLUSI KEUANGAN NUSANTARA",
      "accountNo": "000501003219303",
      "bankShortCode": "BRI"
    }
  }
}

3. Create a Disbursement

Create a disbursement by calling the Disbursements API with the following parameters:

• amount
• referenceId
• description
• disbursementMethod

curl https://sandbox-id.xfers.com/api/v4/disbursements/ \
  --header 'content-type: application/vnd.api+json' \
  -u test_xxxx:password \
  -d '
  {
    "data": {
      "attributes": {
        "amount": 100000,
        "currency":"IDR",
        "referenceId": "order_id_123456",
        "description": "Your delivery payout.",
        "disbursementMethod": {
          "type": "bank_transfer",
          "bankShortCode": "BRI",
          "bankAccountNo": "0102030405",
          "bankAccountHolderName": "John Doe"
        }
      }
    }
  }
'

4. 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": "contract_4a2d252b059f4d13ab3568dd5ce3c344",
    "type": "disbursement",
    "attributes": {
      "referenceId": "order_id_123456",
      "description": "Your delivery payout.",
      "amount": "100000",
      "currency":"IDR",
      "status": "completed",
      "createdAt": "2020-08-20T10:19:49+08:00",
      "fees": "3000",
      "disbursementMethod": {
        "type": "bank_transfer",
        "bankAccountNo": "0102030405",
        "bankShortCode": "BRI",
        "bankName": "Bank Rakyat Indonesia",
        "bankAccountHolderName": "John Doe",
        "serverBankAccountHolderName": "J Doe" // account holder name from the bank
      }
    }
  }
}