KashierDevelopersKashier Developers
API reference and playgroundBalance and accounts

List holds on a balance account

curl -X GET "https://test-api.kashier.io/v2/hold/account/string"
{  "data": [    {      "id": "string",      "accountId": "string",      "amount": 0,      "currency": "string",      "status": "string",      "createdAt": "string"    }  ],  "total": 0,  "page": 0,  "limit": 0}

Lists the holds placed on a balance account. A hold reserves part of the balance so it cannot be paid out yet — it explains a gap between an account's total balance and its available balance.

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

accountId*string

Balance account identifier.

Query Parameters

page?integer

Page number.

limit?integer

Number of records per page.

status?string

Filter by hold status.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/hold/account/{accountId}