--- title: "Get Account Overview" method: POST path: "/getAccountOverview" tags: ["Transactions"] --- # Get Account Overview `POST /getAccountOverview` 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 Create Payment, Create Adjustment, and Create Account Transfer) are not present in this endpoint's response for several seconds after creation. ## Response `default` - object - `status_code` integer, nullable, required β€” The response status code. May return a string for some statuses. - `status` string, nullable, required β€” The condition of a process or response - `processing_time` number, float, nullable, required β€” The time elapsed in processing the transaction - `echo` object, nullable, required β€” A structure that contains transaction ID information - `transaction_id` string, nullable, required β€” An ID that represents an API transaction - `provider_timestamp` string, date-time, nullable, required β€” Store a related timestamp for reporting and troubleshooting purposes - `provider_transaction_id` string, nullable, required β€” Secondary transaction identifier (generated by a provider) - `system_timestamp` string, date-time, nullable, required β€” A system generated timestamp - `rtoken` string, nullable, required β€” A system-generated ID used for tracking - `errors` string[] β€” A list of errors generated while the request was processed - `response_data` object, nullable, required β€” A structure for the response data. It can be empty but usually will contain information. - `pmt_ref_no` string, required β€” Payment reference number. - `status` string, required β€” Status of the account - `first_fund_date` string, date, nullable, required β€” Date the account was first funded - `application_date` string, date, nullable, required β€” Date the account application was received - `balance` number, float, required β€” The current account balance - `currency_code` string, required β€” A three-character code to represent global currencies - `profile` object, required - `id` string, required β€” Account holder's primary ID - `id2` string, nullable β€” Account holder's secondary ID - `id3` string, nullable β€” Account holder's tertiary ID - `id_type` integer, required β€” The ID type for `id`. See Customer ID Types for valid values - `id2_type` integer, nullable β€” The ID type for `id2` - `id3_type` integer, nullable β€” The ID type for `id3` - `first_name` string, required β€” Account holder's first name - `middle_name` string, nullable, required β€” Account holder's middle name - `last_name` string, required β€” Account holder's last name - `address_1` string, nullable, required β€” First line of the account holder's address - `address_2` string, nullable, required β€” Second line of the account holder's address - `business_name` string, nullable, required β€” Business name on the account - `city` string, nullable, required β€” Account holder's city - `state` string, required β€” Account holder's state - `postal_code` string, required β€” Account holder's postal code - `country_code` string, nullable, required β€” The ISO 3166 international standard for country codes. Identifies the account holder's country. - `home_phone` string, nullable, required β€” Account holder's home phone number - `mobile_phone` string, nullable, required β€” Account holder's mobile phone number - `mobile_phone_country_code` string, nullable β€” Account holder's mobile phone country code - `carrier_id` integer, nullable β€” Account holder's mobile phone carrier ID - `email` string, nullable, required β€” Account holder's email address - `dob` string, date, nullable, required β€” Account holder's date of birth - `ship_to_address` object, required - `address_1` string, nullable, required β€” First line of the shipping address - `address_2` string, nullable, required β€” Second line of the shipping address - `city` string, nullable, required β€” City for the shipping address - `state` string, nullable, required β€” State for the shipping address - `postal_code` string, nullable, required β€” Postal code for the shipping address - `country_code` string, nullable, required β€” ISO 3166 country code indicating the country for the shipping address - `express_mail` string, nullable β€” Indicates whether to use express mail for shipping - `occupation` string, nullable β€” Account holder's occupation - `income_source` string, nullable β€” Account holder's income source - `monthly_income` string, nullable β€” Account holder's monthly income - `preferred_lang` string, nullable β€” Account holder's preferred language - `preferred_name` string, nullable - `start_date` string, date-time, nullable, required β€” The start date for the range that account information is displayed - `end_date` string, date-time, nullable, required β€” The end date for the range that account information is displayed - `transaction_count` integer, required β€” The number of transactions listed in the response - `transactions` object[], required β€” List of transactions - `pmt_ref_no` string, required β€” Payment reference number. - `act_id` string, nullable, required β€” Transaction activity identifier used in the SoFi Tech Solutions system - `act_type` string, nullable, required β€” Identifier for the transaction activity type. See the Activity Type enumeration. - `mcc` string, required β€” Merchant Category Code (MCC) for the merchant that initiated the transaction (DE018) - `post_ts` string, date-time, nullable, required β€” The system timestamp when the transaction posted to the customer account, in our system time - `amt` string, required β€” The transaction amount in the currency of the account. A negative amount debits funds from the customer account. - `details` string, required β€” Description provided by the merchant about the transaction (DE043) - `description` string, nullable, required β€” Description of the activity type (`act_type`). See the Activity Type enumeration. - `source_id` string, required β€” System-generated identifier that maps to the original transaction, such as `auth_id`, `pmt_id`, or `adj_id` - `bal_id` string, required β€” Balance ID, a system-generated identifier for the account on which the transaction occurs. Maps to `galileo_account_number`. - `prod_id` string, required β€” Identifier for the product associated with the account - `auth_ts` string, date-time, required β€” System timestamp when the transaction was authorized, in our system time - `trans_code` string, required β€” Reference your program's activity and transaction types for possible values. - `ach_transaction_id` string, nullable, required β€” Identifier for the ACH transaction, if applicable - `external_trans_id` string, nullable, required β€” Optional identifier for a transaction that you supply. External to the system. - `original_auth_id` string, nullable, required β€” The `auth_id` of the previous transaction in the sequence, if any. Maps to `prior_id`. - `network_id` string, nullable, required β€” A system-generated code to identify the subnetwork over which the transaction took place. Maps to `network_code`. - `local_amt` string, nullable, required β€” Amount of the authorization request at the point of sale. Unsigned. This amount does not include upcharges or program fees. In the `authorizations` object, this amount is displayed in cents. (DE004) - `local_curr_code` string, nullable, required β€” Currency code for `local_amt` (DE049) - `settle_amt` string, nullable, required β€” The transaction amount, in cents, in the settlement currency (DE005). 12-digit number including leading zeros. - `settle_curr_code` string, nullable, required β€” Currency code for `settle_amt` (DE050) - `billing_amt` string, nullable, required β€” The transaction amount, in cents, in the currency of the account (DE006). 12-digit number including leading zeros. - `billing_curr_code` string, nullable, required β€” Currency code for `billing_amt` (DE051) - `credit_ind` string, nullable, required β€” Indicates whether a PIN was input at the point of sale. `Y` = No PIN was input. `N` = A PIN was input. `None` = Not a card transaction, or not processed as a card transaction. - `iac_tax` number, float, nullable β€” Impuesto al Consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program. - `iva_tax` number, float, nullable β€” Impuesto al Valor Agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program. - `funding_account_prn` string, nullable β€” The <> of the <> funding account - `spending_account_prn` string, nullable β€” The PRN of the RTF spending account - `authorization_count` integer, required β€” The number of authorizations listed in the response - `authorizations` object[], required β€” List of authorizations - `auth_id` string, required β€” A system-generated identifier for an authorization. - `details` string, required β€” Description provided by the merchant about the transaction (DE043) - `details_formatted` string, required β€” The same information as in the `details` field, with formatting - `amount` string, required β€” The authorization amount, in the currency of the account - `timestamp` string, date-time, nullable, required β€” The system timestamp for the authorization, in our system time - `type` string, required β€” Reference your program's authorization transaction types for possible values. - `mcc` string, required β€” Category code for the merchant that initiated the transaction (DE018) - `merchant_id` string, required β€” Network-assigned identifier for a merchant (DE042) - `acq_id` string, required β€” The identifier for the acquirer (DE032) - `terminal_id` string, required β€” Identifier for the card reader at the point of sale (DE041) - `can_be_expired` string, required β€” Whether to allow an expiration on this authorization: `1` = Allow, or `0` = Do not allow - `original_auth_id` string, nullable, required β€” The `auth_id` of the previous transaction in the sequence, if any. Maps to `prior_id` in other contexts. - `network_code` string, nullable, required β€” A system-generated code to identify the network over which the transaction took place. Maps to `network_id`. - `local_amt` string, nullable, required β€” Amount in cents of the transaction based on the currency at the point of sale (DE004). 12-digit number including leading zeros. - `local_curr_code` string, nullable, required β€” Currency code for `local_amt` (DE049) - `settle_amt` string, nullable, required β€” The transaction amount, in cents, in the settlement currency (DE005). 12-digit number including leading zeros. - `settle_curr_code` string, nullable, required β€” Currency code for `settle_amt` (DE050) - `billing_amt` string, nullable, required β€” The billing amount in cents (DE006). 12-digit number including leading zeros. - `billing_curr_code` string, nullable, required β€” Currency code for `billing_amt` (DE051) - `iac_tax` number, float, nullable β€” Impuesto al Consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program. - `iva_tax` number, float, nullable β€” Impuesto al Valor Agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program. - `latest_incremental_id` string, nullable β€” The `auth_id` of the previous authorization in an incremental sequence, if any. This field contains the same information as `original_auth_id` and is present only by request. - `original_incremental_id` string, nullable β€” The `auth_id` of the first authorization in an incremental sequence, if any. This field is present only by request. - `pmt_ref_no` string, required β€” Payment reference number. - `bal_id` string, required β€” Balance ID, a system-generated identifier for the account on which the transaction occurs. Maps to `galileo_account_number`. - `pending_fees` object[], required β€” List of fees - `fee_event_id` string, required β€” System-generated fee transaction integer ID - `type` string, required β€” Three-letter fee code. This is not the transaction type (otype). - `type_description` string, required β€” A description of the type code - `amt` string, required β€” Amount of the fee charge - `fee_date` string, date-time, required β€” A timestamp for the time the fee was charged - `card_id` integer, nullable, required β€” Integer identifier of the card as found in the raw data file (RDF). Unique identifier for a PAN. - `fee_description` string, required β€” The description on a fee - `related_transaction` object, nullable, required β€” A data structure that contains information on transactions related to a fee - `details` string, nullable, required β€” Information on a transaction or authorization - `amt` number, float, required β€” Amount of a fee or transaction charge - `post_ts` string, date-time, required β€” The time stamp of a posted transaction - `savings_interest` object, required - `start_date` string, date-time, required β€” The start date for the period - `end_date` string, date-time, required β€” The end date for the period - `accrual_interest` unknown, required - `interest_ytd` unknown, required - `apy` unknown, required - `holds` object[] β€” List of holds. Holds being returned are dependant on product parameters - `hold_id` string, required β€” Identifier for the hold - `create_dt` string, date-time, nullable, required β€” Timestamp when the hold was created - `expiry_dt` string, date-time, nullable, required β€” Date the hold expires - `source_id` string, nullable, required β€” Source ID for the hold - `change_ts` string, date-time, nullable β€” Timestamp when the hold was changed - `hold_type` string, nullable, required β€” Identifier for the hold type - `ext_id` string, nullable, required β€” External identifier for the hold - `dscr` string, nullable, required β€” Description of the hold - `originating_system_id` string, nullable, required β€” Identifier that specifies the source system for the hold - `agent_id` string, nullable, required β€” Identifier for the agent that created the hold - `amount` number, float, required β€” The amount for the hold - `xid` string, nullable, required β€” The transaction ID associated with the hold - `expiring_system_id` string, nullable, required β€” Identifier for the process that expired the hold - `expiring_agent_id` string, nullable, required β€” Identifier for the agent that expired the hold - `kyc_ref_no` string, nullable β€” A know-your-customer (KYC) reference number for the account - `curp` string, nullable β€” Clave Única de Registro de PoblaciΓ³n (CURP) for the account - `political_affiliation` boolean, nullable β€” Whether the account is associated with a politically exposed person - `place_of_birth` string, nullable β€” Place of birth of the account holder in ISO-3166-2 format: `XX-XX`. For example, `US-NY` - `nationality` string, nullable β€” Nationality of the account holder in ISO-3166-1 format (2 letters) --- [API](https://skmtc.net/galileo-ft/apis/program-api.md) Β· [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) Β· [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/versions/bcd728f97a18/schema)