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
    Min length: >= 1 characters
  • connectionIdstringRequired

Request Body

amount object required
currency string required
quantity string required
clientExternalId string required
Min length: >= 1 characters
nonce string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
payload string required
Min length: >= 1 characters
signature string required
Min length: >= 1 characters

200 Response

One of
deallocation 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
Allowed value: false
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
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
Allowed value: false
status string required
Allowed value: released
reason string required
Min length: >= 1 characters
error string required

500 Response

One of
error string required