POST
/
disbursements
/
batch
/
transferFunds
cURL
curl -X POST "https://api.onekhusa.com/sandbox/v1/disbursements/batch/transferFunds" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "Accept-Language: en" \
  --header "X-Idempotency-Key: your-idempotency-key" \
  -d '{
    "merchantAccountNumber": 35253486,
    "batchNumber": 1111,
    "transferredBy": "admin@example.com"
  }'
{
  "MerchantAccountNumber": 12345678,
  "BatchNumber": 123456,
  "CurrencyCode": "MWK",
  "BatchStatusCode": "F",
  "ContentType": "CSV",
  "DataSource": "File",
  "NumberOfSuccessfulEntries": 1200,
  "TotalAmountOfSuccessfulEntries": 52000500
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your access token.

Headers

Accept-Language
string
default:en

Preferred language for the response

X-Idempotency-Key
string

A unique key to ensure idempotent requests

Body

application/json
merchantAccountNumber
integer
required

Required string length: 8

Required range: 10000000 <= x <= 99999999
batchNumber
integer
required

The unique identifier of the batch number to start funds transfer

transferredBy
string
required

The email address of the user transferring the funds

Response

200 - application/json

Success Response (200 OK)

MerchantAccountNumber
integer

The unique identifier of the merchant account

Example:

12345678

BatchNumber
integer

The unique identifier of the batch number

Example:

123456

CurrencyCode
string

The currency code of the batch

Example:

"MWK"

BatchStatusCode
string

The status code of the batch

Example:

"F"

ContentType
string

The content type of the batch

Example:

"CSV"

DataSource
string

The data source of the batch

Example:

"File"

NumberOfSuccessfulEntries
integer

The number of successful entries in the batch

Example:

1200

TotalAmountOfSuccessfulEntries
number<double>

The total amount of successful entries in the batch

Example:

52000500