REST API›Settle (Off Exchange)›Client Activation

GET

Get Signing Payload for Client Connections

This API call allows clients to get the client connections payload for signing. If your HTTP client doesn't support sending a request body on a get request, use the V1ClientConnectionsSigningPostRoute

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed

  • Examples: Empty string provided for entepriseId, missing required fields in 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 resources cannot be found.

  • Examples: Enterprise ID doesn't exist, specified partner ID doesn't exist.

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request.

  • Examples: Database connection issues. Transient network errors.

Requires access token scope: settlement_network_read

Path Params

  • enterpriseId string required

    at least 1 characters

Body Params

object

  • partnerId string required
  • name string required

    at least 1 characters

  • connectionKey object required

    ONE OF

    • schema string enum required
      token
    • connectionToken string required

      at least 1 characters

  • nonce string required

    at least 1 characters

Responses

200
OK

Response Body

object

  • payload string required
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