POST
Download Batch Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

Accept-Language
string
default:en

Preferred language for the response

Body

application/json
merchantAccountNumber
integer
required

An active account number for the merchant registered on OneKhusa for verifying webhooks. Required string length: 8

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

The unique number generated for batch disbursements. Required range: x > 0

Response

200 - application/json

Success Response (200 OK)

documentName
string

The name/title of the downloaded document

Example:

"Batch Disbursement Errors"

contentType
string

The type of the file i.e. Microsoft Excel File

Example:

"Microsoft Excel File"

dateCreated
string<date-time>

The date in which the download file was created

Example:

"2026-02-15T10:30:00Z"

documentBase64
string

Base64-encoded content of the downloaded file

Example:

"encoded-base64-content"