API References

Get Signing Payload for Client Allocations (Post variant)

post
https://app.bitgo-test.com/api/network/v1/enterprises//clients/connections//allocations/signing

This API call allows clients to get the client allocations payload for signing. This endpoint is effectively the same as the GET endpoint, but is helpful if your HTTP client doesn't support sending a request body on a get request.

Requires access token scopes: settlement_network_read, settlement_network_write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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.
string
required
length ≥ 1

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.
Body Params
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).

string
required
length ≥ 1

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.
string
required
length ≥ 1

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.
string
length ≥ 1

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

Updated 17 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago