GAgalileo-ft
Transactions

Get Direct Deposit Switch Token

Use the Get Direct Deposit Switch Token endpoint to request a token from SoFi Tech Solutions to pass to the direct deposit switch provider's SDK.

See <a href="doc:setting-up-direct-deposit-switch" target="_blank">Setting Up Direct Deposit Switch</a> for instructions on using this endpoint.

post/getDirectDepositSwitchToken

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

ddAccountNostring required

PAN or PRN of the account that will receive the direct deposit. Do not use the CAD. Can be the same account number as accountNo. For external accounts, this can be 6 to 16 digits. Pattern: 6 to 16 digit numeric string Example: "722844300741"

ddRoutingNostring required

Routing number for the account in ddSwitchAccountNo. Pattern: 9-digit routing number, including check digit Example: "124001545"

ddAccountType'checking' | 'savings' required

Type of account in ddSwitchAccountNo. Pattern: String Example: "checking"

ddAccountDescriptionstring nullable

Description for the direct deposit account. Pattern: Max 50 characters: letters, numbers, spaces, hyphens, underscores. Example: "SoFi Plus Checking account"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "ddAccountNo": "722844300741",
  "ddRoutingNo": "124001545",
  "ddAccountType": "checking",
  "ddAccountDescription": "My Paycheck"
}

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.