KashierDevelopersKashier Developers
API reference and playgroundBulk batches

List batches

curl -X GET "https://test-api.kashier.io/v2/batch?currency=EGP"
{  "data": [    {      "_id": "string",      "batchName": "string",      "currency": "string",      "merchantId": "string",      "createdByUserId": "string",      "status": "string",      "itemsCount": 0,      "createdAt": "string",      "updatedAt": "string"    }  ],  "total": 0,  "page": 0,  "limit": 0}

Retrieves the merchant's batches, paginated. currency is required, so a batch list is always scoped to one currency; every other filter is optional.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Query Parameters

currency*string

Currency the batches were created in. Example: EGP

Value in

  • "EGP"
  • "USD"
  • "EUR"
  • "GBP"
q?string

Free-text search across batch names.

page?integer

Current page number. Defaults to 1.

limit?integer

Number of records per page. Defaults to 20.

sortBy?string

Field to sort by.

Value in

  • "name"
  • "batchId"
  • "createdAt"
  • "totalAmount"
  • "status"
sortType?integer

Sorting direction: 1 = ascending, -1 = descending.

Value in

  • 1
  • -1
branchIds?string

Comma-separated branch ids — only return batches created by these branches.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/batch

Export settlement batch transactions GET

Exports the transactions inside settlement batches as a spreadsheet, one row per transaction with its selling fees, VAT, settlement amount, ready-for-settlement date, method, and channel. This is t…

Create a batch POST

Creates an empty batch. batchType decides which import sheet the batch expects — withCustomer when each row carries the customer's details so Kashier can create or match a customer record, withoutC…