Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Partner Settlements & Transfers

Get Signing Payload for Partner Settlement

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

Requires access token scope: settlement_network_read

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

Path parameters

enterpriseIdstring required

Request body

externalIdstring 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.

notesstring

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

noncestring required

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

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.

Response

OK

payloadstring required