Get Signing Payload for Partner Settlement

get

https://app.bitgo-test.com/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. If your HTTP client doesn't support sending a request body on a get request, use the V1PartnerSettlementsSigningPostRoute

Path Params

enterpriseId

string

required

length ≥ 1

Body Params

externalId

string

required

length ≥ 1

External identifier for the settlement request. This should be unique for each settlement request and is used for idempotence and correlation with partner systems.

notes

string

length ≥ 1

Optional notes about the settlement. Can contain additional context or information about the purpose of the settlement.

settlementAmounts

required

Contains instructions for the settlement. There are two options for the settlementAmounts record:

Connection liabilities
Expresses amounts owed to connections and owed by connections.
Structured as a Record<ConnectionId, Record<Currency, Amount>>.
- Amount is either base units integer string or full units decimal string depending on partners configuration.
- (+ amount for connection gain, - amount for connection loss)
Can be used by broker partners or exchange partners, however for broker partners the amounts for each currency must net to 0 (spread not yet supported).
Connection to connection liabilities
Expresses amounts each connection owes to one another.
Structured as a Record<ConnectionId, Record<ConnectionId, Record<Currency, Amount>>>
- Amount is either base units integer string or full units decimal string depending on partners configuration.
- (+ amount for connection gain, - amount for connection loss) This allows the API to handle both settlement patterns with a single type.

nonce

string

required

length ≥ 1

A unique nonce value used for cryptographic operations. This provides additional security for settlement operations.

cutoffAt

date-time

The date and time of the most recent trade being settled, represented in ISO 8601 format. Optional field used for v2 settlements.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

409Conflict

500Internal Server Error