Skip to main content
POST
Initiate settlement

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Body

application/json
idempotency_key
string
required
Required string length: 1 - 255
parties
SettlementPartyInput · object[]
required
Minimum array length: 1
legs
SettlementLegInput · object[]
required
Minimum array length: 1
timeout_at
string<date-time>
required
template_id
string<uuid> | null
template_slug
string | null
Maximum string length: 100
external_reference
string | null
Maximum string length: 255

Response

Successful Response

id
string<uuid>
required
idempotency_key
string
required
platform_id
string<uuid>
required
environment_id
string<uuid>
required
template_id
string<uuid>
required
template_version
integer
required
external_reference
string | null
required
settlement_type
string
required
parties
SettlementPartyRead · object[]
required
legs
SettlementLegRead · object[]
required
state
string
required
timeout_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
trade_type
string | null
linked_settlement_id
string<uuid> | null
coordinator
string | null
coordinator_chain
string | null
triggered_by
Triggered By · object | null
audit_anchor_hash
string | null
repo_terms
RepoTermsRead · object | null