This API call allows partners to get the partner settlement payload for signing.
The returned payload should be cryptographically signed by the partner and included
in the subsequent settlement creation request.
Path Parameters
enterpriseIdstringRequired
Min length: >= 1 characters
Request Body
externalIdstringrequired
External identifier for the settlement request.
This should be unique for each settlement request and is used for idempotence
and correlation with partner systems.
Min length: >= 1 characters
notesstring
Optional notes about the settlement.
Can contain additional context or information about the purpose of the settlement.
Min length: >= 1 characters
settlementAmountsOne ofrequired
Maps destination connection IDs to currency amounts for settlement.
Record<Party (destination) connectionId, Record<Currency, Amount (bigint)>>
Used for exchange-style settlements, where the exchange is always the source and
client owned connections are the destination. Each entry maps a destination
connection ID to the currency amounts being settled to that connection.
dictionary<string, string>
For mapped settlement amounts where the amount will always be a bigint.
This ensures consistent handling of large monetary values in settlements.
noncestringrequired
A unique nonce value used for cryptographic operations.
This provides additional security for settlement operations.
Min length: >= 1 characters
cutoffAtstring<date-time>
The date and time of the most recent trade being settled, represented
in ISO 8601 format. Optional field used for v2 settlements.