Skip to main content
GET
List Payment Settlements

Authorizations

Authorization
string
header
required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand
string
required

Brand slug authorized by this API key.

Example:

"acme"

Query Parameters

cursor
string

Opaque nextCursor from the same collection and filters. Omit on the first request.

limit
integer
default:25
Required range: 1 <= x <= 100
settlementKey
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
externalReference
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
receiptDocumentId
string

Exact related entity ID.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
track
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
currency
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
obligationId
string
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
partnerInvoiceId
string
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

One page. totalItems counts the full filtered set; nextCursor null means exhausted.

items
object[]
required
nextCursor
string | null
required
totalItems
integer
required
Required range: 0 <= x <= 9007199254740991