POST
/
disbursements
/
batch
/
addFile
cURL
curl -X POST "https://dev.api.onekhusa.com/sandbox/v1/disbursements/batch/addFile" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "Accept-Language: en" \
  -d '{
        "merchantAccountNumber": 35253486,
        "isBatchScheduled": true,
        "scheduledDate": "2024-01-15",
        "contentType": "XLSX",
        "capturedBy": "johndoe@example.com",
        "fileContent": "UEsDBBQAAAAIAA..."
      }'
{
  "merchantAccountNumber": 35253486,
  "batchNumber": 78688
}

Authorizations

ā€‹
Authorization
string
header
required

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

Headers

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json

Request payload for uploading batch disbursement files

ā€‹
merchantAccountNumber
integer
required

Required string length: 8

Required range: 10000000 <= x <= 99999999
ā€‹
isBatchScheduled
boolean
required

Whether the batch should be scheduled for later processing

ā€‹
contentType
string
required

The content type of the file (e.g., "XLSX", "CSV")

Maximum string length: 4
ā€‹
capturedBy
string<email>
required

Email address of the user uploading the batch file

Maximum string length: 60
Example:

"johndoe@example.com"

ā€‹
fileContent
string
required

Base64-encoded content of the Excel or CSV file

Minimum string length: 1
ā€‹
scheduledDate
string<date> | null

Scheduled date for processing (required if isBatchScheduled is true)

Response

200 - application/json

Success Response (200 OK)

ā€‹
merchantAccountNumber
integer
Example:

35253486

ā€‹
batchNumber
integer
Example:

78688