/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocations
This API call allows clients to deallocate funds from a connected partner. A successful deallocation will unlock funds and ensure that they are available for actions (withdrawal/rebalancing) at BitGo. Note: Deallocations will happen synchronously and deallocated amounts can be viewed in the BitGo Application or via a balance endpoint.
enterpriseId
stringRequired>= 1 characters
connectionId
stringRequiredamount
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
deallocation
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 deallocation
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