POST
/
disbursements
/
batch
/
getBatches
cURL
curl -X 'POST' \
  'https://api.onekhusa.com/sandbox/v1/disbursements/batch/getBatches' \
  --header 'accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer your-jwt-token' \
  --header 'X-Organisation-Id: FYH0NTVW0DXK' \
  --header 'X-Merchant-Account-Number: 35253486' \
  --header 'Accept-Language: en' \
  -d '{
  "merchantAccountNumber": 12345678,
  "batchDate": "2025-09-26T08:43:21.699084",
  "pageNumber": 1,
  "numberOfReturnedRows": 20,
  "isIncremental": true,
  "searchBy": "CapturedBy": 
  "searchText": "j1LgGY"
}'
[
  {
    "batchNumber": 2024001,
    "capturedBy": "johndoe@example.com",
    "dateCaptured": "2024-01-15",
    "batchStatusCode": "A",
    "batchStatusDescription": "Approved",
    "processDate": "2024-01-15",
    "isBatchScheduled": false,
    "numberOfTransactions": 100
  }
]

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
ā€‹
batchDate
string<date>
required

Date filter for batch creation date (YYYY-MM-DD)

ā€‹
pageNumber
integer
required

Page number for pagination (starts from 1)

ā€‹
numberOfReturnedRows
integer
required

Number of records per page

ā€‹
isIncremental
boolean
required

If true, includes previous pages; if false, only current page

ā€‹
searchBy
enum<string>
required

Field to search by. Supported fields: CapturedBy, ReviewedBy, ApprovedBy, BatchStatus, BatchStatusDescription

Available options:
CapturedBy,
ReviewedBy,
ApprovedBy,
BatchStatus,
BatchStatusDescription
ā€‹
searchText
string

Text to search for

Response

Success Response (200)

ā€‹
headerId
integer

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

Required range: x > 0

ā€‹
batchNumber
integer

A unique integer identifier for the disbursement batch.

ā€‹
capturedBy
string<email>

Email address of the user who created the batch.

Example:

"johndoe@example.com"

ā€‹
dateCaptured
string<date>

Date when the batch was created and submitted.

ā€‹
batchStatusCode
string

Single-character code for batch status. Values: "A" - Approved, "P" - Pending, "E" - Error, "F" - Failed, "N" - Cancelled, "X" - Rejected, "C" - Completed.

ā€‹
batchStatusDescription
string

Human-readable description of the batch status. Examples: "Approved", "Processed", "Pending Review".

ā€‹
processDate
string<date>

Date when the batch was processed for disbursement.

ā€‹
isBatchScheduled
boolean

Boolean flag indicating if the batch is scheduled for future processing.

ā€‹
numberOfTransactions
integer

Number of transactions in the batch