GAgalileo-ft
Transactions

Get Billpay Switch Token

Use the Get Billpay Switch Token endpoint to request a token from SoFi Tech Solutions to pass to the payment method switch provider's SDK.

See <a href="doc:setting-up-payment-method-switch" target="_blank">Setting Up Payment Method Switch</a> for more instructions on using this endpoint.

post/getBillpaySwitchToken

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/getBillpaySwitchToken
  • 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 local account. Do not use the <glossary:CAD>. Pattern: 12-digit or 16-digit numeric string Example: "344101254935"

phoneNumberstring required

Primary phone number for the account holder, required by the switch provider for merchant verification. This value is encrypted when stored in the system. Pattern: Exactly 10 digits with no formatting characters Example: "8011234567"

cardAccountsstring[]

List of card account PRNs for payment method switch.

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "phoneNumber": "8011234567",
  "ddAccounts": [
    {
      "accountNo": "722844300741",
      "routingNumber": "124001545",
      "accountType": "checking",
      "title": "My Paycheck"
    }
  ],
  "cardAccounts": [
    "123456789012",
    "987654321098"
  ]
}

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.