Ctrl+K

Post deposit info for an on-chain settlement

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

Partner route for providing external deposit information tied to an on-chain settlement. This endpoint allows partners to submit information about on-chain deposits that are associated with a specific settlement. The deposits will be tracked and reconciled with the settlement transaction.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or incomplete.

  • Examples: Empty string supplied for enterpriseId.

  • 401: Authentication Error

  • Occurs when the request is not authorized.

  • Examples: Caller is not a member of the enterprise.

  • 403: Permission Denied Error

  • Occurs when the authenticated partner doesn't have access to the specified settlement.

  • Examples: Enterprise does not have OES license.

  • 404: Not Found Error

  • Occurs when the referenced settlement was not found.

  • Examples: Settlement ID doesn't exist, settlement exists but for different partner.

  • 409: Conflict Error

  • Occurs when Deposit information is in conflict.

  • Examples: Depsit information has already been submitted for a different settlement.

  • 500: Internal Server Error

  • Occurs when there's an unexpected error processing the request

  • Examples: Database connection failure, transient network error.

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
payload string required
Min length: >= 1 characters
signature string required
Min length: >= 1 characters

201 Response

deposits array[object] required
Array of deposit records that were created or retrieved.
onChainTxId string required
Min length: >= 1 characters
transferId string
currency string required
The currency code of the deposited asset.
Min length: >= 1 characters
quantity number
id string required
settlementId string required
createdAt string <date-time>required
ISO-formatted creation timestamp of the deposit record.
updatedAt string <date-time>required
ISO-formatted timestamp of the last update to the deposit record.
externalSettlementId string required
Partner's unique identifier for the settlement associated with this deposit.
Min length: >= 1 characters

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