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

# List Financial Activity

> Returns a paginated activity feed for one account or user, derived from ledger lines with typed resource and source objects for presentation. Pass exactly one of `account_id` (a `biz_` identifier) or `user_id` (a `user_` identifier). Filter by line type, currency, posted timestamp, or settlement date to reconcile a specific window.



## OpenAPI

````yaml /openapi/api-v1-native.yml get /financial-activity
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema
    at build time.
  version: v1
servers:
  - url: https://{defaultHost}
    variables:
      defaultHost:
        default: api.whop.com/api/v1
security: []
paths:
  /financial-activity:
    get:
      tags:
        - Ledgers
      summary: List Financial Activity
      description: >-
        Returns a paginated activity feed for one account or user, derived from
        ledger lines with typed resource and source objects for presentation.
        Pass exactly one of `account_id` (a `biz_` identifier) or `user_id` (a
        `user_` identifier). Filter by line type, currency, posted timestamp, or
        settlement date to reconcile a specific window.
      operationId: listFinancialActivity
      parameters:
        - name: account_id
          in: query
          required: false
          schema:
            type: string
          description: The owning account ID (a biz_ identifier). Provide this or user_id.
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          description: The owning user ID (a user_ identifier). Provide this or account_id.
        - name: line_types
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          description: >-
            Optional ledger line categories to include. Some categories (for
            example `onchain_deposit`, which covers inbound crypto deposits such
            as MoonPay onramps) are only returned when explicitly requested
            here.
        - name: currency
          in: query
          required: false
          schema:
            type: string
          description: Optional currency code filter, for example `usd`.
        - name: posted_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only include rows posted after this ISO 8601 timestamp.
        - name: posted_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only include rows posted before this ISO 8601 timestamp.
        - name: available_after
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Only include rows whose funds became withdrawable on or after this
            `YYYY-MM-DD` settlement date (UTC), distinct from posted_at.
            Requires currency.
        - name: available_before
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Only include rows whose funds became withdrawable on or before this
            `YYYY-MM-DD` settlement date (UTC). Set equal to available_after for
            a single day. Requires currency.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 100
          description: Maximum number of rows to return.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Cursor returned by the previous page.
      responses:
        '200':
          description: activities listed for a user
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LedgerActivity'
                  page_info:
                    type: object
                    properties:
                      has_next_page:
                        type: boolean
                      end_cursor:
                        type:
                          - string
                          - 'null'
                      has_previous_page:
                        type: boolean
                      start_cursor:
                        type:
                          - string
                          - 'null'
                    required:
                      - has_next_page
                      - end_cursor
                      - has_previous_page
                      - start_cursor
                required:
                  - data
                  - page_info
        '400':
          $ref: '#/components/responses/InvalidParameters'
          description: neither account_id nor user_id provided
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: missing or invalid authentication
        '403':
          $ref: '#/components/responses/Forbidden'
          description: credential lacks the required balance-read scope
        '404':
          $ref: '#/components/responses/NotFound'
          description: no ledger for that owner is visible to the credential
      security:
        - bearerAuth:
            - company:balance:read
