Initiate on-chain settlement

post/api/network/v1/enterprises/{enterpriseId}/partners/settlements/onchain

Partner route to initiate an on-chain settlement.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Request Body

externalId string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
settlementAmounts object required
Record<Party (destination) connectionId, Record<Currency, Amount (bigint)>> For exchange-style settlements, where the exchange is always the source and client owned connections are the destination.
nonce string required
Min length: >= 1 characters
payload string required
Min length: >= 1 characters
signature string required
Min length: >= 1 characters

200 Response

settlementOne ofrequired
id string required
partnerId string required
externalId string required
Min length: >= 1 characters
status string required
Allowed value: pending
settlementType string required
Allowed values: onchain offchain
reconciled boolean required
initiatedBy string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required

202 Response

settlement object required
id string required
partnerId string required
externalId string required
Min length: >= 1 characters
status string required
Allowed value: pending
settlementType string required
Allowed values: onchain offchain
reconciled boolean required
initiatedBy string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required

400 Response

401 Response

error string required

403 Response

error string required

409 Response

error string required

500 Response

error string required