Skip to main content
A Financial Activity row is a single movement of money in or out of an account’s or user’s balance: a payment, payout, refund, transfer, on-chain deposit, swap, or card transaction. Each row carries a typed resource and source so you can present and link the event without extra lookups. Use the Financial Activity API to build a statement or transaction feed for an account or user, and financial reports to summarize balance activity, income, and balances over a date range, then break a report total down into what drove it.

Endpoints

Attributes

string
required
Ledger activity ID.
account or user
The viewer account that owns this row’s ledger. Present only when the response aggregates owned accounts (include_owned_accounts=true); omitted otherwise.
string
required
Signed amount in the currency’s smallest precision units.
string | null
required
ISO 8601 timestamp when this activity affects available funds: 00:00:00 UTC on the scheduled release date for credits and debits in a pending good-funds release bucket; the posted time for credits and debits to settled available funds, including refunds, disputes and payouts. Null for activity outside these paths, including on-chain rows. The available_after/before filters use its UTC date; default activity excludes some movements, including opt-in reserves.
object
required
Currency for this ledger activity.

Properties

string
required
Currency code.
string
required
Precision factor for the currency, for example 100000000 for USD.
string | null
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.
string
required
The ledger line category this activity was posted under.Available options: psp_payment_receivable, payment_gross, topup, topup_fee, payment_gross_reversal, topup_reversal, payment_refund, payment_refund_reversal, platform_balance_payment, platform_balance_payment_refund, ad_spend_purchase, psp_refund_payable, passthrough_gmv, passthrough_gmv_offset, installment_default, aggregated_fee, payment_processing_fixed_fee, payment_processing_percentage_fee, billing_percentage_fee, cross_border_percentage_fee, fx_percentage_fee, orchestration_percentage_fee, revshare_percentage_fee, stripe_domestic_processing_fee, stripe_international_processing_fee, three_ds_fixed_fee, whop_processing_fee, economic_intelligence_percentage_fee, high_risk_merchant_fee, fraud_prevention_fee, buyer_fee, sales_tax_fee, payout_fee, affiliate_fee, marketplace_affiliate_fee, application_fee, platform_markup_fee, platform_markup_fee_payout, sales_tax_remittance, sales_tax_remittance_reversal, sales_tax_collected, sales_tax_collected_reversal, sales_tax_remitted, payment_dispute, payment_dispute_adjustment, payment_dispute_fee, payment_dispute_reversal, platform_covered_dispute, dispute_alert_fee, dispute_representment_fee, dispute_hold_adjustment, dispute_hold_blocked, psp_dispute_payable, withdrawal, withdrawal_payable, withdrawal_payable_reversal, withdrawal_fee, withdrawal_fee_reversal, withdrawal_markup_fee, withdrawal_markup_fee_reversal, withdrawal_markup_fee_payout, withdrawal_markup_fee_payout_reversal, withdrawal_reversal, withdrawal_clawback, withdrawal_clawback_reversal, payout_receivable, withdrawal_reclassification, clawback_receivable, clawback_receivable_reversal, treasury_payin, treasury_payin_receivable, onchain_deposit, onchain_deposit_offset, onchain_withdrawal, onchain_withdrawal_offset, trading_account_withdrawal, trading_account_withdrawal_offset, trading_account_deposit, trading_account_deposit_offset, onchain_wallet_transfer_outgoing, onchain_wallet_transfer_incoming, onchain_internal_transfer_outgoing, onchain_internal_transfer_incoming, onchain_swap_source, onchain_swap_target, onchain_swap_offset, whop_swap_fee_received, swap_fee, internal_withdrawal, internal_withdrawal_reversal, internal_withdrawal_payable, internal_withdrawal_payable_reversal, internal_withdrawal_fee, internal_withdrawal_fee_reversal, internal_withdrawal_markup_fee, internal_withdrawal_markup_fee_reversal, internal_withdrawal_markup_fee_payout, internal_withdrawal_markup_fee_payout_reversal, internal_withdrawal_in_transit, internal_withdrawal_complete, internal_withdrawal_in_transit_reversal, card_load_transfer, card_load_deposit, card_unload_transfer, card_unload_deposit, external_card_load_deposit, external_card_load_offset, card_spend_authorization, card_spend_authorization_hold, card_spend_capture, card_spend_capture_offset, card_spend_authorization_void, card_spend_authorization_void_release, card_spend_refund, card_spend_refund_offset, cashback, cashback_expense, cashback_funding, card_interchange_receivable, card_interchange, account_settlement, currency_conversion_outgoing, currency_conversion_incoming, balance_reservation, balance_reservation_hold, balance_reservation_reversal, balance_reservation_release, bad_debt_offset, bad_debt_expense, platform_credits_payment, platform_credits_payment_refund, platform_credits_granted, platform_balance_transfer_outgoing, platform_balance_transfer_incoming, internal_balance_transfer_outgoing, internal_balance_transfer_incoming, platform_balance_transfer_fee, connected_account_clawback, connected_account_negative_balance, ad_publisher_payout, ad_publisher_payout_received, company_referral, platform_affiliate_payment, platform_affiliate_payment_reversal, onboarding_reward, partner_grant_reward, payment_revshare, payment_revshare_payout, payment_revshare_reversal, payment_revshare_refund, payment_referral, payment_referral_payable, payment_referral_reversal, payment_referral_refund, application_fee_payable, application_fee_payout, platform_earning, airdrop, airdrop_reversal, airdrop_expense, airdrop_expense_reversal, airdrop_link_funded, airdrop_link_canceled, airdrop_link_returned, airdrop_link_claimed, airdrop_link_redeemed, airdrop_link_created, resolution_center_refund, ad_funding_disbursement, ad_campaign_budget, ads_card_spread, ad_spend_charge, ad_network_cost, ad_spend_margin, ad_income_expense, ad_income_receipt, ad_budget_release, ad_network_settlement, ad_affiliate_payout, ad_affiliate_payout_received, ad_balance_funding_receipt, misc_reversal, fx_gain_loss, fx_markup, legacy_crypto_payment, legacy_payment, legacy_payment_refund, license_sale, license_sale_commission, license_sale_revenue, software_rental_revshare, software_rental_transaction, misc_purchase, misc_refund, referral_bonus, promo_reversal, payment_receivable_settlement, platform_earning_settlement, platform_earning_unreconciled_clearing, payment_receivable_clearing, payment_receivable_reversal, payment_unreconciled_clearing, payment_unreconciled_reversal, settlement_shortfall_loss, fx_settlement_gain_loss, settlement_rounding_variance, psp_payout_settlement, psp_payout_deposit, psp_payout_receivable, psp_payout_receivable_clearing, payout_unreconciled_clearing, psp_currency_conversion_outgoing, psp_currency_conversion_incoming, psp_currency_conversion_receivable, psp_currency_conversion_receivable_clearing, psp_fx_adjustment, refund_settlement, refund_settlement_reversal, refund_payable_clearing, refund_payable_reversal, refund_unreconciled_clearing, refund_unreconciled_reversal, psp_account_debit, payment_refund_fee, dispute_settlement, dispute_settlement_reversal, dispute_payable_clearing, dispute_payable_reversal, dispute_unreconciled_clearing, dispute_unreconciled_reversal, psp_reserve_hold, psp_reserve_release, psp_dispute_fee, psp_dispute_alert_fee, psp_refund_fee, psp_account_updater_fee, psp_adjusted_processing_fee, psp_authentication_fee, psp_commission_fee, psp_fixed_fee, psp_gateway_fee, psp_interchange_fee, psp_invoice_tax_fee, psp_markup_fee, psp_network_token_fee, psp_optimization_fee, psp_payment_method_fee, psp_payout_fee, psp_processing_fee, psp_risk_fee, psp_scheme_fee, psp_variable_fee, psp_billing_fee, psp_tax_service_fee, psp_connect_fee, external_account_connection_fee, psp_external_account_connection_fee, psp_invoicing_fee, psp_terminal_fee, treasury_fee, psp_treasury_fee, accelerated_settlement_fee, psp_accelerated_settlement_fee, psp_receivable_pooled, psp_pool_settlement, psp_pool_clearing, psp_pool_refund_settlement, psp_pool_refund_clearing, psp_correction, psp_payin_settlement, psp_payin_clearing, psp_bank_pull_settlement, psp_bank_pull_clearing, psp_pool_dispute_settlement, psp_payout_consolidation, psp_withholding_tax, psp_payout_settlement_reversal, psp_transfer_settlement, psp_transfer_settlement_reversal, psp_collection_settlement, payout_subsidy, withdrawal_topup_adjustment, withdrawal_payable_clearing, withdrawal_payable_clearing_reversal, identity_verification_fee, psp_identity_verification_fee, tax_filing_fee, psp_tax_filing_fee, psp_service_fee, recipient_wallet_load, psp_recipient_wallet_load, dispute_management_fee, psp_dispute_management_fee, psp_clawback_settlement, psp_clawback_settlement_reversal, clawback_receivable_settlement, clawback_receivable_settlement_reversal, clawback_fee, psp_clawback_fee, bank_transfer, deposit, wallet_transfer_incoming, wallet_transfer_outgoing, swap_source, swap_target
string
required
payment | null
Payment related to this ledger activity. Included when rich resource hydration is enabled and the movement is tied to a payment.

