/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocationsThis 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.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Invalid UUID format for connectionId, invalid enterpriseId format, malformed request body, invalid signature format.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated client doesn't have necessary permissions.
Examples: Enterprise does not have OES license.
404: Not Found Error
Occurs when the specified connection cannot be found.
Examples: Connection ID doesn't exist, connection doesn't belong to this client.
422: Deallocation Error with Released Status
Occurs when the deallocation cannot be processed due to business rules.
Examples: Insufficient funds available for deallocation, connection is inactive, deallocation amount exceeds available balance.
500: Internal Server Error or Reserved Deallocation
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues, transient network errors.
enterpriseIdstringRequired>= 1 charactersconnectionIdstringRequiredamount object required currency string required quantity string required clientExternalId string required >= 1 charactersnonce string required >= 1 charactersnotes string >= 1 characterspayload string required >= 1 characterssignature string required >= 1 charactersdeallocation object required id string required amountOne ofrequired connectionId string required clientExternalId string required >= 1 characterspartnerExternalId string >= 1 charactersinitiatedBy string required >= 1 charactersnotes string >= 1 characterscreatedAt string <date-time>required updatedAt string <date-time>required retriable boolean required falseevaluationId string >= 1 characterspendingApprovalId string >= 1 characterspolicyResult string approved rejectedstatus string required clearederror string required error string required error string required deallocation object required id string required amountOne ofrequired connectionId string required clientExternalId string required >= 1 characterspartnerExternalId string >= 1 charactersinitiatedBy string required >= 1 charactersnotes string >= 1 characterscreatedAt string <date-time>required updatedAt string <date-time>required retriable boolean required falseevaluationId string >= 1 characterspendingApprovalId string >= 1 characterspolicyResult string approved rejectedstatus string required releasedreason string required >= 1 characterserror string required error string required