> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.finverse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List card details

> Retrieve all Card Details under a Login Identity (using a specific `login_identity_token`).

**Authorization**: `login_identity_token`

### card_details (object)

Card details, split into (i) account-level, and (ii) aggregated across all card accounts.

### card_accounts (array of objects)

Full `card_accounts` array, containing a list of card accounts with account-level balances, card payment details & metadata.

#### currency object (object)

Details of any currency amount (e.g. payment or balance amount).

#### amount object (object)

Details of any non-currency amount (e.g. reward amount).

### card_totals (object)

Total card balances, payment details & metadata, when reported by the institution at an aggregate-level (instead of at `card_account` level). Finverse does not compute these values if not reported by the institution..

### institution (object)

Summary Institutions object. See `GET /institutions` for details.

### login_identity (object)

Summary Login Identity object. See `GET /login_identity` for details.



## OpenAPI

````yaml /api-reference/openapi.json get /card_details
openapi: 3.0.0
info:
  description: Documentation of the early finverse services
  title: Finverse Public
  termsOfService: https://example.com
  contact:
    name: Maintainers
    email: info@finverse.com
  license:
    name: unknown license
  version: 0.0.1
servers:
  - url: https://api.prod.finverse.net
security:
  - Oauth2:
      - test
tags:
  - name: public
    description: Publicly accessible endpoints
    x-group: Public
  - name: customer
    description: Customer app and institution endpoints
    x-group: Customer
  - name: link
    description: Finverse Link flows
    x-group: Link
  - name: login_identity
    description: Login identity lifecycle and metadata
    x-group: Login identity
  - name: accounts
    description: Accounts, balances, and account numbers
    x-group: Accounts
  - name: statements
    description: Statements and composite statements
    x-group: Statements
  - name: transactions
    description: Transaction history
    x-group: Transactions
  - name: identity_income
    description: Identity and income insights
    x-group: Identity & income
  - name: payment_links
    description: Payment link creation and checkout
    x-group: Payment links
  - name: mandates
    description: Direct debit mandates
    x-group: Mandates
  - name: payments
    description: Payment initiation and status
    x-group: Payment operations
  - name: payouts
    description: Payouts and scheduled payouts
    x-group: Payouts
  - name: payment_users
    description: Payment user profiles
    x-group: Payment users
  - name: payment_accounts
    description: Payment accounts for users
    x-group: Payment accounts
  - name: payment_methods
    description: Stored payment methods
    x-group: Payment methods
  - name: bills
    description: Bill presentment
    x-group: Bills
  - name: disputes
    description: Payment disputes
    x-group: Disputes
  - name: ledger
    description: Ledger and statements
    x-group: Ledger
