Overview

Allocate assets in your Go Network account to a connected-partner platform. BitGo locks allocated assets and makes them available for trading on the connected partner platform. Allocations occur synchronously. You can view your allocated balance from the BitGo web application or programmatically, as well as from your account on the connected-partner platform.

Prerequisites

Cookbook

Need just the steps? Expand the cookbook below to get started:

Allocate AssetsOpen Cookbook

1. Get Allocation Payload

Endpoint: Get Signing Payload for Client Allocations

export ENTERPRISE_ID="<YOUR_ENTERPRISE_ID>"
export CONNECTION_ID="<YOUR_CONNECTION_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"

curl -X POST \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/connections/$CONNECTION_ID/allocations/signing \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "amount": {
      "currency": "string",
      "quantity": "string"
    },
    "clientExternalId": "string",
    "nonce": "string",
    "notes": "string"
  }'

Step Result

{
  "payload": "string"
}

2. Create Allocation Request

Endpoint: Allocate Funds to Partner Connection

export ENTERPRISE_ID="<YOUR_ENTERPRISE_ID>"
export CONNECTION_ID="<YOUR_CONNECTION_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"

curl -X POST \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/connections/$CONNECTION_ID/allocations \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "amount": {
      "currency": "string",
      "quantity": "string"
    },
    "clientExternalId": "string",
    "payload": "string", # The payload string received in the previous step
    "signature": "string",
    "nonce": "string",
    "notes": "string"
  }'

Step Result

{
  "allocation": {
    "status": "cleared",
    "retriable": false,
    "id": "string",
    "amount": {
      "currency": "string",
      "quantity": "string"
    },
    "connectionId": "string",
    "clientExternalId": "string",
    "partnerExternalId": "string",
    "initiatedBy": "string",
    "notes": "string",
    "createdAt": "2019-08-24T00:00:00.000Z",
    "updatedAt": "2019-08-24T00:00:00.000Z"
  }
}

Next

  • You can trade your allocated assets on the connected partner platform.
  • Deallocate Assets

See Also

API Reference: Allocate assets to Partner Connection