/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/allocations
This API call allows clients to allocate funds to a connected partner for trade. A successful allocation indicates that funds are locked at BitGo and available for spend on the connected partner. Note: Allocations will happen synchronously and allocated amounts can be viewed in the BitGo Application or via a balances endpoint.
connectionId
stringRequiredenterpriseId
stringRequired>= 1 characters
amount
object required currency
string required quantity
string required clientExternalId
string required >= 1 characters
nonce
string required >= 1 characters
notes
string >= 1 characters
payload
string required >= 1 characters
signature
string required >= 1 characters
allocation
object required id
string required amount
One ofrequired connectionId
string required clientExternalId
string required >= 1 characters
partnerExternalId
string >= 1 characters
initiatedBy
string required >= 1 characters
notes
string >= 1 characters
createdAt
string <date-time>
required updatedAt
string <date-time>
required retriable
boolean required false
status
string required cleared
error
string required error
string required error
string required allocation
object required id
string required amount
One ofrequired connectionId
string required clientExternalId
string required >= 1 characters
partnerExternalId
string >= 1 characters
initiatedBy
string required >= 1 characters
notes
string >= 1 characters
createdAt
string <date-time>
required updatedAt
string <date-time>
required retriable
boolean required false
status
string required released
reason
string required >= 1 characters
error
string required error
string required