Accounts and Cards

Verify Account

Use the Verify Account endpoint to return information on an account. For example, you can use this endpoint to validate that you can call <a href="ref:post_createpayment" target="_blank">Create Payment</a> 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)
post/verifyAccount

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/verifyAccount
  • 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: PRN or PAN Example: "074103447228"

loadTypestring nullable

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"

includeRelated0 | 1

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

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "loadType": "RL",
  "includeRelated": 1
}

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.