GAgalileo-ft
IVR

Create IVR Call

Use the Create IVR Call endpoint to create an IVR call entry. This endpoint connects your IVR system to the SoFi Tech Solutions IVR system for PIN setting.

post/createIvrCall

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/createIvrCall
  • 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"

callTypestring required

The type of call. CPIN is the only valid value. Pattern: Alphabetic string Example: "CPIN"

callParamsstring required

JSON-encoded array of call parameters. Pattern: JSON string Example: "{"panLastFour":"1234", "passCode":"0123", "expiryDate":"2011-01-01"}"

phonestring nullable

Phone number where to route outbound calls. This number supersedes any account-related phone numbers. Pattern: Exactly 10 digits, no hyphens or other characters Example: "8013656060"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "callType": "CPIN",
  "callParams": "{\"panLastFour\":\"1234\", \"passCode\":\"0123\", \"expiryDate\":\"2011-01-01\"}",
  "phone": "8013656060"
}

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

Changes

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