Get Signing Payload for Client Deallocations

get

https://app.bitgo-test.com/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocations/signing

This API call allows clients to get the client deallocations payload for signing. The returned payload should be cryptographically signed by the client and included in the subsequent deallocation request.

If your HTTP client doesn't support sending a request body on a get request, use the V1ClientDeallocationsSigningPostRoute

Error scenarios:

400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Invalid UUID format for connectionId, malformed request body.
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: Unprocessable Entity Error
Occurs when the request is valid but cannot be processed due to business rules.
Examples: Connection is inactive, requested currency not supported.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues.

Path Params

enterpriseId

string

required

length ≥ 1

The enterprise identifier of the client. This identifies the client enterprise that owns the connection.

connectionId

string

required

The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.

Body Params

amount

object

required

The amount to deallocate from the connection. Contains both the currency identifier and the quantity in base units.

clientExternalId

string

required

length ≥ 1

External identifier provided by the client. Used for idempotence and correlation with client systems.

nonce

string

required

length ≥ 1

A unique nonce value used for cryptographic operations. This provides additional security for deallocation operations.

notes

string

length ≥ 1

Optional notes provided by the client when creating the deallocation. Can contain additional context or information about the purpose of the deallocation.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity

500Internal Server Error