Ctrl+K

Get Signing Payload for Client Allocations

get/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/allocations/signing

This API call allows clients to get the client allocations payload for signing.

Path Parameters

  • connectionIdstringRequired
    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.
  • enterpriseIdstringRequired
    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.
    Min length: >= 1 characters

Request Body

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).
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.
Min length: >= 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.
Min length: >= 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.
Min length: >= 1 characters

200 Response

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 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required