Skip to main content
GET
Get payout and deposit receipt download links

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Query Parameters

ledgerIds
string

Comma-separated wallet ledger entry ids (max 50).

recipientId
string

Only receipts for this creator (user id).

kind
enum<string>

payouts, deposits, or all (default).

Available options:
payouts,
deposits,
all
limit
integer

How many receipts, newest first (default 50, max 50).

Required range: 1 <= x <= 50
includeSubaccounts
string

Agency parents only, "true" to include subaccount wallets.

parentAgencyId
string

Required when includeSubaccounts is true.

Response

The receipts and their download links.

data
object[]
required
total
integer
required
truncated
boolean
required
archiveUrl
string | null
archiveFileName
string | null