Skip to main content
GET
Retrieve a remittance

Authorizations

Authorization
string
header
required

A sandbox or production secret key.

Path Parameters

remittance_id
string
required

A public remittance identifier.

Maximum string length: 100
Pattern: ^rem_[A-Za-z0-9_-]+$

Response

A remittance

id
string
required
Pattern: ^rem_[A-Za-z0-9_-]+$
object
string
required
Allowed value: "remittance"
status
enum<string>
required
Available options:
received,
reconciled,
exception
payer_reference
string
required
amount
object
required
allocations
object[]
required
received_at
string<date-time>
required
reconciled_at
string<date-time> | null
required
Last modified on July 30, 2026