Ctrl+K

Get Signing Payload for Partner Settlement

get/api/network/v1/enterprises/{enterpriseId}/partners/settlements-signing

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

externalId string required
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
notes string
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.
nonce string required
A unique nonce value used for cryptographic operations. This provides additional security for settlement operations.
Min length: >= 1 characters

200 Response

payload string required

400 Response

401 Response

error string required

403 Response

error string required

409 Response

error string required

500 Response

error string required