Get Direct Deposit Switch Token

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getDirectDepositSwitchToken

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 Setting Up Direct Deposit Switch for instructions on using this endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of the local account. Do not use the CAD.
Pattern: 12-digit or 16-digit numeric string
Example: "344101254935"

ddAccountNo

string

required

^$|^[0-9]{6,16}$

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"

ddRoutingNo

string

required

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

ddAccountType

string

enum

required

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

Allowed:

ddAccountDescription

string | null

≤ 50

^[a-zA-Z0-9_\-\ ]*$

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

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Status codes

default