Balance and accounts
Get payout details for a balance record
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.
get/v2/balance/payout-details/{recordId}
Request
- Base URL: https://test-api.kashier.io
- URL: https://test-api.kashier.io/v2/balance/payout-details/{recordId}
- Auth: API key in header Authorization
Path parameters
recordIdstring required
Balance record identifier.
Query parameters
pageinteger
Page number.
limitinteger
Number of records per page.
sortBystring
Field to sort by.
sortOrder'asc' | 'desc'
Sorting direction: asc or desc.
statusstring
Filter by status.
dateFromstring date-time
Start of the date range (ISO 8601).
dateTostring date-time
End of the date range (ISO 8601).
Response
The payout record and the transactions it covers.
Changes
No recorded changes to this operation across all 1 revision of this API.