Submit Disbursement API

The following endpoint submit a disbursement:

/disbursements/submit

Request Header Attributes

Following are the parameters to be sent in the request header:

idempotency_key

String

Mandatory

The idempotency key used to submit the disbursement batch. It will be used to prevent accidentally creating the same disbursement more than once.

`idempotency_key` will be removed once `X-Idempotency-Key` is made as mandatory by August 1st, 2023. To know the difference between `X-Idempotency-Key` and `idempotency_key`, please visit the Implementation Guide here.

X-Idempotency-Key

String

Mandatory

The idempotency key used to submit the disbursement request. It will be used to prevent accidentally creating the same disbursement more than once.

Idempotency key is mandatory for each disbursement request. This ensures disbursement requests won't be created more than once. Please see more detail on Implementation Guide.

For merchants who have integrated before May 9th, 2023, we allow backward compatibility by making this optional until July 31st, 2023. By August 1st, 2023, all merchants have to implement this on request header, else requests to this API without X-Idempotency-Key on header will receive error response..

Path Attributes

force_disburse

Boolean

Optional

If this parameter is true then the batch will be validated and disbursed. In this case, approve API doesn't need to be called. Default value: true

skip_validation

Boolean

Optional

If this parameter is true then the bank validation will be skipped and items will be disbursed directly. This parameter should only be used if force_disburse is set to true . Default value: false

Request Body Attributes

Following are the parameters to be sent in the request body:

name

String

Optional

The name given for the disbursement batch to be submitted.

description

String

Optional

The description for the disbursement batch.

items

json object

Mandatory

Detail of transactions to be disbursed in a batch, should contain at least 1 transaction

Hide items object

Field	Type	Description
account_owner_nameMandatory	string	The name of the bank account holder.
bank_codeMandatory	string	The bank code of the account.
amountMandatory	string	The amount of money to be disbursed.
account_numberMandatory	string	The account number of the recipient.
email_recipientOptional	string	The email of the recipient.
phone_numberOptional	string	The phone number of the recipient.
notesOptional	string	The notes for the disbursement if any.

Example

curl -u [Base64({Your_Server_Key}:)] \
-X POST https://api.durianpay.id/v1/disbursements/submit \
-H "content-type: application/json" \
-H "idempotency_key: <YOUR_IDEMPOTENCY_KEY>" \
-H "X-Idempotency-Key: <YOUR_X_IDEMPOTENCY_KEY>" \
-d '{
  "name": "sample disbursement",
  "description": "this is a sample disbursement",
  "items": [{
      "account_owner_name": "Jane Doe",
      "bank_code": "bca",
      "amount": "10000",
      "account_number": "8422647",
      "email_recipient": "jane_doe@nomail.com",
      "phone_number": "85722173217",
      "notes": "salary"
  },
  {
      "account_owner_name": "Jack",
      "bank_code": "bca",
      "amount": "10000",
      "account_number": "235464",
      "email_recipient": "jack@nomail.com",
      "phone_number": "85609873209",
      "notes": "salary"
  }]
}'

Response Code

200 - Success

1
2
3
4
5
6
7
8
9
{
    "data": {
        "id": "dis_LjxhDKq8Am3427",
        "name": "test disb",
        "total_amount": "20000.00",
        "total_disbursements": 2,
        "description": "description"
    }
}

200 - Success

400 - Invalid Request

401 - Unauthorized Access

403 - Invalid Request

409 - Invalid Request

500 - Internal Server Error