PUT
/
disbursements
/
batch
/
review
cURL
curl -X PUT "https://api.onekhusa.com/sandbox/v1/disbursements/batch/review" \
  --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": 678,
    "actionedBy": "admin@example.com"
  }'
{
  "MerchantAccountNumber": 12345678,
  "BatchNumber": 123456,
  "CurrencyCode": "MWK",
  "BatchStatusCode": "R",
  "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

The unique identifier of the merchant account (Required string length: 8)

Required range: 10000000 <= x <= 99999999
Example:

35253486

ā€‹
batchNumber
integer
required

The unique identifier of the batch header to review

Required range: x >= 1
Example:

678

ā€‹
actionedBy
string
required

The email address of the user reviewing the batch

Maximum string length: 60
Example:

"admin@example.com"

Response

200 - application/json

Success Response (200 OK) - Batch reviewed successfully

ā€‹
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:

"R"

ā€‹
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