Bulk batches

List batches

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

get/v2/batch

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/batch
  • Auth: API key in header Authorization

Query parameters

currency'EGP' | 'USD' | 'EUR' | 'GBP' required

Currency the batches were created in. Example: EGP

qstring

Free-text search across batch names.

pageinteger

Current page number. Defaults to 1.

limitinteger

Number of records per page. Defaults to 20.

sortBy'name' | 'batchId' | 'createdAt' | 'totalAmount' | 'status'

Field to sort by.

sortType1 | -1

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

branchIdsstring

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

Response

The batches matching the filters.

totalinteger
pageinteger
limitinteger

Changes

No recorded changes to this operation across all 1 revision of this API.