Deallocate Funds from Connection

post/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.

Path Parameters

  • enterpriseIdstringRequired
  • connectionIdstringRequired

Request Body

amount object required
currency string required
quantity string required
clientExternalId string required
nonce string required
notes string
payload string required
signature string required

200 Response

deallocation object required
id string required
amount object required
connectionId string required
clientExternalId string required
partnerExternalId string
initiatedBy string required
notes string
createdAt string required
updatedAt string required
status string required
Allowed value: cleared

400 Response

401 Response

error string required

404 Response

error string required

422 Response

deallocation object required
id string required
amount object required
connectionId string required
clientExternalId string required
partnerExternalId string
initiatedBy string required
notes string
createdAt string required
updatedAt string required
status string required
Allowed value: released
reason string required
error string required

500 Response

One of
error string required