Skip to main content
GET
Settlement summary

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Query Parameters

periodStart
string<date-time>

ISO-8601 inclusive window start. Defaults to the tenant's createdAt.

periodEnd
string<date-time>

ISO-8601 exclusive window end. Defaults to now.

currency
string
default:GBP

3-letter ISO 4217 code for the settlement output. Defaults to GBP.

Pattern: ^[A-Z]{3}$

Response

The settlement summary.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"