> ## 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. Pass `include_owned_accounts=true` with your own `user_id` to aggregate your personal ledger and the businesses you own into one feed; each row then carries the owning `account`. ## OpenAPI ````yaml /openapi/api-v1-native.json get /financial-activity openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: 2026-07-08-1 servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated account time series for reporting. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account and retrieve existing bank deposit activity. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Verification represents an identity review for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/beta/verifications/update-verification). name: Verifications x-whop-summary: Identity review required before payouts and card issuing. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > The Referrals API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- The users and businesses you referred to Whop, and what you earn from them. - description: > A Workforce Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Workforce Bounties API to list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Workforce Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Person represents a visitor or customer of an account, assembled from [pixel events](/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts. Use the People API to list the people of an account and retrieve a single person. name: People x-whop-summary: Visitors and customers of an account, aggregated from pixel events. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events and list the events recorded for a person. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences. Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' 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. Pass `include_owned_accounts=true` with your own `user_id` to aggregate your personal ledger and the businesses you own into one feed; each row then carries the owning `account`. operationId: listFinancialActivity parameters: - description: The owning account ID (a biz_ identifier). Provide this or user_id. in: query name: account_id required: false schema: type: string - description: The owning user ID (a user_ identifier). Provide this or account_id. in: query name: user_id required: false schema: type: string - description: >- When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning `account`. in: query name: include_owned_accounts required: false schema: type: boolean - 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. explode: true in: query name: line_types required: false schema: items: type: string type: array style: form - description: Optional currency code filter, for example `usd`. in: query name: currency required: false schema: type: string - description: Only include rows posted after this ISO 8601 timestamp. in: query name: posted_after required: false schema: format: date-time type: string - description: Only include rows posted before this ISO 8601 timestamp. in: query name: posted_before required: false schema: format: date-time type: string - description: >- Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD` settlement date (UTC), distinct from posted_at. Requires currency. in: query name: available_after required: false schema: format: date type: string - 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. in: query name: available_before required: false schema: format: date type: string - description: Maximum number of rows to return. in: query name: limit required: false schema: default: 20 maximum: 100 type: integer - description: Cursor returned by the previous page. in: query name: cursor required: false schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/LedgerActivity' type: array page_info: properties: end_cursor: type: - string - 'null' has_next_page: type: boolean has_previous_page: type: boolean start_cursor: type: - string - 'null' required: - has_next_page - end_cursor - has_previous_page - start_cursor type: object required: - data - page_info type: object description: activities listed for a user '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: properties: account: description: >- The viewer account that owns this row's ledger. Present only when the response aggregates owned accounts (include_owned_accounts=true); omitted otherwise. oneOf: - properties: id: description: Account ID. type: string logo_url: description: Account logo URL. type: - string - 'null' object: enum: - account type: string route: description: Account route. type: - string - 'null' title: description: Account display name. type: - string - 'null' required: - object - id - title - route - logo_url type: object - properties: id: description: User ID. type: string name: description: User display name. type: - string - 'null' object: enum: - user type: string profile_picture_url: description: User profile image URL. type: - string - 'null' username: description: User's username. type: - string - 'null' required: - object - id - name - username - profile_picture_url type: object amount: description: Signed amount in the currency's smallest precision units. type: string available_at: 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. format: date-time type: - string - 'null' created_at: description: When the activity record was created. format: date-time type: - string - 'null' currency: description: Currency for this ledger activity. properties: code: description: Currency code. type: string precision: description: >- Precision factor for the currency, for example `100000000` for USD. type: string required: - code - precision type: object id: description: Ledger activity ID. type: string ledger_account_id: description: >- The ledger account (a ldgr_ identifier) this row belongs to. Present only when the response aggregates owned accounts (include_owned_accounts=true); omitted otherwise. Pair it with `account` to scope drawers and dashboard links to the owning business. type: - string - 'null' line_type: description: Type of ledger activity. type: string object: enum: - ledger_activity type: string posted_at: description: When the activity posted to the ledger. format: date-time type: string resource: description: Resource associated with this ledger activity. oneOf: - properties: id: description: Account ID. type: string logo_url: description: Account logo URL. type: - string - 'null' object: enum: - account type: string route: description: Account route. type: - string - 'null' title: description: Account display name. type: - string - 'null' required: - object - id - title - route - logo_url type: object - properties: id: description: User ID. type: string name: description: User display name. type: - string - 'null' object: enum: - user type: string profile_picture_url: description: User profile image URL. type: - string - 'null' username: description: User's username. type: - string - 'null' required: - object - id - name - username - profile_picture_url type: object - properties: id: description: Bounty ID. type: string object: enum: - bounty type: string status: description: Bounty lifecycle status. type: string title: description: Bounty title. type: string required: - object - id - title - status type: object - properties: id: description: Ledger account ID. type: string object: enum: - ledger_account type: string owner: oneOf: - properties: id: description: Account ID. type: string logo_url: description: Account logo URL. type: - string - 'null' object: enum: - account type: string route: description: Account route. type: - string - 'null' title: description: Account display name. type: - string - 'null' required: - object - id - title - route - logo_url type: object - properties: id: description: User ID. type: string name: description: User display name. type: - string - 'null' object: enum: - user type: string profile_picture_url: description: User profile image URL. type: - string - 'null' username: description: User's username. type: - string - 'null' required: - object - id - name - username - profile_picture_url type: object - type: 'null' required: - object - id - owner type: object - properties: bank: properties: account_name: description: Bank account holder name. type: - string - 'null' account_type: description: Bank account type. type: - string - 'null' bank_name: description: Bank name. type: - string - 'null' last4: description: Last four digits of the bank account. type: - string - 'null' required: - bank_name - account_name - last4 - account_type type: - object - 'null' card: properties: brand: description: Card brand. type: - string - 'null' exp_month: description: Card expiration month. type: - integer - 'null' exp_year: description: Card expiration year. type: - integer - 'null' last4: description: Last four digits of the card. type: - string - 'null' required: - brand - last4 - exp_month - exp_year type: - object - 'null' email_identifier: description: Email identifier for email-based payment methods. type: - string - 'null' gateway_type: description: Payment gateway type. type: - string - 'null' id: description: Payment method ID. type: string object: enum: - payment_method type: string payment_method_type: description: Payment method type. type: - string - 'null' required: - object - id - payment_method_type - gateway_type - card - bank - email_identifier type: object - properties: account_reference: description: Masked account reference. type: - string - 'null' destination_currency_code: description: Destination currency code. type: - string - 'null' id: description: Payout method ID. type: string institution_name: description: Payout institution name. type: - string - 'null' nickname: description: Payout method nickname. type: - string - 'null' object: enum: - payout_method type: string provider: description: Payout provider. type: - string - 'null' required: - object - id - nickname - institution_name - account_reference - provider - destination_currency_code type: object - properties: authorized_at: description: ISO 8601 timestamp the transaction was authorized. format: date-time type: - string - 'null' card_id: description: Identifier of the card that the transaction was charged to. type: - string - 'null' cashback_usd: 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. type: - string - 'null' declined_reason: description: >- Reason the transaction was declined (when status is declined). type: - string - 'null' id: description: Card transaction ID. type: string local_amount: description: >- Amount the merchant charged in their local currency, as a decimal string. Pair with local_currency. type: - string - 'null' local_currency: description: >- ISO 4217 currency code of the merchant-charged amount in local_amount. type: - string - 'null' merchant_category: description: Merchant category. type: - string - 'null' merchant_icon_url: description: Merchant icon URL. type: - string - 'null' merchant_name: description: Merchant display name. type: - string - 'null' object: enum: - card_transaction type: string posted_at: description: >- ISO 8601 timestamp the transaction was settled by the card network. format: date-time type: - string - 'null' status: description: Current card transaction status. type: - string - 'null' usd_amount: description: >- The processor-settled USD amount as a decimal string. The ledger's USDT leg is posted 1:1 from this value. type: - string - 'null' 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: object - type: 'null' source: additionalProperties: true description: Source of this ledger activity. properties: amount_float: description: >- Withdrawal amount as a decimal number in the destination currency (withdrawal sources only; requires payout:withdrawal:read). type: - number - 'null' chain: description: >- Chain the deposit landed on, for example plasma (onchain_transaction sources only). type: - string - 'null' claim_url: description: >- Public claim URL for the airdrop link (airdrop_link sources only). type: - string - 'null' created_at: description: >- Withdrawal creation time as an ISO 8601 timestamp (withdrawal sources only; requires payout:withdrawal:read). format: date-time type: - string - 'null' estimated_arrival: description: >- Estimated arrival as an ISO 8601 timestamp (withdrawal sources only; requires payout:withdrawal:read). format: date-time type: - string - 'null' from_amount: description: >- Amount converted out of from_currency as a decimal string (swap sources only). type: - string - 'null' from_currency: description: Lowercase currency code converted from (swap sources only). type: - string - 'null' id: type: string object: type: string payer_name: description: >- Name of the entity processing the payout (withdrawal sources only; requires payout:withdrawal:read). type: - string - 'null' payout_destination: description: Payout destination display info (withdrawal sources only). properties: icon_url: type: - string - 'null' payer_name: type: - string - 'null' type: - object - 'null' payout_token_nickname: description: Saved payout destination nickname (withdrawal sources only). type: - string - 'null' reason: description: >- Transfer reason on transfer sources, for example pool_top_up or bounty_return. type: - string - 'null' sender_address: description: >- Sender wallet address or onramp provider identifier (onchain_transaction sources only). type: - string - 'null' status: 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). type: - string - 'null' to_amount: description: >- Amount received in to_currency as a decimal string (swap sources only). type: - string - 'null' to_currency: description: Lowercase currency code converted to (swap sources only). type: - string - 'null' tx_hash: description: >- On-chain transaction hash (onchain_transaction and swap sources only). type: - string - 'null' required: - object - id type: - object - 'null' required: - object - id - line_type - amount - currency - posted_at - available_at - created_at - resource - source type: object V1ErrorResponse: properties: error: properties: message: description: Human-readable error message. type: string type: description: Machine-readable error code. type: string required: - type - message type: object required: - error type: object responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters Unauthorized: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Unauthorized Forbidden: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Forbidden NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````