Client - View Go Network Details

Overview

BitGo enables you to retrieve Go Network details, including:

Allocations and deallocations
Balances
Settlements
Settlement transfers

Your Go Network account is identifiable by your enterprise ID. Even though you may have multiple connected partners, you can return all details that pertain to your Go Network account using just your enterprise ID.

Prerequisites

Steps

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

curl -X GET \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/allocations \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

curl -X GET \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/balances \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

curl -X GET \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/settlements \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

curl -X GET \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/settlementTransfers \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Step Result

{
  "allocations": [
    {
      "reason": {},
      "status": "cleared",
      "type": "allocation",
      "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"
    }
  ]
}

{
  "clientId": "string",
  "balances": {
    "property1": {
      "available": "string",
      "held": "string"
    },
    "property2": {
      "available": "string",
      "held": "string"
    }
  },
  "networkBalances": {
    "property1": {
      "partnerId": "string",
      "partnersConnectionId": "string",
      "name": "string",
      "balances": {
        "property1": {
          "available": "string",
          "held": "string"
        },
        "property2": {
          "available": "string",
          "held": "string"
        }
      }
    },
    "property2": {
      "partnerId": "string",
      "partnersConnectionId": "string",
      "name": "string",
      "balances": {
        "property1": {
          "available": "string",
          "held": "string"
        },
        "property2": {
          "available": "string",
          "held": "string"
        }
      }
    }
  }
}

{
  "status": "completed",
  "notes": "string",
  "reason": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "id": "string",
  "partnerId": "string",
  "externalId": "string",
  "reconciled": true,
  "initiatedBy": "string"
}

{
  "settlementTransfers": [
    {
      "id": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "currency": "string",
      "settlementId": "string",
      "quantity": "string",
      "txIds": [
        "string"
      ],
      "settlementStatus": "failed",
      "sourceTradingAccountId": "string",
      "sourceClientName": "string",
      "destinationTradingAccountId": "string",
      "destinationClientName": "string",
      "sourceNetworkAccountId": "string",
      "sourceConnectionName": "string",
      "destinationNetworkAccountId": "string",
      "destinationConnectionName": "string"
    }
  ]
}

See Also

Updated 1 day ago