GAgalileo-ft
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

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/setAlerts
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

alertsstring required

List of alerts to enable for the specified account. Pattern: JSON string Example: "{"BADJ":{"email_flag":"1","pager_flag": "1"},"BAUT":{"email_flag":"1","pager_flag":"1"}}"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "alerts": "{\"BADJ\":{\"email_flag\":\"1\",\"pager_flag\": \"1\"},\"BAUT\":{\"email_flag\":\"1\",\"pager_flag\":\"1\"}}"
}

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.