POST
/
disbursements
/
batch
/
reject
Reject Batch
curl --request POST \
  --url https://api.onekhusa.com/sandbox/v1/disbursements/batch/reject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Account-Number: <x-merchant-account-number>' \
  --header 'X-Organisation-Id: <x-organisation-id>' \
  --data '{
  "merchantAccountNumber": 35253486,
  "batchNumber": 11111111,
  "reasonForRejection": "Invalid beneficiary information",
  "rejectedBy": "admin@example.com"
}'
"Batch number 11111111 has been rejected 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
ā€‹
reasonForRejection
string
required

Reason for rejecting the batch

ā€‹
rejectedBy
string
required

The email address of the user rejecting the batch

ā€‹
headerId
integer

A unique integer identifier that represents a batch of disbursement transactions in the system.

Required range: x > 0

Response

200 - application/json

Success Response (200 OK)

The response is of type string.

Example:

"Batch number 11111111 has been rejected successfully"