Initiate A Disbursement

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

Transfer to bank accounts

POST/v1/transfers/bank

Body

application/jsontext/jsonapplication/*+json

batch_referencenullable string

source_currencynullable string

scheduled_datenullable string (date-time)

break_on_validation_failureboolean

batch_webhook_typeBatchWebhookType (enum)

This determines how the webhooks are called for batch transfers

batchOnlysingleAndBatchsingleOnly

batch_notification_intervalBatchNotificationInterval (enum)

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

tenPercentfiftyPercenthundredPercent

titlenullable string

descriptionnullable string

transfersnullable array of CreateBankTransferDto (object)

Response

200

Success

Body

application/json

idnullable string

is_liveboolean

batch_referencenullable string

source_currencynullable string

break_on_validation_failureboolean

two_factor_enabledboolean

otp_sentboolean

otp_expires_atnullable string (date-time)

otp_validatedboolean

otp_validated_atnullable string (date-time)

total_countinteger (int32)

failed_countinteger (int32)

successful_countinteger (int32)

total_amountnumber (double)

total_successful_amountnumber (double)

total_feenumber (double)

batch_webhook_typeBatchWebhookType (enum)

This determines how the webhooks are called for batch transfers

batchOnlysingleAndBatchsingleOnly

batch_notification_intervalBatchNotificationInterval (enum)

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

tenPercentfiftyPercenthundredPercent

titlenullable string

descriptionnullable string

statusBatchTransferStatus (enum)

allSuccessfulprocessingqueuedpartialSuccessfulotpotpDispatchFailedallFailed

created_atstring (date-time)

edited_atnullable string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers/bank', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "is_live": false,
  "batch_reference": "text",
  "source_currency": "text",
  "break_on_validation_failure": false,
  "two_factor_enabled": false,
  "otp_sent": false,
  "otp_expires_at": "2024-11-16T16:41:33.951Z",
  "otp_validated": false,
  "otp_validated_at": "2024-11-16T16:41:33.951Z",
  "total_amount": 0,
  "total_successful_amount": 0,
  "total_fee": 0,
  "batch_webhook_type": "batchOnly",
  "batch_notification_interval": "tenPercent",
  "title": "text",
  "description": "text",
  "status": "allSuccessful",
  "created_at": "2024-11-16T16:41:33.951Z",
  "edited_at": "2024-11-16T16:41:33.951Z"
}

Transfer to both banks and gateway merchants

POST/v1/transfers

Body

application/jsontext/jsonapplication/*+json

pinnullable string

batch_referencenullable string

source_currencynullable string

scheduled_datenullable string (date-time)

break_on_validation_failureboolean

batch_webhook_typeBatchWebhookType (enum)

This determines how the webhooks are called for batch transfers

batchOnlysingleAndBatchsingleOnly

batch_notification_intervalBatchNotificationInterval (enum)

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

tenPercentfiftyPercenthundredPercent

titlenullable string

descriptionnullable string

transfersnullable array of CreateBankTransferDto (object)

gateway_transfersnullable array of CreateGatewayTransferDto (object)

Response

200

Success

Body

application/json

idnullable string

is_liveboolean

batch_referencenullable string

source_currencynullable string

break_on_validation_failureboolean

two_factor_enabledboolean

otp_sentboolean

otp_expires_atnullable string (date-time)

otp_validatedboolean

otp_validated_atnullable string (date-time)

bank_transfers_countinteger (int32)

gateway_transfers_countinteger (int32)

total_countinteger (int32)

failed_countinteger (int32)

successful_countinteger (int32)

total_amountnumber (double)

total_successful_amountnumber (double)

total_feenumber (double)

batch_webhook_typeBatchWebhookType (enum)

This determines how the webhooks are called for batch transfers

batchOnlysingleAndBatchsingleOnly

batch_notification_intervalBatchNotificationInterval (enum)

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

tenPercentfiftyPercenthundredPercent

titlenullable string

descriptionnullable string

statusBatchTransferStatus (enum)

allSuccessfulprocessingqueuedpartialSuccessfulotpotpDispatchFailedallFailed

created_atstring (date-time)

edited_atnullable string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "is_live": false,
  "batch_reference": "text",
  "source_currency": "text",
  "break_on_validation_failure": false,
  "two_factor_enabled": false,
  "otp_sent": false,
  "otp_expires_at": "2024-11-16T16:41:33.951Z",
  "otp_validated": false,
  "otp_validated_at": "2024-11-16T16:41:33.951Z",
  "total_amount": 0,
  "total_successful_amount": 0,
  "total_fee": 0,
  "batch_webhook_type": "batchOnly",
  "batch_notification_interval": "tenPercent",
  "title": "text",
  "description": "text",
  "status": "allSuccessful",
  "created_at": "2024-11-16T16:41:33.951Z",
  "edited_at": "2024-11-16T16:41:33.951Z"
}