paths:
  /card_details:
    get:
      tags:
        - accounts
      summary: List card details
      description: >-
        Retrieve all Card Details under a Login Identity (using a specific
        `login_identity_token`).


        **Authorization**: `login_identity_token`


        ### card_details (object)


        Card details, split into (i) account-level, and (ii) aggregated across
        all card accounts.


        ### card_accounts (array of objects)


        Full `card_accounts` array, containing a list of card accounts with
        account-level balances, card payment details & metadata.


        #### currency object (object)


        Details of any currency amount (e.g. payment or balance amount).


        #### amount object (object)


        Details of any non-currency amount (e.g. reward amount).


        ### card_totals (object)


        Total card balances, payment details & metadata, when reported by the
        institution at an aggregate-level (instead of at `card_account` level).
        Finverse does not compute these values if not reported by the
        institution..


        ### institution (object)


        Summary Institutions object. See `GET /institutions` for details.


        ### login_identity (object)


        Summary Login Identity object. See `GET /login_identity` for details.
      operationId: listCardDetails
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCardsDetailsResponse'
              examples:
                success:
                  summary: Success
                  value:
                    card_details:
                      card_accounts:
                        - account_id: 01HCMFSKAFT37ESRFTHNJK3CTZ
                          account_name: American Express Platinum
                          account_number_masked: 378XXXXXXXX0005
                          account_type:
                            subtype: CREDIT_CARD
                            type: CARD
                          available_credit_limit:
                            currency: SGD
                            raw: '19045.31'
                            value: 19045.31
                          current_balance:
                            currency: SGD
                            raw: '-954.69'
                            value: -954.69
                          last_payment_amount:
                            currency: SGD
                            raw: '100.00'
                            value: 100
                          last_payment_date: '2023-07-15'
                          minimum_payment_due:
                            currency: SGD
                            raw: '120.00'
                            value: 120
                          next_payment_due_date: '2023-08-05'
                          payment_due_amount:
                            currency: SGD
                            raw: '420.43'
                            value: 420.43
                          rewards_balances:
                            - raw: '572489'
                              unit: TB$
                              value: 572489
                          statement_date: '2023-08-05'
                          statement_due_amount:
                            currency: SGD
                            raw: '520.43'
                            value: 520.43
                          statement_payment_due_date: '2023-08-05'
                          total_credit_limit:
                            currency: SGD
                            raw: '20000.00'
                            value: 20000
                          updated_at: '2023-10-13T12:22:40.602Z'
                        - account_id: 01HCMFSKAM6G4J525H6H19S3W1
                          account_name: HKD Credit Card
                          account_number_masked: 1234XXXXXXXX0000
                          account_type:
                            subtype: CREDIT_CARD
                            type: CARD
                          available_credit_limit:
                            currency: HKD
                            raw: '8166.78'
                            value: 8166.78
                          current_balance:
                            currency: HKD
                            raw: '-1833.22'
                            value: -1833.22
                          last_payment_amount:
                            currency: HKD
                            raw: '1220.00'
                            value: 1220
                          last_payment_date: '2023-07-19'
                          minimum_payment_due:
                            currency: HKD
                            raw: '120.00'
                            value: 120
                          next_payment_due_date: '2023-08-11'
                          payment_due_amount:
                            currency: HKD
                            raw: '0.00'
                            value: 0
                          rewards_balances:
                            - raw: '3895'
                              unit: TB$
                              value: 3895
                          statement_date: '2023-08-11'
                          statement_due_amount:
                            currency: HKD
                            raw: '1220.00'
                            value: 1220
                          statement_payment_due_date: '2023-08-11'
                          total_credit_limit:
                            currency: HKD
                            raw: '10000.00'
                            value: 10000
                          updated_at: '2023-10-13T12:22:40.602Z'
                        - account_id: 01HCMFSKASNNFP3XJYCFJF60F8
                          account_name: UOB Visa
                          account_number_masked: 4242XXXXXXXX4242
                          account_type:
                            subtype: CREDIT_CARD
                            type: CARD
                          available_credit_limit:
                            currency: SGD
                            raw: '98543.10'
                            value: 98543.1
                          current_balance:
                            currency: SGD
                            raw: '-1456.90'
                            value: -1456.9
                          last_payment_amount:
                            currency: SGD
                            raw: '1220.00'
                            value: 1220
                          last_payment_date: '2023-07-25'
                          minimum_payment_due:
                            currency: SGD
                            raw: '220.00'
                            value: 220
                          next_payment_due_date: '2023-08-15'
                          payment_due_amount:
                            currency: SGD
                            raw: '0.00'
                            value: 0
                          rewards_balances:
                            - raw: '123'
                              unit: TB$
                              value: 123
                          statement_date: '2023-08-15'
                          statement_due_amount:
                            currency: SGD
                            raw: '1220.00'
                            value: 1220
                          statement_payment_due_date: '2023-08-15'
                          total_credit_limit:
                            currency: SGD
                            raw: '100000.00'
                            value: 100000
                          updated_at: '2023-10-13T12:22:40.602Z'
                      card_total:
                        available_credit_limit:
                          currency: HKD
                          raw: '125755.19189453125'
                          value: 125755.191
                        current_balance:
                          currency: HKD
                          raw: '-4244.809997558594'
                          value: -4244.81
                        minimum_payment_due:
                          currency: HKD
                          raw: '460'
                          value: 460
                        payment_due_amount:
                          currency: HKD
                          raw: '420.42999267578125'
                          value: 420.43
                        rewards_balances: []
                        statement_due_amount:
                          currency: HKD
                          raw: '2960.4299926757812'
                          value: 2960.43
                        updated_at: '2023-10-13T12:22:40.602Z'
                    institution:
                      countries:
                        - HKG
                        - IDN
                        - MYS
                        - PHL
                        - SGP
                        - THA
                        - VNM
                      institution_id: testbank
                      institution_name: Testbank
                      portal_name: Testbank Online Banking
                    login_identity:
                      last_session_id: 01HCMFRWSNHSCE28DZC1ST6XFT
                      login_identity_id: 01HCMFRWR208N4NM9M8WYC7JEG
                      status: DATA_RETRIEVAL_COMPLETE
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBodyModelV2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBodyModelV2'
      security:
        - Oauth2:
            - card:get
