KashierDevelopersKashier Developers
API reference and playgroundBulk batches

Get a batch

curl -X GET "https://test-api.kashier.io/v2/batch/string"
{  "data": {    "_id": "string",    "batchName": "string",    "currency": "string",    "merchantId": "string",    "createdByUserId": "string",    "status": "string",    "itemsCount": 0,    "createdAt": "string",    "updatedAt": "string",    "items": [      {        "_id": "string",        "batchId": "string",        "name": "string",        "amount": 0,        "currency": "string",        "dueDate": "string",        "status": "string",        "createdAt": "string",        "updatedAt": "string"      }    ]  },  "message": "string"}

Retrieves a single batch together with the items it contains, so you can review what was imported before sharing it.

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

Path Parameters

batchId*string

The batch's record id.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

GET
/v2/batch/{batchId}

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…

Delete a batch or empty it DELETE

Deletes a batch, or just its contents. Pass operation=batch to remove the batch itself, or operation=batchitems to empty it and keep the batch so you can re-import a corrected sheet into it.