Ping

Use this API endpoint to verify your authentication is working for the given connectionID.

Authentication

AuthorizationBearer
This authentication type can be used to directly call the service.
OR
X-API-KEYstring
This authentication type is supported by using the provided API key for the merchant account.

Path parameters

connectionIdstringRequired>=36 characters
represents the ID of a connection. It is used as a unique identifier for the connection

Response

OK
messagestring
success message when correctly authenticated.
$schemastringRead-onlyformat: "uri"
A URL to the JSON Schema for this object.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error