GAgalileo-ft
Transactions

Get Account Overview

Use the Get Account Overview endpoint to retrieve the combined response data from several other endpoints. Best practice is to use this endpoint to retrieve the data for a customer's landing page or other similar display.

Data sets returned by Get Account Overview:

  • General account information (balance, status, application date)
  • Cardholder profile data
  • Posted transactions
  • Pending card authorizations
  • Pending fees (generally because of insufficient funds)
  • Savings interest data, applicable only if an associated savings account exists; otherwise, a unary savings_interest element is returned.

📘 Note

Transactions created by Program API endpoints (such as <a href="ref:post_createpayment" target="_blank">Create Payment</a>, <a href="ref:post_createadjustment" target="_blank">Create Adjustment</a>, and <a href="ref:post_createaccounttransfer" target="_blank">Create Account Transfer</a>) are not present in this endpoint's response for several seconds after creation.

post/getAccountOverview

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

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>. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

startDatestring date nullable

The beginning date for the date range, either a date or a date-time. Pattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss Example: "2016-01-01"

endDatestring date nullable

The end date for the date range, either a date or a date-time. Must be equal to or later than startDate. Max 1098 days (~3 years) after startDate. Pattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss Example: "2016-01-01"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "startDate": "2016-01-01",
  "endDate": "2016-01-01"
}

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.