Skip to main content
GET
List payouts
Stable since 2025-01-01 — unchanged in 2026-04-14.

Authorizations

Authorization
string
header
required

Access token from POST /auth (the data.access_token value).

x-api-key
string
header
required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version
string

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.

Example:

"2026-04-14"

Query Parameters

user_id
string<uuid>

Filter by user UUID.

status
enum<string>

Filter by client-facing payout status.

Available options:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED,
IN_REVIEW,
KYT_PENDING
recipient_id
string<uuid>

Filter by recipient UUID.

virtual_account_id
string<uuid>

Filter by originating virtual account UUID.

origin
enum<string>

Filter by payout origin.

Available options:
deposit,
payout,
api
from_date
string

Inclusive lower bound on the created timestamp. ISO 8601 date-time or a date-only YYYY-MM-DD string.

to_date
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).

Maximum string length: 255
page
integer
default:1

1-indexed page number.

Required range: x >= 1
limit
integer
default:10

Page size (1-100).

Required range: 1 <= x <= 100
sort_by
enum<string>
default:created_at

Field to sort by.

Available options:
created_at,
from_amount,
status
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
metadata
object

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.

Response

Success.

Paginated list envelope (not a top-level array).

payouts
object[]
required
total
integer

Total payouts matching the filters.

page
integer
limit
integer
total_pages
integer