Skip to main content
GET
List 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 payments by recipient ID.

batchId
string<uuid>

Filter payments by the batch they were created in.

referenceId
string

Filter payments by your own reference 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.

sourceAccountId
string<uuid>

Filter payments by the exact recorded source account ID. Use an account ID returned by GET /accounts. Payments without a recorded source account are excluded.

Response

A paginated list of payments.

data
object[]
meta
object