POST
/
disbursements
/
batch
/
download
cURL
curl -X POST "https://api.onekhusa.com/sandbox/v1/disbursements/batch/download" \
      --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,
        "headerId": 12345,
        "downloadType": "XLSX"
      }'
"fileContentBase64:. UEsDBBQAAAAIAA... "

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
ā€‹
headerId
integer
required

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

Required range: x > 0

ā€‹
downloadType
enum<string>
required

The file format for the download. Supported values: "XLSX" or "CSV"

Available options:
XLSX,
CSV

Response

200 - application/json

Success Response (200 OK)

The response is of type string.

Example:

"fileContentBase64:. UEsDBBQAAAAIAA... "