Update Partner Deallocations

put/api/network/v1/enterprises/{enterpriseId}/partners/deallocations

This API call allows partners to inform the OES system about an update to a deallocation made to one of their connections. This endpoint is only relevant to OES partners that have async deallocations enabled.

A successful response indicates that the allocation was successfully updated in the OES system and the funds are cleared (if cleared is passed for status) or released (if released is passed for status).

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Request Body

deallocationId string required
The unique identifier of the deallocation to update. This UUID uniquely identifies the deallocation record.
amount object required
The currency/quantity that was submitted for deallocation. This is a base unit amount. The exact base units depend on the currency (e.g., satoshis for BTC, wei for ETH).
currency string required
Min length: >= 1 characters
quantity string required
clientId string required
The unique identifier of the client which initiated the deallocation. This UUID uniquely identifies the client within the BitGo system.
connectionId string required
The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.
partnersClientId string required
The unique identifier of the client in the partner system. This value uniquely identifies the client within the partner's system.
Min length: >= 1 characters
partnersConnectionId string required
The unique identifier of the connection in the partner system. This value uniquely identifies the connection between a client and a partner in the partner's system.
Min length: >= 1 characters
partnersDeallocationId string required
The unique identifier of the deallocation in the partner system. This value uniquely identifies the deallocation record within the partner's system.
Min length: >= 1 characters
status string required
The status to update the deallocation to. The status can be either 'cleared' or 'released'. If the status is 'released', a reason for the release must be provided in the form of a non-empty string.
Allowed values: cleared released
nonce string required
Unique nonce to prevent replay attacks. This value: - Must be unique for each request requiring a nonce. - Should be a cryptographically strong random value. - Is used as part of the request signing process. - Helps ensure the signature can only be used once.
Min length: >= 1 characters
rejectReason string
The reason for releasing the deallocation.
Min length: >= 1 characters
payload string required
Payload formed by stringifying the object containing all other request properties. This includes: - status - rejectReason (only if status is 'released') - deallocationId - amount - clientId - connectionId - partnersClientId - partnersConnectionId - partnersDeallocationId - nonce The payload must be signed using your BitGo account's private key to create the signature parameter.
Min length: >= 1 characters
signature string required
Digital signature of the payload parameter. This signature: - Must be created using your BitGo account's private key. - Verifies that the request is authentic and hasn't been tampered with. - Provides non-repudiation for the allocation request.
Min length: >= 1 characters

200 Response

deallocationId string required
The unique identifier of the deallocation to update. This UUID uniquely identifies the deallocation record.
amount object required
The currency/quantity that was submitted for deallocation. This is a base unit amount. The exact base units depend on the currency (e.g., satoshis for BTC, wei for ETH).
currency string required
Min length: >= 1 characters
quantity string required
clientId string required
The unique identifier of the client which initiated the deallocation. This UUID uniquely identifies the client within the BitGo system.
connectionId string required
The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.
partnersClientId string required
The unique identifier of the client in the partner system. This value uniquely identifies the client within the partner's system.
Min length: >= 1 characters
partnersConnectionId string required
The unique identifier of the connection in the partner system. This value uniquely identifies the connection between a client and a partner in the partner's system.
Min length: >= 1 characters
partnersDeallocationId string required
The unique identifier of the deallocation in the partner system. This value uniquely identifies the deallocation record within the partner's system.
Min length: >= 1 characters

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

409 Response

error string required

422 Response

error string required

500 Response

error string required