POST
/v1/payments/bulk-disbursementBulk Disbursement
Disburse funds to multiple recipients in a single API call. Recommended to verify recipients before bulk disbursement.
Details
AuthorizationBearer API Key
Content TypeApplication/Json
URLhttps://360pay-merchant-api.libertepay.com/v1/payments/bulk-disbursement
MethodPOST
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| disbursements | array | Yes | Array of disbursement items |
| disbursements[].account_name | string | Yes | Recipient name (from Name Verify) |
| disbursements[].account_number | string | Yes | Recipient account number |
| disbursements[].amount | float | Yes | Amount to disburse (two decimal places) |
| disbursements[].institution_code | string | Yes | Issuer routing code |
| disbursements[].transaction_id | string | Yes | Consumer transaction ID for the item |
| disbursements[].currency | string | Yes | Currency (default: GHS) |
| disbursements[].reference | string | No | Transaction reference |
| disbursements[].meta_data | object | No | Additional metadata |
Parameters Description
| Parameter | Description | isMandatory | Comment |
|---|---|---|---|
| bulk_transaction_id | Consumer transaction Id for the batch | Yes | |
| account_number | Mobile Money or Bank Account number to receive the disbursement | Yes | Must be 12 digits for a mobile money account. EG: 233XXXXXXXXX |
| account_name | Full name of the recipient of disbursement | Yes | Value is retrieved from NameEnquiry API |
| amount | Amount to be disbursed | Yes | In two decimal places |
| institution_code | Issuer routing code | Yes | |
| status | Request Status code | ||
| transaction_id | SpecificTransaction_id |
Status Codes
200Success
202Request is being processed
401Unauthorized
406Request not accepted
500System error
Try It
Request Body
json
{
"disbursements": [
{
"account_name": "string",
"account_number": "string",
"amount": float,
"institution_code": "string",
"transaction_id": "string",
"currency": "string",
"reference": "string",
"meta_data": {
"string": "string"
}
},
{
"account_name": "string",
"account_number": "string",
"amount": float,
"institution_code": "string",
"transaction_id": "string",
"currency": "string",
"reference": "string",
"meta_data": {
"string": "string"
}
}
]
}Response Body
{
"code": "string",
"data": {
"bulk_transaction_id": "string",
"results": [
{
"message": "string",
"status": "string",
"transaction_id": "string"
},
{
"message": "string",
"status": "string",
"transaction_id": "string"
}
]
}
}