POST
/
disbursements
/
batch
/
cancel
cURL
curl -X POST "https://api.onekhusa.com/sandbox/v1/disbursements/batch/cancel" \
     --header "Authorization: Bearer your-jwt-token" \
     --header "Content-Type: application/json" \
     --header "X-Organisation-Id: FYH0NTVW0DXK" \
     --header "X-Merchant-Account-Number: 35253486" \
     --header "Accept-Language: en" \
     -d '{
       "merchantAccountNumber": 35253486,
       "batchNumber": 12345,
       "cancelledBy": "admin@example.com"
     }'
"Batch number 12345 has been cancelled successfully"

Authorizations

ā€‹
Authorization
string
header
required

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

Headers

ā€‹
X-Organisation-Id
string
required

The organization identifier

ā€‹
X-Merchant-Account-Number
string
required

The merchant account number

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json
ā€‹
merchantAccountNumber
integer
required

Required string length: 8

Required range: 10000000 <= x <= 99999999
ā€‹
cancelledBy
string
required

Email address of the user who cancels the batch.

Maximum length: 60
ā€‹
batchNumber
integer

A The unique identifier of the batch header to cancel

Required range: x > 0

Response

200 - application/json

Success Response (200 OK)

The response is of type string.

Example:

"Batch number 12345 has been cancelled successfully"