Initiate A Disbursement
Initiate a disbursement containing the list of bank and inter-merchant transfers.
Transfer to bank accounts
post
Authorizations
Body
batch_referencestring | nullableOptional
source_currencystring | nullableOptional
scheduled_datestring · date-time | nullableOptional
break_on_validation_failurebooleanOptional
batch_webhook_typestring · enumOptionalPossible values:
This determines how the webhooks are called for batch transfers
batch_notification_intervalstring · enumOptionalPossible values:
This determines the sequence of updates for batch transfers if batch webhooks are enabled
titlestring | nullableOptional
descriptionstring | nullableOptional
Responses
200
Success
application/json
post
POST /v1/transfers/bank HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 579
{
"batch_reference": "text",
"source_currency": "text",
"scheduled_date": "2025-07-05T14:52:49.313Z",
"break_on_validation_failure": true,
"batch_webhook_type": "batchOnly",
"batch_notification_interval": "tenPercent",
"title": "text",
"description": "text",
"transfers": [
{
"reference": "text",
"description": "text",
"beneficiary_id": "text",
"save_as_beneficiary": true,
"currency": "text",
"amount": 1,
"wallet_account_tags": [
{
"account_tag": "text",
"amount": 1,
"description": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
}
}
],
"country": "text",
"account_number": "text",
"bank_code": "text"
}
]
}
200
Success
{
"id": "text",
"is_live": true,
"batch_reference": "text",
"source_currency": "text",
"break_on_validation_failure": true,
"two_factor_enabled": true,
"otp_sent": true,
"otp_expires_at": "2025-07-05T14:52:49.313Z",
"otp_validated": true,
"otp_validated_at": "2025-07-05T14:52:49.313Z",
"total_count": 1,
"failed_count": 1,
"successful_count": 1,
"total_amount": 1,
"total_successful_amount": 1,
"total_fee": 1,
"batch_webhook_type": "batchOnly",
"batch_notification_interval": "tenPercent",
"title": "text",
"description": "text",
"status": "allSuccessful",
"created_at": "2025-07-05T14:52:49.313Z",
"edited_at": "2025-07-05T14:52:49.313Z"
}
Transfer to both banks and gateway merchants
post
Authorizations
Body
pinstring | nullableOptional
batch_referencestring | nullableOptional
source_currencystring | nullableOptional
scheduled_datestring · date-time | nullableOptional
break_on_validation_failurebooleanOptional
batch_webhook_typestring · enumOptionalPossible values:
This determines how the webhooks are called for batch transfers
batch_notification_intervalstring · enumOptionalPossible values:
This determines the sequence of updates for batch transfers if batch webhooks are enabled
titlestring | nullableOptional
descriptionstring | nullableOptional
Responses
200
Success
application/json
post
POST /v1/transfers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1151
{
"pin": "text",
"batch_reference": "text",
"source_currency": "text",
"scheduled_date": "2025-07-05T14:52:49.313Z",
"break_on_validation_failure": true,
"batch_webhook_type": "batchOnly",
"batch_notification_interval": "tenPercent",
"title": "text",
"description": "text",
"transfers": [
{
"reference": "text",
"description": "text",
"beneficiary_id": "text",
"save_as_beneficiary": true,
"country": "text",
"currency": "text",
"amount": 1,
"wallet_account_tags": [
{
"account_tag": "text",
"amount": 1,
"description": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
}
}
],
"account_number": "text",
"account_name": "text",
"bank_name": "text",
"bank_code": "text",
"sort_code": "text",
"swift_code": "text",
"email": "text",
"phone_number": "text",
"street_number": "text",
"street_name": "text",
"city": "text",
"postal_code": "text"
}
],
"gateway_transfers": [
{
"reference": "text",
"description": "text",
"beneficiary_id": "text",
"save_as_beneficiary": true,
"country": "text",
"currency": "text",
"amount": 1,
"wallet_account_tags": [
{
"account_tag": "text",
"amount": 1,
"description": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
}
}
],
"merchant_id_or_code": "text",
"recipient_gateway_code": "text"
}
]
}
200
Success
{
"id": "text",
"is_live": true,
"batch_reference": "text",
"source_currency": "text",
"break_on_validation_failure": true,
"two_factor_enabled": true,
"otp_sent": true,
"otp_expires_at": "2025-07-05T14:52:49.313Z",
"otp_validated": true,
"otp_validated_at": "2025-07-05T14:52:49.313Z",
"bank_transfers_count": 1,
"gateway_transfers_count": 1,
"total_count": 1,
"failed_count": 1,
"successful_count": 1,
"total_amount": 1,
"total_successful_amount": 1,
"total_fee": 1,
"batch_webhook_type": "batchOnly",
"batch_notification_interval": "tenPercent",
"title": "text",
"description": "text",
"status": "allSuccessful",
"created_at": "2025-07-05T14:52:49.313Z",
"edited_at": "2025-07-05T14:52:49.313Z"
}
Last updated