Get client Allocation or Deallocation

get/api/network/v1/enterprises/{enterpriseId}/clients/allocations/{allocationId}

Returns an allocation or deallocation. For use only by BitGo Network clients.

Path Parameters

  • allocationIdstringRequired
  • enterpriseIdstringRequired
    Min length: >= 1 characters

200 Response

allocation object required
id string required
amountOne ofrequired
connectionId string required
clientExternalId string required
Min length: >= 1 characters
partnerExternalId string
Min length: >= 1 characters
initiatedBy string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required
retriable boolean required
reason
string or null
required
Min length: >= 1 characters
status string required
Allowed values: cleared released reserved
type string required
Allowed values: allocation deallocation

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required