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.

Response

A paginated list of payments.

data
object[]
meta
object