KashierDevelopersKashier Developers

Get payout batch details

curl -X GET "https://test-api.kashier.io/v2/transfers/batch/string"
{  "message": "success",  "data": {    "batchId": "BTH-1007931100",    "merchantBatchId": "batch12349",    "batchName": "Monthly payroll",    "totalCount": 150,    "successCount": 148,    "failureCount": 2,    "status": "COMPLETED",    "createdAt": "2026-06-18 10:30:00+00:00",    "updatedAt": "2026-06-18 11:45:00+00:00",    "transfers": [      {        "transferId": "TRS-1007931100",        "status": "TRANSFERRED",        "amount": 100      }    ]  },  "pagination": {    "total": 150,    "limit": 20,    "page": 1,    "pages": 8  }}

Retrieves one payout batch together with the transfers it contains, paginated. Use it to find which rows of a bulk payout failed and why.

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 id (e.g., BTH-1007931100).

Query Parameters

limit?integer

Number of transfers per page.

page?integer

Page number.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/transfers/batch/{batchId}