Ctrl+K

Get Signing Payload for Client Deallocations

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

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 Parameters

  • enterpriseIdstringRequired
    The enterprise identifier of the client. This identifies the client enterprise that owns the connection.
    Min length: >= 1 characters
  • connectionIdstringRequired
    The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.

Request Body

amount object required
The amount to deallocate from the connection. Contains both the currency identifier and the quantity in base units.
currency string required
quantity string required
clientExternalId string required
External identifier provided by the client. Used for idempotence and correlation with client systems.
Min length: >= 1 characters
nonce string required
A unique nonce value used for cryptographic operations. This provides additional security for deallocation operations.
Min length: >= 1 characters
notes string
Optional notes provided by the client when creating the deallocation. Can contain additional context or information about the purpose of the deallocation.
Min length: >= 1 characters

200 Response

payload string required
The payload string that should be signed. This string should be cryptographically signed by the client and included in the subsequent deallocation request along with the signature.

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

422 Response

error string required

500 Response

error string required