Skip to main content
GET
List external payments

Authorizations

Authorization
string
header
required

Pass your API key as a bearer token: Authorization: Bearer <API_KEY>.

Query Parameters

limit
integer
default:100

Maximum number of results to return (max 100, default 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of results to skip for pagination (default 0).

Required range: x >= 0
recipientId
string<uuid>

Filter external payments by recipient ID.

isReimbursement
boolean

Filter by the exact stored reimbursement classification. Use the literal true for reimbursements or false for non-reimbursements; any other value returns 400. Omit this parameter to return both. The classification affects tax reporting only and does not change payout processing, status, or fees.

Response

A paginated list of external payments.

data
object[]
meta
object