---
title: "Get Accounts Summary"
method: POST
path: "/v3/{customerId}/BankingServices/GetAccountsSummary"
tags: ["Connect"]
---

# Get Accounts Summary

`POST /v3/{customerId}/BankingServices/GetAccountsSummary`

To access general account details such as the cardholder's name (when available), account balance, account category and EFT eligibility, use the /GetAccountsSummary endpoint.

## Path parameters

- `customerId` string, required

## Headers

- `x-api-key` string

## Request body

- object
  - `RequestId` string, required — Unique identifier provided after a successful request to the /Authorize endpoint.
  - `WithBalance` boolean — Specifies if you want to include account balances in the account summary.
  - `WithAccountIdentity` boolean — Specifies if you want to include the account numbers in the account summary.

## Response `200`

Success

- object
  - `HttpStatusCode` integer — HTTP status code of the response.
  - `Accounts` object[]
    - `EftEligibleRatio` integer — Decimal value (0-1) indicating EFT eligibility percentage.
    - `ETransferEligibleRatio` integer — Decimal value (0-1) indicating e-Transfer eligibility percentage.
    - `Title` string — Account title (e.g., "Primary Chequing Account").
    - `AccountNumber` string — Account number.
    - `LastFourDigits` string — Last four digits of the account number.
    - `Balance` object — Account balance information.
      - `Available` number
      - `Current` number
      - `Limit` string
    - `Category` string — Account category (e.g., "Operations").
    - `Type` string — Account type (e.g., "Chequing", "Savings").
    - `Currency` string — Currency code (e.g., "CAD").
    - `Holder` object — Account holder information.
      - `Name` string — Account holder name.
      - `Address` object — Account holder address.
        - `CivicAddress` string — Street address.
        - `City` string — City name.
        - `Province` string — Province/State code.
        - `PostalCode` string — Postal/ZIP code.
        - `POBox` string — PO Box (if applicable).
        - `Country` string — Country code.
      - `Email` string — Account holder email.
      - `PhoneNumber` string — Account holder phone number.
    - `AccountType` 'Personal' | 'Business', nullable — Type of account.
    - `Id` string — Unique account identifier.
  - `Links` object[] — List of available data endpoints.
    - `rel` string — Relationship type of the link.
    - `href` string — Endpoint path.
    - `example` string — Example value (if applicable).
  - `Tag` string — User tag (if provided).
  - `InstitutionName` string — Name of the financial institution.
  - `Login` object — Login information.
    - `Username` string — Login username.
    - `IsScheduledRefresh` boolean — Indicates if scheduled refresh is enabled.
    - `LastRefresh` string — Timestamp of last data refresh.
    - `Type` string — Login type (e.g., "Personal", "Business").
    - `Id` string — Unique login identifier.
  - `InstitutionId` integer — Unique identifier of the financial institution.
  - `Institution` string — Name of the financial institution.
  - `RequestId` string

## Other responses

- `202` — Operation Pending
- `400` — Session Nonexistent

---

[API](https://skmtc.dev/flinks/apis/flinks-api.md) · [All operations](https://skmtc.dev/flinks/apis/flinks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/flinks/flinks-api/revisions/0983646f91b4/schema)