Properties

string
required
Payment ID, prefixed pay_.
object | null
required
Total charged by the payment.

Properties

string
required
The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.
string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
integer
required
How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.
string | null
required
Card brand, when the customer paid by card.
string | null
required
Last four digits of the card, when the customer paid by card.
string
required
When the payment was created.
string
required
string | null
required
How the customer paid, such as card or paypal.
string | null
required
Processor that handled the payment, such as stripe.
object | null
required
Variant associated with the payment, when applicable.

Properties

string
required
Variant ID, prefixed plan_.
string | null
required
Variant name.
object | null
required
Product associated with the payment, when applicable.

Properties

string
required
Product ID, prefixed prod_.
string
required
Product name.
object | null
required
Customer associated with the payment. Email requires member:email:read.

Properties

string
required
Customer ID, prefixed user_.
string | null
required
Customer email, or null without member:email:read.
string
required
Customer display name.
string | null
Payment ID for any payment-related activity, including refunds and disputes.
string | null
ID of the variant associated with the payment, when applicable.
string | null
Name of the variant associated with the payment, when applicable.
string
required
When the activity posted to the ledger.
string | null
ID of the product associated with the payment, when applicable.
string | null
Name of the product associated with the payment, when applicable.
account or user or bounty or ledger_account or payment_method or payout_method or card_transaction | null
required
Resource associated with this ledger activity.
object | null
required
Source of this ledger activity. Platform markup fees use object platform_fee and the ledger activity ID.

