REST API›Settle (Off Exchange)›Client Allocations & Deallocations

GET

Get Signing Payload for Client Allocations

This API call allows clients to get the client allocations payload for signing. If your HTTP client doesn't support sending a request body on a get request, use the v1ClientAllocationsSigningPostRoute

Requires access token scope: settlement_network_read

Path Params

  • connectionId string required

    The unique identifier of the connection you want to allocate funds to.

    This connection:

    • Must be a valid, established connection between your enterprise and a partner.
    • Determines where the allocated funds will be available for use.
    • Should be pre-established before attempting to allocate funds.
  • enterpriseId string required

    The unique identifier of your enterprise.

    This identifier:

    • Represents your organization within the BitGo system.
    • Is used to validate you have permission to perform this action.
    • Must match the enterprise associated with your API credentials.

    at least 1 characters

Body Params

object

  • amount object required
    The amount to allocate in base units. Contains both the currency identifier and the quantity in the currency's base units. The exact base units depend on the currency (e.g., satoshis for BTC, wei for ETH).
    amount object
    • currency string required
    • quantity string required
  • clientExternalId string required

    A unique external identifier for the allocation.

    This identifier:

    • Must be unique for each distinct allocation request.
    • Is used for idempotence to prevent duplicate allocations.
    • Allows clients to correlate allocations with their own systems.
    • Should be stored by the client for tracking and reconciliation.

    at least 1 characters

  • nonce string required

    Unique nonce to prevent replay attacks.

    This value:

    • Must be unique for each request requiring a nonce.
    • Should be a cryptographically strong random value.
    • Is used as part of the request signing process.
    • Helps ensure the signature can only be used once.

    at least 1 characters

  • notes string

    Optional notes to attach to the allocation.

    These notes:

    • Can provide additional context about the purpose of the allocation.
    • Are stored with the allocation record.
    • May be useful for auditing, record-keeping, or operational purposes.
    • Are visible to both client and partner.

    at least 1 characters

Responses

200
OK

Response Body

object

  • payload string required

    Payload string to sign based on the provided request parameters.

    This string:

    • Contains a JSON representation of the allocation request parameters.
    • Should be signed using the client's private key.
    • The resulting signature should be included in the subsequent allocation creation request.
    • Helps ensure that allocation requests are authenticated and tamper-proof.
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
500
Internal Server Error

Response Body

object

  • error string required