v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

Alerts

Set Alerts

Use the Set Alerts endpoint to permit customers to send <a href="ref:api-reference-events-api-about-events-api" target="_blank">Events API</a> messages to their interfaces. You can use any of the Events API messages that you have been configured to receive. Pass the alert configuration in JSON format for the alerts parameter. The example in the parameter description shows how to set alert preferences for the <a href="ref:api-reference-events-api-auth" target="_blank">BAUT: auth</a> and <a href="ref:api-reference-events-api-adj" target="_blank">BADJ: adj</a> alert messages.

post/setAlerts

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.