Skip to main content
GET
Get 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"

id
string
required

Stable resource identifier.

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

Response

Visible entity.

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
obligationId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
track
string
required
settlementKey
string | null
required
amount
string
required
currency
string
required
paidDate
string
required
partnerInvoiceId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
externalReference
string | null
required
notes
string | null
required
createdByUserId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
assertedByActorKind
string | null
required
receiptDocumentId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
createdAt
string
required