Initiate A Disbursement

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

Transfer to bank accounts

post

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Body

application/jsontext/jsonapplication/*+json

batch_referencestring · nullableOptional

source_currencystring · nullableOptional

scheduled_datestring · date-time · nullableOptional

break_on_validation_failurebooleanOptional

batch_webhook_typestring · enumOptional

This determines how the webhooks are called for batch transfers

Possible values:

batch_notification_intervalstring · enumOptional

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

Possible values:

titlestring · nullableOptional

descriptionstring · nullableOptional

Responses

200

Success

application/json

NOTE: This Dto contains the properties of all transfer types: bank, gateway, etc; It is used for AutoMapper projection to retrieve all tx types in a single DB IO. Individual types can then be recast to correct types for manipulation and presentation.

idstring · nullableOptional

is_livebooleanOptional

batch_referencestring · nullableOptional

source_currencystring · nullableOptional

break_on_validation_failurebooleanOptional

two_factor_enabledbooleanOptional

otp_sentbooleanOptional

otp_expires_atstring · date-time · nullableOptional

otp_validatedbooleanOptional

otp_validated_atstring · date-time · nullableOptional

total_countinteger · int32Optional

failed_countinteger · int32Optional

successful_countinteger · int32Read-onlyOptional

total_amountnumber · doubleOptional

total_successful_amountnumber · doubleOptional

total_feenumber · doubleOptional

batch_webhook_typestring · enumOptional

This determines how the webhooks are called for batch transfers

Possible values:

batch_notification_intervalstring · enumOptional

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

Possible values:

titlestring · nullableOptional

descriptionstring · nullableOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

edited_atstring · date-time · nullableOptional

post

/v1/transfers/bank

HTTPcURLJavaScriptPython

POST /v1/transfers/bank HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 579

{
  "batch_reference": "text",
  "source_currency": "text",
  "scheduled_date": "2026-02-20T01:01:18.777Z",
  "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"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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": "2026-02-20T01:01:18.777Z",
  "otp_validated": true,
  "otp_validated_at": "2026-02-20T01:01:18.777Z",
  "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": "2026-02-20T01:01:18.777Z",
  "edited_at": "2026-02-20T01:01:18.777Z"
}

Transfer to both banks and gateway merchants

post

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Body

application/jsontext/jsonapplication/*+json

pinstring · nullableOptional

batch_referencestring · nullableOptional

source_currencystring · nullableOptional

scheduled_datestring · date-time · nullableOptional

break_on_validation_failurebooleanOptional

batch_webhook_typestring · enumOptional

This determines how the webhooks are called for batch transfers

Possible values:

batch_notification_intervalstring · enumOptional

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

Possible values:

titlestring · nullableOptional

descriptionstring · nullableOptional

Responses

200

Success

application/json

NOTE: This object contains the combined details for all transfer types: bank & gateway The total count includes the count for both bank disbursements and inter-merchant disbursements

idstring · nullableOptional

is_livebooleanOptional

batch_referencestring · nullableOptional

source_currencystring · nullableOptional

break_on_validation_failurebooleanOptional

two_factor_enabledbooleanOptional

otp_sentbooleanOptional

otp_expires_atstring · date-time · nullableOptional

otp_validatedbooleanOptional

otp_validated_atstring · date-time · nullableOptional

bank_transfers_countinteger · int32Optional

gateway_transfers_countinteger · int32Optional

total_countinteger · int32Optional

failed_countinteger · int32Optional

successful_countinteger · int32Optional

total_amountnumber · doubleOptional

total_successful_amountnumber · doubleOptional

total_feenumber · doubleOptional

batch_webhook_typestring · enumOptional

This determines how the webhooks are called for batch transfers

Possible values:

batch_notification_intervalstring · enumOptional

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

Possible values:

titlestring · nullableOptional

descriptionstring · nullableOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

edited_atstring · date-time · nullableOptional

post

/v1/transfers

HTTPcURLJavaScriptPython

POST /v1/transfers HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1151

{
  "pin": "text",
  "batch_reference": "text",
  "source_currency": "text",
  "scheduled_date": "2026-02-20T01:01:18.777Z",
  "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"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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": "2026-02-20T01:01:18.777Z",
  "otp_validated": true,
  "otp_validated_at": "2026-02-20T01:01:18.777Z",
  "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": "2026-02-20T01:01:18.777Z",
  "edited_at": "2026-02-20T01:01:18.777Z"
}