Settlements

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method	Path	Description
GET	/v1/settlements	List settlements
GET	/v1/settlements/{id}	Retrieve a settlement

GET /v1/settlements

List settlements

The payouts of your collections to your settlement account, with the period covered and the net amount.

ⓘ Served by the read model, from a replica.

Parameters

Name	In	Required	Description
page	query	no
per_page	query	no
status	query	no	Filter on the settlement's status.

Responses

• 200 — OK
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

GET /v1/settlements/{id}

Retrieve a settlement

The settlement and the operations it covers.

Parameters

Name	In	Required	Description
id	path	yes	The settlement's identifier.

Responses

• 200 — OK
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 404 — No settlement with that identifier (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

Schemas

The shapes the operations above return.

Error

Field	Type	Description
error	object
error.code	string
error.message	string