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.
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 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
payouts, refunds, disputes and on-chain rows. The available_after/before
filters window on its UTC settlement date.
object
required
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:
ad_budget_release, ad_campaign_budget, ad_publisher_payout, ad_publisher_payout_received, ad_spend_charge, affiliate_fee, airdrop, airdrop_link_created, airdrop_link_redeemed, airdrop_link_returned, airdrop_reversal, application_fee, application_fee_payout, balance_reservation, balance_reservation_reversal, bank_transfer, billing_percentage_fee, buyer_fee, card_interchange, card_load_deposit, card_load_transfer, card_spend_authorization, card_spend_authorization_void, card_spend_refund, card_unload_deposit, card_unload_transfer, company_referral, connected_account_negative_balance, cross_border_percentage_fee, currency_conversion_incoming, currency_conversion_outgoing, dispute_alert_fee, dispute_hold_adjustment, dispute_representment_fee, external_card_load_deposit, fraud_prevention_fee, fx_percentage_fee, high_risk_merchant_fee, installment_default, internal_balance_transfer_incoming, internal_balance_transfer_outgoing, internal_withdrawal, internal_withdrawal_complete, internal_withdrawal_fee, internal_withdrawal_fee_reversal, internal_withdrawal_in_transit, internal_withdrawal_in_transit_reversal, internal_withdrawal_markup_fee, internal_withdrawal_markup_fee_payout, internal_withdrawal_markup_fee_payout_reversal, internal_withdrawal_markup_fee_reversal, internal_withdrawal_reversal, legacy_crypto_payment, legacy_payment, legacy_payment_refund, license_sale, license_sale_commission, license_sale_revenue, marketplace_affiliate_fee, misc_purchase, misc_refund, misc_reversal, onboarding_reward, onchain_deposit, onchain_swap_source, onchain_swap_target, onchain_wallet_transfer_incoming, onchain_wallet_transfer_outgoing, onchain_withdrawal, orchestration_percentage_fee, passthrough_gmv, payment_dispute, payment_dispute_adjustment, payment_dispute_fee, payment_dispute_reversal, payment_gross, payment_gross_reversal, payment_processing_fixed_fee, payment_processing_percentage_fee, payment_referral, payment_referral_refund, payment_referral_reversal, payment_refund, payment_refund_reversal, payment_revshare, payment_revshare_payout, payment_revshare_refund, payment_revshare_reversal, payout_fee, platform_affiliate_payment, platform_affiliate_payment_reversal, platform_balance_payment, platform_balance_payment_refund, platform_balance_transfer_fee, platform_balance_transfer_incoming, platform_balance_transfer_outgoing, platform_covered_dispute, platform_earning, promo_reversal, referral_bonus, resolution_center_refund, revshare_percentage_fee, sales_tax_fee, sales_tax_remittance, sales_tax_remittance_reversal, software_rental_revshare, software_rental_transaction, stripe_domestic_processing_fee, stripe_international_processing_fee, swap_fee, three_ds_fixed_fee, topup, topup_fee, topup_reversal, treasury_payin, whop_processing_fee, withdrawal, withdrawal_clawback, withdrawal_clawback_reversal, withdrawal_fee, withdrawal_fee_reversal, withdrawal_markup_fee, withdrawal_markup_fee_payout, withdrawal_markup_fee_payout_reversal, withdrawal_markup_fee_reversal, withdrawal_reclassification, withdrawal_reversal, withdrawal_topup_adjustment, deposit, wallet_transfer_incoming, wallet_transfer_outgoing, swap_source, swap_targetstring
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
Properties
string
required
Payment ID, prefixed
pay_.object | null
required
Total charged by the payment.
Properties
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
object | null
required
string | null
Payment ID for any payment-related activity, including refunds and disputes.
string | null
ID of the plan associated with the payment, when applicable.
string | null
Name of the plan 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.
Properties
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
Public claim URL for the airdrop link (airdrop_link sources only).
string | null
Payout creation time as an ISO 8601 timestamp (payout sources only; requires
payout:withdrawal:read).
string | null
Estimated arrival as an ISO 8601 timestamp (payout sources only; requires
payout:withdrawal:read).
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 source, or null when none was provided.
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
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
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
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 aline_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.