components:
  schemas:
    LedgerActivity:
      type: object
      properties:
        object:
          type: string
          enum:
            - ledger_activity
        id:
          type: string
          description: Ledger activity ID.
        line_type:
          type: string
          description: Type of ledger activity.
        amount:
          type: string
          description: Signed amount in the currency's smallest precision units.
        currency:
          type: object
          description: Currency for this ledger activity.
          properties:
            code:
              type: string
              description: Currency code.
            precision:
              type: string
              description: >-
                Precision factor for the currency, for example `100000000` for
                USD.
          required:
            - code
            - precision
        posted_at:
          type: string
          format: date-time
          description: When the activity posted to the ledger.
        available_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            ISO 8601 timestamp these funds became (or are scheduled to become)
            withdrawable: the posted time for already-settled funds, or 00:00:00
            UTC on the scheduled release date for pending funds. Present only on
            inflows entering the balance (payments, top-ups, incoming
            transfers/affiliate); null on withdrawals, refunds, disputes and
            on-chain rows. The available_after/before filters window on its UTC
            settlement date.
        created_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the activity record was created.
        resource:
          description: Resource associated with this ledger activity.
          oneOf:
            - type: object
              properties:
                object:
                  type: string
                  enum:
                    - account
                id:
                  type: string
                  description: Account ID.
                title:
                  type:
                    - string
                    - 'null'
                  description: Account display name.
                route:
                  type:
                    - string
                    - 'null'
                  description: Account route.
                logo_url:
                  type:
                    - string
                    - 'null'
                  description: Account logo URL.
              required:
                - object
                - id
                - title
                - route
                - logo_url
            - type: object
              properties:
                object:
                  type: string
                  enum:
                    - user
                id:
                  type: string
                  description: User ID.
                name:
                  type:
                    - string
                    - 'null'
                  description: User display name.
                username:
                  type:
                    - string
                    - 'null'
                  description: User's username.
                profile_picture_url:
                  type:
                    - string
                    - 'null'
                  description: User profile image URL.
              required:
                - object
                - id
                - name
                - username
                - profile_picture_url
            - type: object
              properties:
                object:
                  type: string
                  enum:
                    - ledger_account
                id:
                  type: string
                  description: Ledger account ID.
                owner:
                  oneOf:
                    - type: object
                      properties:
                        object:
                          type: string
                          enum:
                            - account
                        id:
                          type: string
                          description: Account ID.
                        title:
                          type:
                            - string
                            - 'null'
                          description: Account display name.
                        route:
                          type:
                            - string
                            - 'null'
                          description: Account route.
                        logo_url:
                          type:
                            - string
                            - 'null'
                          description: Account logo URL.
                      required:
                        - object
                        - id
                        - title
                        - route
                        - logo_url
                    - type: object
                      properties:
                        object:
                          type: string
                          enum:
                            - user
                        id:
                          type: string
                          description: User ID.
                        name:
                          type:
                            - string
                            - 'null'
                          description: User display name.
                        username:
                          type:
                            - string
                            - 'null'
                          description: User's username.
                        profile_picture_url:
                          type:
                            - string
                            - 'null'
                          description: User profile image URL.
                      required:
                        - object
                        - id
                        - name
                        - username
                        - profile_picture_url
                    - type: 'null'
              required:
                - object
                - id
                - owner
            - type: object
              properties:
                object:
                  type: string
                  enum:
                    - payment_method
                id:
                  type: string
                  description: Payment method ID.
                payment_method_type:
                  type:
                    - string
                    - 'null'
                  description: Payment method type.
                gateway_type:
                  type:
                    - string
                    - 'null'
                  description: Payment gateway type.
                card:
                  type:
                    - object
                    - 'null'
                  properties:
                    brand:
                      type:
                        - string
                        - 'null'
                      description: Card brand.
                    last4:
                      type:
                        - string
                        - 'null'
                      description: Last four digits of the card.
                    exp_month:
                      type:
                        - integer
                        - 'null'
                      description: Card expiration month.
                    exp_year:
                      type:
                        - integer
                        - 'null'
                      description: Card expiration year.
                  required:
                    - brand
                    - last4
                    - exp_month
                    - exp_year
                bank:
                  type:
                    - object
                    - 'null'
                  properties:
                    bank_name:
                      type:
                        - string
                        - 'null'
                      description: Bank name.
                    account_name:
                      type:
                        - string
                        - 'null'
                      description: Bank account holder name.
                    last4:
                      type:
                        - string
                        - 'null'
                      description: Last four digits of the bank account.
                    account_type:
                      type:
                        - string
                        - 'null'
                      description: Bank account type.
                  required:
                    - bank_name
                    - account_name
                    - last4
                    - account_type
                email_identifier:
                  type:
                    - string
                    - 'null'
                  description: Email identifier for email-based payment methods.
              required:
                - object
                - id
                - payment_method_type
                - gateway_type
                - card
                - bank
                - email_identifier
            - type: object
              properties:
                object:
                  type: string
                  enum:
                    - payout_method
                id:
                  type: string
                  description: Payout method ID.
                nickname:
                  type:
                    - string
                    - 'null'
                  description: Payout method nickname.
                institution_name:
                  type:
                    - string
                    - 'null'
                  description: Payout institution name.
                account_reference:
                  type:
                    - string
                    - 'null'
                  description: Masked account reference.
                provider:
                  type:
                    - string
                    - 'null'
                  description: Payout provider.
                destination_currency_code:
                  type:
                    - string
                    - 'null'
                  description: Destination currency code.
              required:
                - object
                - id
                - nickname
                - institution_name
                - account_reference
                - provider
                - destination_currency_code
            - type: object
              properties:
                object:
                  type: string
                  enum:
                    - card_transaction
                id:
                  type: string
                  description: Card transaction ID.
                card_id:
                  type:
                    - string
                    - 'null'
                  description: Identifier of the card that the transaction was charged to.
                merchant_name:
                  type:
                    - string
                    - 'null'
                  description: Merchant display name.
                merchant_icon_url:
                  type:
                    - string
                    - 'null'
                  description: Merchant icon URL.
                merchant_category:
                  type:
                    - string
                    - 'null'
                  description: Merchant category.
                status:
                  type:
                    - string
                    - 'null'
                  description: Current card transaction status.
                usd_amount:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The processor-settled USD amount as a decimal string. The
                    ledger's USDT leg is posted 1:1 from this value.
                local_amount:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Amount the merchant charged in their local currency, as a
                    decimal string. Pair with local_currency.
                local_currency:
                  type:
                    - string
                    - 'null'
                  description: >-
                    ISO 4217 currency code of the merchant-charged amount in
                    local_amount.
                cashback_usd:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Cashback earned on this transaction as a USD decimal string.
                    Zero for declined or ineligible transactions; null when
                    cashback has not been computed yet.
                authorized_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: ISO 8601 timestamp the transaction was authorized.
                posted_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: >-
                    ISO 8601 timestamp the transaction was settled by the card
                    network.
                declined_reason:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Reason the transaction was declined (when status is
                    declined).
              required:
                - object
                - id
                - card_id
                - merchant_name
                - merchant_icon_url
                - merchant_category
                - status
                - usd_amount
                - local_amount
                - local_currency
                - cashback_usd
                - authorized_at
                - posted_at
                - declined_reason
            - type: 'null'
        source:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: Source of this ledger activity.
          properties:
            object:
              type: string
            id:
              type: string
            status:
              type:
                - string
                - 'null'
              description: >-
                Lifecycle status. On withdrawal sources this is the withdrawal
                status (requires payout:withdrawal:read); on airdrop_link
                sources it is the claim-link status (ungated); on payment and
                top-up sources it is the friendly payment status such as
                succeeded/pending/failed (ungated).
            claim_url:
              type:
                - string
                - 'null'
              description: >-
                Public claim URL for the airdrop link (airdrop_link sources
                only).
            amount_float:
              type:
                - number
                - 'null'
              description: >-
                Withdrawal amount as a decimal number in the destination
                currency (withdrawal sources only; requires
                payout:withdrawal:read).
            created_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Withdrawal creation time as an ISO 8601 timestamp (withdrawal
                sources only; requires payout:withdrawal:read).
            estimated_arrival:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Estimated arrival as an ISO 8601 timestamp (withdrawal sources
                only; requires payout:withdrawal:read).
            payer_name:
              type:
                - string
                - 'null'
              description: >-
                Name of the entity processing the payout (withdrawal sources
                only; requires payout:withdrawal:read).
            payout_token_nickname:
              type:
                - string
                - 'null'
              description: Saved payout destination nickname (withdrawal sources only).
            tx_hash:
              type:
                - string
                - 'null'
              description: >-
                On-chain transaction hash (onchain_transaction and swap sources
                only).
            sender_address:
              type:
                - string
                - 'null'
              description: >-
                Sender wallet address or onramp provider identifier
                (onchain_transaction sources only).
            chain:
              type:
                - string
                - 'null'
              description: >-
                Chain the deposit landed on, for example plasma
                (onchain_transaction sources only).
            from_amount:
              type:
                - string
                - 'null'
              description: >-
                Amount converted out of from_currency as a decimal string (swap
                sources only).
            from_currency:
              type:
                - string
                - 'null'
              description: Lowercase currency code converted from (swap sources only).
            to_amount:
              type:
                - string
                - 'null'
              description: >-
                Amount received in to_currency as a decimal string (swap sources
                only).
            to_currency:
              type:
                - string
                - 'null'
              description: Lowercase currency code converted to (swap sources only).
            payout_destination:
              type:
                - object
                - 'null'
              description: Payout destination display info (withdrawal sources only).
              properties:
                payer_name:
                  type:
                    - string
                    - 'null'
                icon_url:
                  type:
                    - string
                    - 'null'
          required:
            - object
            - id
      required:
        - object
        - id
        - line_type
        - amount
        - currency
        - posted_at
        - available_at
        - created_at
        - resource
        - source
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - type
            - message
      required:
        - error
  responses:
    InvalidParameters:
      description: Invalid Parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        An account API key, account scoped JWT, app API key, or user OAuth
        token.

````