Initiate A Disbursement

Initiate a disbursement containing the list of bank and inter-merchant transfers.

Transfer to bank accounts

Transfer to both banks and gateway merchants

PreviousBatch Disbursements NextList Batch Transfers

Last updated 3 months ago

post

/v1/transfers/bank

Authorizations

Body

batch_referencestring | nullable

source_currencystring | nullable

scheduled_datestring · date-time | nullable

break_on_validation_failureboolean

batch_webhook_typestring · enum

This determines how the webhooks are called for batch transfers

Options: batchOnly, singleAndBatch, singleOnly

batch_notification_intervalstring · enum

This determines the sequence of updates for batch transfers if batch webhooks are enabled

Options: tenPercent, fiftyPercent, hundredPercent

titlestring | nullable

descriptionstring | nullable

transfersobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/transfers/bank' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"batch_webhook_type":"batchOnly","batch_notification_interval":"tenPercent","transfers":[{"wallet_account_tags":[{"metadata":{"ANY_ADDITIONAL_PROPERTY":"[Circular Reference]"}}]}]}'

200

{
  "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-02-20T19:27:56.784Z",
  "otp_validated": true,
  "otp_validated_at": "2025-02-20T19:27:56.784Z",
  "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-02-20T19:27:56.784Z",
  "edited_at": "2025-02-20T19:27:56.784Z"
}

Success