components:
  schemas:
    ListCardsDetailsResponse:
      properties:
        card_details:
          $ref: '#/components/schemas/CardDetails'
        institution:
          $ref: '#/components/schemas/InstitutionShort'
        login_identity:
          $ref: '#/components/schemas/LoginIdentityShort'
    ErrBodyModelV2:
      properties:
        error:
          $ref: '#/components/schemas/FvErrorModelV2'
    CardDetails:
      properties:
        card_accounts:
          type: array
          items:
            $ref: '#/components/schemas/CardAccount'
          description: >-
            Full card_accounts array, containing a list of card accounts with
            account-level balances, card payment details & metadata
        card_total:
          $ref: '#/components/schemas/CardTotal'
          description: >-
            Total card balances, payment details & metadata, when reported by
            the institution at an aggregate-level (instead of at card_account
            level). Finverse does not compute these values if not reported by
            the institution
    InstitutionShort:
      properties:
        countries:
          type: array
          items:
            type: string
          example:
            - HKG
        institution_id:
          type: string
          example: 123
        institution_name:
          type: string
          example: Mock Bank
        portal_name:
          type: string
          example: Personal Internet Banking
    LoginIdentityShort:
      properties:
        last_session_id:
          type: string
          format: ulid
        login_identity_id:
          type: string
          format: ulid
        status:
          type: string
          example: LINKING
    FvErrorModelV2:
      required:
        - type
        - error_code
        - message
        - details
        - request_id
      properties:
        details:
          type: string
        error_code:
          type: string
          example: CREDENTIALS_INVALID
        message:
          type: string
        request_id:
          description: The request_id provided in the request header
          type: string
        type:
          description: The error type
          type: string
          enum:
            - LINK_ERROR
            - API_ERROR
          example: LINKING_ERROR
    CardAccount:
      properties:
        account_id:
          description: Finverse account ID. Matches value in `GET /accounts`
          type: string
          example: 01ARZ3NDEKTSV4RRFFQ69G5FAV
        account_name:
          type: string
          example: HKD Visa
          description: >-
            End-user recognizable name for the account. Matches value in `GET
            /accounts`
        account_number_masked:
          description: >-
            Masked account number. Format: preserves original length; shows
            first 0-4 digits + last 2-4 digits in plain text (depending on
            original length); omits spaces/symbols. Matches value in `GET
            /accounts`
          type: string
        account_type:
          $ref: '#/components/schemas/AccountType'
          description: '**Beta**: account type object. See `GET /accounts`'
        available_credit_limit:
          $ref: '#/components/schemas/CurrencyAmount'
          description: >-
            Available credit limit across all cards (i.e. `total_credit_limit`
            minus `current_balance`)
        current_balance:
          $ref: '#/components/schemas/CurrencyAmount'
          description: Current outstanding balance across all cards
        last_payment_amount:
          $ref: '#/components/schemas/CurrencyAmount'
          description: Amount of last repayment made on the card
        last_payment_date:
          description: Date of last repayment made on the card
          type: string
          example: '2021-10-27'
        minimum_payment_due:
          $ref: '#/components/schemas/CurrencyAmount'
          description: >-
            Amount of minimum repayment due across all cards (may show 0 after a
            payment has been made)
        next_payment_due_date:
          description: >-
            Date of next repayment due on the card (this will be estimated based
            on `statement_payment_due_date` if the payment due date of the last
            available statement is in the past)
          type: string
          example: '2021-02-01'
        payment_due_amount:
          $ref: '#/components/schemas/CurrencyAmount'
          description: >-
            Amount of repayment currently due across all cards (may show 0 after
            a payment has been made)
        rewards_balances:
          type: array
          items:
            $ref: '#/components/schemas/GenericAmount'
          description: >-
            Available rewards balances across all cards. The array can include
            multiple objects (e.g. one for rewards points, and one for cashback
            rewards).
        statement_date:
          description: Date of the last available statement
          type: string
          example: '2021-10-27'
        statement_due_amount:
          $ref: '#/components/schemas/CurrencyAmount'
          description: >-
            Amount of repayment due according to the last available statement
            (note: this will not change after a payment is made, only when a new
            statement becomes available)
        statement_payment_due_date:
          description: >-
            Date of next repayment due on the card, according to the last
            available statement (note: this will not change after a payment is
            made, only when a new statement becomes available)
          type: string
          example: '2021-02-01'
        total_credit_limit:
          $ref: '#/components/schemas/CurrencyAmount'
          description: Total credit limit available across all cards
        updated_at:
          type: string
          format: date-time
          example: '2021-02-01T10:01:02.333Z'
          description: Timestamp of the last update to the record
    CardTotal:
      properties:
        available_credit_limit:
          $ref: '#/components/schemas/CurrencyAmount'
        current_balance:
          $ref: '#/components/schemas/CurrencyAmount'
        minimum_payment_due:
          $ref: '#/components/schemas/CurrencyAmount'
        payment_due_amount:
          $ref: '#/components/schemas/CurrencyAmount'
        rewards_balances:
          type: array
          items:
            $ref: '#/components/schemas/GenericAmount'
        statement_due_amount:
          $ref: '#/components/schemas/CurrencyAmount'
        total_credit_limit:
          $ref: '#/components/schemas/CurrencyAmount'
        updated_at:
          type: string
          format: date-time
          example: '2021-02-01T10:01:02.333Z'
    AccountType:
      properties:
        subtype:
          type: string
          enum:
            - CURRENT
            - SAVINGS
            - TIME_DEPOSIT
            - OTHER
            - CREDIT_CARD
            - DEBIT_CARD
            - SECURITIES
            - FUNDS
            - STOCKS
            - BONDS
            - MORTGAGE
            - PERSONAL_LOAN
            - REVOLVING_LOAN
            - UNKNOWN
          example: SAVINGS
          description: >-
            Secondary classification of the account. Possible values: `BONDS`,
            `CURRENT`, `CREDIT_CARD`, `DEBIT_CARD`, `FUNDS`, `MORTGAGE`,
            `PERSONAL_LOAN`, `RETIREMENT`,`REVOLVING_LOAN`, `SAVINGS`,
            `SECURITIES`, `STOCKS`, `TIME_DEPOSIT`, `OTHER`, `UNKNOWN`
        type:
          type: string
          enum:
            - DEPOSIT
            - CARD
            - INVESTMENT
            - LOAN
            - UNKNOWN
          example: DEPOSIT
          description: >-
            Primary classification of the account. Possible values: `CARD`,
            `DEPOSIT`, `INVESTMENT`, `LOAN`, `OTHER`, `UNKNOWN`
    CurrencyAmount:
      required:
        - value
      properties:
        currency:
          type: string
          example: HKD
          description: >-
            Currency of the `value`. Usually available, but may be null if value
            is 0
        raw:
          type: string
          example: '69.00'
          description: >-
            Raw amount (as reported by the institution). Usually available, but
            may be null if value is 0. Intended for QA only
        value:
          $ref: '#/components/schemas/FvDecimal'
          description: >-
            Amount. Sign follows financial statement conventions (positive sign:
            assets / money in; negative sign: liabilities / money out)
    GenericAmount:
      required:
        - value
      properties:
        raw:
          type: string
          example: '69.00'
          description: >-
            Raw amount (as reported by the institution). Usually available, but
            may be null if value is 0. Intended for QA only.
        unit:
          type: string
          example: UNI$
          description: >-
            Unit of the value amount. Usually available, but may be null if
            value is 0. Common units: (i) ISO-currency codes (e.g. "SGD"), (ii)
            "Points" for generic points programs, (iii) Bank-specific units
            (e.g. "TB$").
        value:
          $ref: '#/components/schemas/FvDecimal'
          description: Amount
    FvDecimal:
      type: number
      x-go-type:
        embedded: true
        import:
          package: gitlab.com/finverse/gitops/applications/common-go/amount
        type: FvDecimal
  securitySchemes:
    Oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://finverse-dev.us.auth0.com/oauth/token
          scopes:
            account: Account
            balance: Balance
            credit: Credit
            institution: Institution
            investment: Investment
            link: Link
            test: Test
            transaction: Transaction

````