List payouts
List the payouts belonging to your client, newest first by default. Supports filtering, search, pagination, and sorting.
This endpoint rejects unknown query parameters — sending a parameter not listed below (e.g. a camelCase typo like ?virtualAccountId) returns 400 instead of silently ignoring it.
The response is an envelope ({ payouts, total, page, limit, total_pages }), not a top-level array.
Authorizations
Access token from POST /auth (the data.access_token value).
API key issued by Kira. Required on every request, including /auth.
Headers
Optional. The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.
"2026-06-01"
Query Parameters
Filter by user UUID.
Filter by client-facing payout status.
CREATED, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, IN_REVIEW, KYT_PENDING Filter by recipient UUID.
Filter by originating virtual account UUID.
Filter by payout origin.
deposit, payout, api Inclusive lower bound on the created timestamp. ISO 8601 date-time or a date-only YYYY-MM-DD string.
Inclusive upper bound on the created timestamp. ISO 8601 date-time or a date-only YYYY-MM-DD string.
Free-text search (max 255 characters).
2551-indexed page number.
x >= 1Page size (1-100).
1 <= x <= 100Field to sort by.
created_at, from_amount, status Sort direction.
asc, desc Stripe-style metadata filter — ?metadata[key]=value deep-object form. Each key must be 1-40 characters and must not contain [ or ]. Multiple keys are AND-ed.