REST API›Settle (Off Exchange)›Client Allocations & Deallocations

GET

Get Signing Payload for Client Deallocations

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.

Requires access token scope: settlement_network_read

Path Params

  • enterpriseId string required
    The enterprise identifier of the client. This identifies the client enterprise that owns the connection.

    at least 1 characters

  • 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

object

  • amount object required
    The amount to deallocate from the connection. Contains both the currency identifier and the quantity in base units.
    amount object
    • currency string required
    • quantity string required
  • clientExternalId string required
    External identifier provided by the client. Used for idempotence and correlation with client systems.

    at least 1 characters

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

    at least 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.

    at least 1 characters

Responses

200
OK

Response Body

object

  • 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
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
403
Forbidden

Response Body

object

  • error string required
404
Not Found

Response Body

object

  • error string required
422
Unprocessable Entity

Response Body

object

  • error string required
500
Internal Server Error

Response Body

object

  • error string required