Submit Disbursement

The following endpoint submit a disbursement:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

This API will be deprecated in Q2 2025

Query Params
boolean

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

Body Params
string
Defaults to sample disbursement

The name given for the disbursement batch to be submitted.

string
Defaults to this is a sample disbursement

The description for the disbursement batch.

items
array of objects
required

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

items*
Headers
string
required
Defaults to <YOUR_IDEMPOTENCY_KEY>

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

string
required
Defaults to <YOUR_X_IDEMPOTENCY_KEY>

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain