REST API›Settle (Off Exchange)›Partner Settlements & Transfers

POST

Post deposit info for an on-chain settlement

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, partner is inactive.

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

Requires access token scopes: settlement_network_read, settlement_network_write

Path Params

  • enterpriseId string required

    at least 1 characters

Body Params

object

  • externalSettlementId string required
    Partner's unique identifier for the settlement. Used for correlation between BitGo and partner systems.

    at least 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 of objects required
    deposits object
    • currency string required
      The currency code of the deposited asset. Identifies which cryptocurrency was deposited on-chain.

      at least 1 characters

    • onChainTxId string required
      The transaction ID of the on-chain deposit. This is the unique identifier for the blockchain transaction.

      at least 1 characters

  • payload string required

    at least 1 characters

  • signature string required

    at least 1 characters

Responses

201
Created

Response Body

object

  • deposits array of objects required
    Array of deposit records that were created or retrieved.
    deposits object
    • onChainTxId string required

      at least 1 characters

    • transferId string
    • currency string required
      The currency code of the deposited asset.

      at least 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.

      at least 1 characters

400
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
403
Forbidden

Response Body

object

  • error string required
404
Not Found

Response Body

object

  • error string required
409
Conflict

Response Body

object

  • error string required
500
Internal Server Error

Response Body

object

  • error string required