KashierDevelopersKashier Developers

Update a batch

curl -X PUT "https://test-api.kashier.io/v2/batch/string" \  -H "Content-Type: application/json" \  -d '{    "batchName": "June invoices — revised"  }'
{  "data": {    "_id": "string",    "batchName": "string",    "currency": "string",    "merchantId": "string",    "createdByUserId": "string",    "status": "string",    "itemsCount": 0,    "createdAt": "string",    "updatedAt": "string"  },  "message": "string"}

Renames an existing batch. The items inside it are left untouched — to change those use updateBatchItem.

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

PUT
/v2/batch/{batchId}