Skip to main content
GET
List delivery-ready Payments

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Query Parameters

accountingAcceptance
enum<string>

Only Payments in this accounting acceptance state are returned.

Available options:
pending,
partially_acknowledged,
acknowledged,
held
after
string

The nextAfter value of a previous page. Omit it to read from the start.

Pattern: ^[A-Za-z0-9_-]{1,128}$
limit
integer

Maximum Payments to return, from 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100

Response

A page of delivery-ready Payments.

data
object[]
required
hasMore
boolean
required
nextAfter
string | null
required

Pass as after to read the next page. Null on the last page.

Pattern: ^[A-Za-z0-9_-]{1,128}$