KashierDevelopersKashier Developers
API reference and playgroundBalance and accounts

Get payout details for a balance record

curl -X GET "https://test-api.kashier.io/v2/balance/payout-details/string"
{  "recordId": "string",  "accountId": "string",  "amount": 0,  "status": "string",  "payoutDate": "string",  "totalTransactions": 0,  "transactions": [    {}  ]}

Expands a payout balance record into the individual transactions it paid out. Use it to answer "which sales made up this payout?" — the record gives you the total that left the account, and this read gives you the lines behind it, with pagination and date filters.

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

recordId*string

Balance record identifier.

Query Parameters

page?integer

Page number.

limit?integer

Number of records per page.

sortBy?string

Field to sort by.

sortOrder?string

Sorting direction: asc or desc.

Value in

  • "asc"
  • "desc"
status?string

Filter by status.

dateFrom?string

Start of the date range (ISO 8601).

Formatdate-time
dateTo?string

End of the date range (ISO 8601).

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/balance/payout-details/{recordId}

Get balance record details GET

Retrieves one balance record in full — the amount, whether it credited or debited the account, the value date the money counted from, and the origin/originReference pointing back at whatever produc…

Export payout details for a balance record GET

Exports the transactions behind a payout balance record as a spreadsheet, applying the same status and date filters as the payout details read.