v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
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

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