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.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Request Body

externalId string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
settlementAmountsOne ofrequired
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.
dictionary<string, string>
For mapped settlement amounts where the amount will always be a bigint
nonce string required
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