Verify Account

post

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

Use the Verify Account endpoint to return information on an account. For example, you can use this endpoint to validate that you can call Create Payment on the account without violating the load amount. Verify Account will also return secondary accounts that share the same balance ID and product ID.

This endpoint returns:

Current account balance — Both posted and authorized transactions are factored into the balance amount
Current maximum amount that can be loaded into the account, according to product parameters
External account ID
Account PRN
Galileo account number (balance ID)

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 account.
Pattern: PRN or PAN
Example: "074103447228"

loadType

string | null

^[a-zA-Z0-9]{1,2}$

Load type (otype) of the load to verify. Use values from your list of load types from SoFi Tech Solutions. If no loadType is specified, the default type RL is used.
Pattern: 2 alphanumeric characters
Example: "RL"

includeRelated

int32

enum

Defaults to 0

Whether to return data for all accounts that share the same account holder (client_id).

0 or blank — Default. Retrieve only the specified account.
1 — Retrieve all accounts from the same account holder`.

Pattern: Integer
Example: 1

Allowed:

Headers

response-content-type

string

enum

Defaults to json

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

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

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

application/json

application/xml