openapi: 3.2.0
info:
  title: Program Alerts API
  version: '4.0'
servers:
- url: api-{corename}.{env}.gpsrv.com/intserv/4.0/
tags:
- name: Alerts
paths:
  /getAlerts:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                accountNo:
                  type: string
                  pattern: ^$|^([0-9]{12}|[0-9]{16})$
                  description: "The <<glossary:PRN>> or <<glossary:PAN>> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
                  example: 074103447228
              required:
              - accountNo
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. It can be empty but usually will contain information.
                    type:
                    - object
                    - 'null'
                    properties:
                      alerts:
                        type: object
                        description: An associative array with keys that identify the alert type.
                        additionalProperties:
                          type: object
                          properties:
                            api_flag:
                              type:
                              - string
                              - 'null'
                              description: API flag
                            email_flag:
                              type:
                              - string
                              - 'null'
                              description: Email flag
                            pager_flag:
                              type:
                              - string
                              - 'null'
                              description: Pager flag
                          required:
                          - api_flag
                          - email_flag
                          - pager_flag
                    required:
                    - alerts
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.079,\n    \"response_data\": {\n        \"alerts\": {\n            \"BADJ\": {\n                \"api_flag\": \"0\",\n                \"email_flag\": \"1\",\n                \"pager_flag\": \"1\"\n            },\n            \"BAUT\": {\n                \"api_flag\": \"0\",\n                \"email_flag\": \"1\",\n                \"pager_flag\": \"1\"\n            }\n        }\n    },\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"QTKAXITAO2SK2R27ML29\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:39:08\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.056</processing_time>\n  <response_data>\n    <alerts>\n      <BADJ>\n        <api_flag>0</api_flag>\n        <email_flag>1</email_flag>\n        <pager_flag>1</pager_flag>\n      </BADJ>\n      <BAUT>\n        <api_flag>0</api_flag>\n        <email_flag>1</email_flag>\n        <pager_flag>1</pager_flag>\n      </BAUT>\n    </alerts>\n  </response_data>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>742TMK6BVIIBVLP2GOUD</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:32:31</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: Use the Get Alerts endpoint to retrieve a list of alerts that a customer can set, according to your program settings and whether the alert is enabled for the delivery channel.
      summary: Get Alerts
      operationId: post_getalerts
  /getAlertsBlackout:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                accountNo:
                  type: string
                  pattern: ^$|^([0-9]{12}|[0-9]{16})$
                  description: "The <<glossary:PRN>> or <<glossary:PAN>> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
                  example: 074103447228
              required:
              - accountNo
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. It can be empty but usually will contain information.
                    type:
                    - object
                    - 'null'
                    properties:
                      black_out:
                        description: Black out
                        type: object
                        properties:
                          begin_time:
                            type: string
                            description: Displays the beginning time (in 24 hour format) for an alert blackout
                          end_time:
                            type: string
                            description: Displays the time (in 24 hour format) for an alert blackout to end
                          time_zone:
                            type:
                            - string
                            - 'null'
                            description: Displays the time zone to calculate blackout between; -3=Hawaii, -2=Alaska, -1=Pacific, 0=Mountain, 1=Central, 2=Easter, 3=Atlantic
                          daylight_savings:
                            type:
                            - string
                            - 'null'
                            description: Displays if daylight savings time is observed on the alerts blackout
                        required:
                        - begin_time
                        - daylight_savings
                        - end_time
                        - time_zone
                    required:
                    - black_out
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.061,\n    \"response_data\": {\n        \"black_out\": {\n            \"begin_time\": \"07:00\",\n            \"end_time\": \"15:00\",\n            \"time_zone\": \"0\",\n            \"daylight_savings\": \"Y\"\n        }\n    },\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"CC2N3XSSMQYMAOPSL8XY\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:39:08\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.074</processing_time>\n  <response_data>\n    <black_out>\n      <begin_time>07:00</begin_time>\n      <end_time>15:00</end_time>\n      <time_zone>0</time_zone>\n      <daylight_savings>Y</daylight_savings>\n    </black_out>\n  </response_data>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>EIMZQMNLB0646JIK2IAN</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:32:32</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: Use the Get Alerts Blackout endpoint to retrieve a list of customer-defined preferences for when messages should not be sent.
      summary: Get Alerts Blackout
      operationId: post_getalertsblackout
  /getCarrierList:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                programId:
                  type: integer
                  format: int32
                  description: 'Program ID number provided by SoFi Tech Solutions.

                    Pattern: Positive integer value

                    Example: `1032`'
                  example: 1032
              required:
              - programId
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. It can be empty but usually will contain information.
                    type:
                    - object
                    - 'null'
                    properties:
                      found:
                        type: integer
                        format: int32
                        description: A count of the Carriers being reported on
                      carriers:
                        type: array
                        description: List of carrier objects
                        items:
                          description: A data structure that lists one or more carriers
                          type: object
                          properties:
                            carrier_id:
                              type: string
                              description: An ID number assigned to the associated carrier
                            email_gateway:
                              type:
                              - string
                              - 'null'
                              description: A domain name to be used for translating emails to text messages with various phone carriers
                            carrier_name:
                              type:
                              - string
                              - 'null'
                              description: The name of the mobile phone service carrier
                            carrier_display_name:
                              type:
                              - string
                              - 'null'
                              description: The name of the mobile phone service carrier
                          required:
                          - carrier_display_name
                          - carrier_id
                          - carrier_name
                          - email_gateway
                    required:
                    - carriers
                    - found
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.028,\n    \"response_data\": {\n        \"found\": 5,\n        \"carriers\": [\n            {\n                \"carrier_id\": \"4\",\n                \"email_gateway\": \"mobile.mycingular.net\",\n                \"carrier_name\": \"AT&T Cingular\",\n                \"carrier_display_name\": \"AT&T Cingular\"\n            },\n            {\n                \"carrier_id\": \"2\",\n                \"email_gateway\": \"txt.att.net\",\n                \"carrier_name\": \"AT&T Mobile\",\n                \"carrier_display_name\": \"AT&T Mobile\"\n            },\n            {\n                \"carrier_id\": \"1\",\n                \"email_gateway\": \"mobile.mycingular.net\",\n                \"carrier_name\": \"AT&T mMode\",\n                \"carrier_display_name\": \"AT&T mMode\"\n            },\n            {\n                \"carrier_id\": \"3\",\n                \"email_gateway\": \"sms.alltelwireless.com\",\n                \"carrier_name\": \"AllTel\",\n                \"carrier_display_name\": \"AllTel\"\n            },\n            {\n                \"carrier_id\": \"42\",\n                \"email_gateway\": \"awsms.com\",\n                \"carrier_name\": \"Appalachian Wireless\",\n                \"carrier_display_name\": \"Appalachian Wireless\"\n            }\n        ]\n    },\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"80YI6K6YJXKRD3UKWEG3\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:39:09\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.091</processing_time>\n  <response_data>\n    <found>5</found>\n    <carriers>\n      <carrier>\n        <carrier_id>4</carrier_id>\n        <email_gateway>mobile.mycingular.net</email_gateway>\n        <carrier_name>AT&amp;T Cingular</carrier_name>\n        <carrier_display_name>AT&amp;T Cingular</carrier_display_name>\n      </carrier>\n      <carrier>\n        <carrier_id>2</carrier_id>\n        <email_gateway>txt.att.net</email_gateway>\n        <carrier_name>AT&amp;T Mobile</carrier_name>\n        <carrier_display_name>AT&amp;T Mobile</carrier_display_name>\n      </carrier>\n      <carrier>\n        <carrier_id>1</carrier_id>\n        <email_gateway>mobile.mycingular.net</email_gateway>\n        <carrier_name>AT&amp;T mMode</carrier_name>\n        <carrier_display_name>AT&amp;T mMode</carrier_display_name>\n      </carrier>\n      <carrier>\n        <carrier_id>3</carrier_id>\n        <email_gateway>sms.alltelwireless.com</email_gateway>\n        <carrier_name>AllTel</carrier_name>\n        <carrier_display_name>AllTel</carrier_display_name>\n      </carrier>\n      <carrier>\n        <carrier_id>42</carrier_id>\n        <email_gateway>awsms.com</email_gateway>\n        <carrier_name>Appalachian Wireless</carrier_name>\n        <carrier_display_name>Appalachian Wireless</carrier_display_name>\n      </carrier>\n    </carriers>\n  </response_data>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>I3RGNISA0QHCD70BUYNU</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:32:32</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: Use the Get Carriers List endpoint to retrieve a set of carrier names and IDs. The `carrier_id` in the response is the value that was passed as `mobileCarrierId` in theCreate Account request.
      summary: Get Carriers List
      operationId: post_getcarrierlist
  /modifyOnDemandAlertStatus:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                accountNo:
                  type: string
                  pattern: ^$|^([0-9]{12}|[0-9]{16})$
                  description: "The <<glossary:PRN>> or <<glossary:PAN>> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
                  example: 074103447228
                prodId:
                  type: integer
                  format: int32
                  minimum: 1
                  maximum: 100000000
                  description: 'A unique product identifier from SoFi Tech Solutions.

                    Pattern: Integer

                    Example: `501`'
                  example: 501
                mobilePhone:
                  type: string
                  description: 'Account holder''s mobile phone number.

                    Pattern: Exactly 10 digits, no hyphens or other characters

                    Example: `"8013656050"`'
                  example: '8013656050'
                mobileCarrierId:
                  type: integer
                  format: int32
                  description: 'Account holder''s mobile carrier. Configurable list.

                    Pattern: Configurable list

                    Example: `8`'
                  example: 8
                actionType:
                  type: string
                  enum:
                  - E
                  - U
                  - F
                  - C
                  - S
                  description: 'Type of action to perform. See the <a href="ref:api-reference-on-demand-alert-statuses" target="_blank">On-Demand Alert Statuses</a> enumeration for valid values.

                    Pattern: One character

                    Example: `"E"`'
                  example: E
                verificationPin:
                  type:
                  - string
                  - 'null'
                  minimum: 4
                  maximum: 4
                  pattern: ^[0-9]*$
                  description: 'When `actionType: C`, this value will be validated against what was sent to the cardholder via text message.

                    Pattern: 4-digit string

                    Example: `"1234"`'
                  example: '1234'
              required:
              - accountNo
              - actionType
              - mobileCarrierId
              - mobilePhone
              - prodId
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
                    type: object
                    properties: {}
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.115,\n    \"response_data\": {},\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"OYOVB4LKYN5DKR27TOHZ\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:39:12\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.095</processing_time>\n  <response_data/>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>HZGH967TOQ73475R5ZL4</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:32:35</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: Use the Modify On-Demand Alert Status endpoint to register or unregister a customer for on-demand alerts.
      summary: Modify On-Demand Alert Status
      operationId: post_modifyondemandalertstatus
  /setAlerts:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                accountNo:
                  type: string
                  pattern: ^$|^([0-9]{12}|[0-9]{16})$
                  description: "The <<glossary:PRN>> or <<glossary:PAN>> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
                  example: 074103447228
                alerts:
                  type: string
                  description: '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: '{"BADJ":{"email_flag":"1","pager_flag": "1"},"BAUT":{"email_flag":"1","pager_flag":"1"}}'
              required:
              - accountNo
              - alerts
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
                    type: object
                    properties: {}
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.06,\n    \"response_data\": {},\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"EAPZON4DUF01M9KST68J\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:39:49\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.043</processing_time>\n  <response_data/>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>S4IMKP5UPUMWSY5APTPA</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:33:05</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: 'Use the Set Alerts endpoint to permit customers to send Events API 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 BAUT: auth and BADJ: adj alert messages.'
      summary: Set Alerts
      operationId: post_setalerts
  /setAlertsBlackout:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                accountNo:
                  type: string
                  pattern: ^$|^([0-9]{12}|[0-9]{16})$
                  description: "The <<glossary:PRN>> or <<glossary:PAN>> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
                  example: 074103447228
                beginTime:
                  type: string
                  pattern: ^([0-1][0-9]|[2][0-3]):[0][0]$
                  description: 'Starting time for alerts to be sent. Set to whole hours only.

                    Pattern: HH`:00`

                    Example: `"07:00"`'
                  example: 07:00
                endTime:
                  type: string
                  pattern: ^([0-1][0-9]|[2][0-3]):[0][0]$
                  description: 'Time of day alerts must end. Set to whole hours only.

                    Pattern: HH`:00`

                    Example: `"22:00"`'
                  example: '22:00'
                timeZone:
                  type: string
                  enum:
                  - '-3'
                  - '-2'
                  - '-1'
                  - '0'
                  - '1'
                  - '2'
                  - '3'
                  - hawaii
                  - alaska
                  - pacific
                  - mountain
                  - central
                  - eastern
                  - atlantic
                  description: 'Time zone offset from Arizona time for `beginTime` and `endTime`:

                    * `-3` &mdash; Hawaii time zone

                    * `-2` &mdash; Alaska time zone

                    * `-1` &mdash; Pacific time zone

                    * `0` &mdash; Mountain time zone

                    * `1` &mdash; Central time zone

                    * `2` &mdash; Eastern time zone

                    * `3` &mdash; Atlantic time zone


                    Pattern:  Integer between `-3` and `3`

                    Example: `-1`'
                  example: -1
                daylightSavings:
                  type: string
                  enum:
                  - Y
                  - N
                  description: 'Specifies whether to observe daylight savings time.

                    Pattern: `Y` or `N`

                    Example: `"Y"`'
                  example: Y
              required:
              - accountNo
              - beginTime
              - daylightSavings
              - endTime
              - timeZone
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
                    type: object
                    properties: {}
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.037,\n    \"response_data\": {},\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"LK8PVPBBE4BRIDVV3V5G\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:39:49\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.037</processing_time>\n  <response_data/>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>RVYYGFQEAKGKWQ8TXWCM</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:33:05</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: Use the Set Alerts Blackout to set customer preferences for when messages should not be sent.
      summary: Set Alerts Blackout
      operationId: post_setalertsblackout
  /verifyOnDemandAlertStatus:
    parameters:
    - $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                apiLogin:
                  type: string
                  description: 'Web service username, as provided by SoFi Tech Solutions.

                    Pattern: Max 50 characters

                    Example: `"AbC123-9999"`'
                  example: AbC123-9999
                apiTransKey:
                  type: string
                  description: 'Web service password, as provided by SoFi Tech Solutions.

                    Pattern: Max 15 characters

                    Example: `"4sb62fh6w4h7w34g"`'
                  example: 4sb62fh6w4h7w34g
                providerId:
                  type: integer
                  format: int32
                  description: 'Your unique provider identifier from SoFi Tech Solutions.

                    Pattern: Max 10 digits

                    Example: `9999`'
                  example: 9999
                transactionId:
                  type: string
                  minimum: 1
                  maximum: 60
                  description: '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"`'
                  example: 123e4567-e89b-12d3-a456-426614174000
                accountNo:
                  type: string
                  pattern: ^$|^([0-9]{12}|[0-9]{16})$
                  description: "The <<glossary:PRN>> or <<glossary:PAN>> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
                  example: 074103447228
              required:
              - accountNo
              - transactionId
              - apiLogin
              - apiTransKey
              - providerId
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type:
                    - integer
                    - 'null'
                    format: int32
                    description: The response status code. May return a string for some statuses.
                  status:
                    type:
                    - string
                    - 'null'
                    description: The condition of a process or response
                  processing_time:
                    type:
                    - number
                    - 'null'
                    format: float
                    description: The time elapsed in processing the transaction
                  echo:
                    description: A structure that contains transaction ID information
                    type:
                    - object
                    - 'null'
                    properties:
                      transaction_id:
                        type:
                        - string
                        - 'null'
                        description: An ID that represents an API transaction
                      provider_timestamp:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: Store a related timestamp for reporting and troubleshooting purposes
                      provider_transaction_id:
                        type:
                        - string
                        - 'null'
                        description: Secondary transaction identifier (generated by a provider)
                    required:
                    - provider_timestamp
                    - provider_transaction_id
                    - transaction_id
                  system_timestamp:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: A system generated timestamp
                  rtoken:
                    type:
                    - string
                    - 'null'
                    description: A system-generated ID used for tracking
                  errors:
                    type: array
                    description: A list of errors generated while the request was processed
                    items:
                      type: string
                  response_data:
                    description: A structure for the response data. It can be empty but usually will contain information.
                    type:
                    - object
                    - 'null'
                    properties:
                      on_demand_status:
                        type: string
                        description: The status of the SMS (on demand) alert enrollment of the customer. See <a href="ref:api-reference-on-demand-alert-statuses" target="_blank">On-Demand Alert Statuses</a>.
                      mobile_phone:
                        type: string
                        description: The mobile phone number that receives alerts
                      carrier_id:
                        type:
                        - string
                        - 'null'
                        description: An ID number assigned to the associated carrier
                      pmt_ref_no:
                        type: string
                        description: A system-generated account number
                      prod_id:
                        type: string
                        description: System-generated product Id of the account
                    required:
                    - carrier_id
                    - mobile_phone
                    - on_demand_status
                    - pmt_ref_no
                    - prod_id
                required:
                - echo
                - processing_time
                - response_data
                - rtoken
                - status
                - status_code
                - system_timestamp
              examples:
                response:
                  value: "{\n    \"status_code\": 0,\n    \"status\": \"Success\",\n    \"processing_time\": 0.039,\n    \"response_data\": {\n        \"on_demand_status\": \"S\",\n        \"mobile_phone\": \"8012222222\",\n        \"carrier_id\": \"8\",\n        \"pmt_ref_no\": \"001104890593\",\n        \"prod_id\": \"88\"\n    },\n    \"echo\": {\n        \"provider_transaction_id\": \"\",\n        \"provider_timestamp\": null,\n        \"transaction_id\": \"4J7CD9IKK2SDCGZNA124\"\n    },\n    \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n    \"system_timestamp\": \"2025-07-13 10:40:11\"\n}"
            application/xml:
              examples:
                response:
                  value: "<?xml version=\"1.0\" ?>\n<response>\n  <status_code>0</status_code>\n  <status>Success</status>\n  <processing_time>0.137</processing_time>\n  <response_data>\n    <on_demand_status>S</on_demand_status>\n    <mobile_phone>8012222222</mobile_phone>\n    <carrier_id>8</carrier_id>\n    <pmt_ref_no>001104890593</pmt_ref_no>\n    <prod_id>88</prod_id>\n  </response_data>\n  <echo>\n    <provider_transaction_id/>\n    <provider_timestamp/>\n    <transaction_id>P7KZIRQ46F78VPL11GW3</transaction_id>\n  </echo>\n  <rtoken>8cc16de0-5eda-4e2a-968e-3b08fce6f778</rtoken>\n  <system_timestamp>2025-07-13 12:33:23</system_timestamp>\n</response>"
      tags:
      - Alerts
      description: Use the Verify On-Demand Alert Status endpoint to retrieve whether a customer can use on-demand alerts.
      summary: Verify On-Demand Alert Status
      operationId: post_verifyondemandalertstatus
components:
  parameters:
    ResponseContentTypeHeaderParam:
      name: response-content-type
      in: header
      description: Use this header instead of the standard `accept` header to specify the response format.
      schema:
        type: string
        enum:
        - xml
        - json
        default: json
x-readme:
  samples-languages:
  - curl
  - python
  - node
  - java
  - go
  - ruby
  - javascript
  explorer-enabled: true
  proxy-enabled: true