Properties

string
required
number | null
Payout amount as a decimal number in the destination currency (payout sources only; requires payout:withdrawal:read).
string | null
Card brand used by the payment source.
string | null
Chain the deposit landed on, for example plasma (onchain_transaction sources only).
string | null
The airdrop’s claim URL. Null unless the caller can manage claim links on the funding company or withdraw from the funding personal balance.
string | null
Payout creation time as an ISO 8601 timestamp (payout sources only; requires payout:withdrawal:read).
object | null
User who requested the withdrawal. Null for system-generated withdrawals or without payout:withdrawal:read.

Properties

string
required
User ID, prefixed user_.
string | null
required
Display name.
object
required
Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Properties

string
required
Avatar image URL. Always present — a generated placeholder when the user set no picture.
string
required
Public username.
string | null
Estimated arrival as an ISO 8601 timestamp (payout sources only; requires payout:withdrawal:read).
object | null
Total withdrawal fees, including markup fees. Requires payout:withdrawal:read.

Properties

string
required
The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.
string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
integer
required
How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.
string | null
Action that generated a platform markup fee: deposit, swap, transfer, card_spend, or payout. Present for platform_markup_fee and platform_markup_fee_payout, including when include_resource is false. Null when the originating action is unavailable; omitted on other source types.Available options: payout, transfer, deposit, swap, card_spend
string | null
Whether withdrawal fees are inclusive or exclusive. Requires payout:withdrawal:read.Available options: exclusive, inclusive
string | null
Amount converted out of from_currency as a decimal string (swap sources only).
string | null
Lowercase currency code converted from (swap sources only).
string | null
Memo attached to the transfer or payout source, or null when none was provided (on payout sources requires payout:withdrawal:read).
string
required
string | null
Name of the entity processing the payout (payout sources only; requires payout:withdrawal:read).
object | null
Total charged by the payment source.

Properties

string
required
The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.
string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
integer
required
How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.
string | null
Payment method used by the payment source.
string | null
Processor used by the payment source.
object | null
Withdrawal principal sent to the destination, excluding fees, in the withdrawal currency. Requires payout:withdrawal:read.

Properties

string
required
The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.
string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
integer
required
How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.
object | null
Payout destination display info (payout sources only).

Properties

string | null
string | null
string | null
Saved payout destination nickname (payout sources only).
string | null
Why the activity happened. On transfer sources this is the transfer reason, for example pool_top_up or bounty_return. On payout sources it explains why the payout was canceled, denied, or failed (requires payout:withdrawal:read); null while the payout is progressing normally.
boolean | null
Whether this payout is currently held for manual risk review (payout sources only; requires payout:withdrawal:read).
string | null
Sender wallet address or onramp provider identifier (onchain_transaction sources only).
string | null
Lifecycle status. On payout sources this is the payout 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).
string | null
Amount received in to_currency as a decimal string (swap sources only).
string | null
Lowercase currency code converted to (swap sources only).
string | null
Bank trace reference for the withdrawal. Requires payout:withdrawal:read.
string | null
On-chain transaction hash (onchain_transaction and swap sources only).
string | null
required
Dollar value of this movement as a decimal string, signed like amount. Converted from the posted amount at the rate that was live when the line posted — the same pricing the wallet balance chart and the financial reports use — so a crypto row carries its dollar value too. null for a currency Whop holds no exchange rate for.
string | null
Email of the customer associated with the payment. Requires member:email:read.
string | null
ID of the customer associated with the payment.
string | null
Display name of the customer associated with the payment.
LedgerActivity

Glossary of line types

Every activity row carries a line_type that names the financial event it represents. Pass one or more line_types to List Financial Activity to filter the feed to specific events — either as repeated line_types[] parameters or as a single comma-separated value (line_types=payment_gross,payment_refund). Unknown line types return a 400. The term Local Payment Method (LPM) means a non-card method, including bank debits, bank transfers, and wallets.

Categories

In place of listing individual line types, you can pass a category shorthand. A category expands to every line type it contains.

Payments

Refunds

Disputes

Reserves

Payouts

Transfers

Currency conversion

Affiliates & revenue share

Airdrops

Advertising

On-chain assets and cards

onchain_deposit is opt-in: it is excluded from the default feed and only returned when you request it explicitly in line_types.

Legacy & miscellaneous

Fees