Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Miscellaneous

Ping

Use the Ping endpoint to test API connectivity and permissions. Ping does not perform any functions on the system. Some use cases for Ping are:

  • Testing access from an automated monitoring service
  • Integrating with an API call to confirm assumptions and validate access
post/ping

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.