Ctrl+K

Allocate Assets

Overview

Allocate assets in your Go Network account to a connected-partner platform. Allocated assets are locked with BitGo and available for trading on the connected partner's 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

1. Get Allocation Payload

Endpoint: Get Signing Payload for Client Allocations

  • cURL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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

  • JSON
1
2
3
{
  "payload": "string"
}

2. Create Allocation Request

Endpoint: Allocate Funds to Partner Connection

  • cURL
  • JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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

  • JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "allocation": {
    "status": "cleared",
    "id": "string",
    "amount": {
      "currency": "string",
      "quantity": "string"
    },
    "connectionId": "string",
    "clientExternalId": "string",
    "partnerExternalId": "string",
    "initiatedBy": "string",
    "notes": "string",
    "createdAt": "2019-08-24",
    "updatedAt": "2019-08-24"
  }
}

Next

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

See Also

API Reference: Allocate assets to Partner Connection