Ctrl+K

Get Signing Payload for Partner External Deposits

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

This API call allows partners to get the partner external deposits payload for signing. Partners can use this endpoint to retrieve a formatted payload that should be signed using their private key before submitting deposit information. This ensures that deposit submissions are properly authenticated and attributed to the correct partner.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Request Body

externalSettlementId string required
Partner's unique identifier for the settlement. Used for correlation between BitGo and partner systems.
Min length: >= 1 characters
settlementId string
Optional BitGo settlement ID associated with these deposits. May be omitted if the deposits are being submitted before the settlement is created.
deposits array[object] required
List of deposits associated with this settlement. Must contain at least one deposit.
currency string required
The currency code of the deposited asset. Identifies which cryptocurrency was deposited on-chain.
Min length: >= 1 characters
onChainTxId string required
The transaction ID of the on-chain deposit. This is the unique identifier for the blockchain transaction.
Min length: >= 1 characters

200 Response

payload string required
String payload that should be signed with the partner's private key. This signed payload should be included when submitting deposit information.

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

409 Response

error string required

500 Response

error string required