Skip to main content
GET
List remittances

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

businessId
string

Filter by business

countryCode
string

Filter by jurisdiction (ISO 3166-1 alpha-2)

status
enum<string>

Filter by remittance status

Available options:
pending,
processing,
completed,
failed

Response

200 - application/json

List of remittances with summary

data
object[]
summary
object

Status counts for the filtered set of remittances.