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.