This page documents
@whop/elements@1.9.0 and @whop/elements-react@1.9.0.v1.0.0.
Mounts inside
Wallet. accountId and accessToken come from there. Pass props and callbacks through the create options or React props. Keep the created handle, or React ref, to call refresh() and setDateRange().Mounts anywhere in your view hierarchy. Takes an
accountId and loads its own data; pass a closure too and you get the row the viewer tapped.import { WhopElements, Wallet, ActivityElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";
function Example() {
return (
<WhopElements elements={loadWhop()}>
<Wallet /* options */>
<ActivityElement onActivitySelected={(e) => console.log(e)} onActivityHovered={(e) => console.log(e)} onSeeAllRequested={(e) => console.log(e)} onDateRangeChanged={(e) => console.log(e)} />
</Wallet>
</WhopElements>
);
}
<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
const wallet = window.WhopElements().wallet.create({ /* options */ });
wallet.create('activity', {
onActivitySelected: (e) => console.log(e),
onActivityHovered: (e) => console.log(e),
onSeeAllRequested: (e) => console.log(e),
onDateRangeChanged: (e) => console.log(e)
}).mount('#wallet-activity');
</script>
import SwiftUI
import WhopElements
// WhopSDK.configure(tokenProvider:) runs once at app launch. See Getting started.
struct ActivityScreen: View {
var body: some View {
ScrollView {
ActivityElement(
accountId: "biz_xxxx"
) { activity in
print(activity.title, activity.amount)
}
.padding()
}
}
}
Example data. Open the Playground.
Props
string
Only show activity for this currency. Without it, activity from every currency is shown.
string
A scoped token for the read. An account needs
company:balance:read, and a user needs user:balance:read. Mint it on your server with POST /api/v1/access_tokens. Without it the read uses the viewer’s own session, which only works same-origin.number
Show at most this many rows and stop paging, for a preview of recent activity. The list gains a See all activity control that reports
seeAllRequested instead of navigating.boolean
When off, card transaction rows render inert (no click, no hover) instead of firing
activitySelected. Use it when you know the viewer isn’t allowed to see those details. Defaults to true.string[]
Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters. Defaults to
[].Show values
Show values
Each item is one of
"platform_balance_transfer_outgoing", "payment_gross", "withdrawal", "topup", "payment_dispute", "payment_revshare", "card_spend_authorization", "airdrop", "onchain_swap_target", "cashback", "ad_affiliate_payout_received", "ad_budget_release", "ad_campaign_budget", "ad_publisher_payout", "ad_publisher_payout_received", "ad_spend_charge", "affiliate_fee", "airdrop_link_created", "airdrop_link_redeemed", "airdrop_link_returned", "airdrop_reversal", "application_fee", "application_fee_payout", "bank_transfer", "billing_percentage_fee", "buyer_fee", "card_spend_authorization_void", "card_spend_refund", "cross_border_percentage_fee", "currency_conversion_incoming", "currency_conversion_outgoing", "dispute_alert_fee", "dispute_hold_adjustment", "economic_intelligence_percentage_fee", "fraud_prevention_fee", "fx_percentage_fee", "high_risk_merchant_fee", "internal_balance_transfer_incoming", "internal_balance_transfer_outgoing", "misc_reversal", "onboarding_reward", "onchain_deposit", "onchain_wallet_transfer_incoming", "onchain_wallet_transfer_outgoing", "orchestration_percentage_fee", "partner_grant_reward", "passthrough_gmv", "payment_dispute_adjustment", "payment_dispute_fee", "payment_dispute_reversal", "payment_gross_reversal", "payment_processing_fixed_fee", "payment_processing_percentage_fee", "payment_referral", "payment_referral_reversal", "payment_refund", "payment_refund_reversal", "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_incoming", "platform_covered_dispute", "platform_credits_granted", "platform_credits_payment", "platform_credits_payment_refund", "platform_markup_fee", "platform_markup_fee_payout", "promo_reversal", "resolution_center_refund", "revshare_percentage_fee", "sales_tax_fee", "sales_tax_remittance", "sales_tax_remittance_reversal", "stripe_domestic_processing_fee", "stripe_international_processing_fee", "three_ds_fixed_fee", "topup_reversal", "treasury_payin", "whop_processing_fee", "withdrawal_clawback", "withdrawal_clawback_reversal", "withdrawal_reclassification", or "withdrawal_reversal".boolean
Hide the filter chips, for a compact list that the viewer does not filter. Defaults to
false.Events
Pass callbacks in the create options or React props.onActivitySelected
A row was clicked. Open your own detail view or route for it; the element never navigates.object
Hide properties
Hide properties
LedgerActivity
required
Show properties
Show properties
"ledger_activity"
required
string
required
Ledger activity ID.
string
required
The ledger line category this activity was posted under.
Show values
Show values
One of
"platform_balance_transfer_outgoing", "payment_gross", "withdrawal", "topup", "payment_dispute", "payment_revshare", "card_spend_authorization", "airdrop", "onchain_swap_target", "cashback", "account_settlement", "ad_affiliate_payout_received", "ad_budget_release", "ad_campaign_budget", "ad_publisher_payout", "ad_publisher_payout_received", "ad_spend_charge", "affiliate_fee", "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_void", "card_spend_refund", "card_unload_deposit", "card_unload_transfer", "cashback_funding", "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", "economic_intelligence_percentage_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_wallet_transfer_incoming", "onchain_wallet_transfer_outgoing", "onchain_withdrawal", "orchestration_percentage_fee", "partner_grant_reward", "passthrough_gmv", "payment_dispute_adjustment", "payment_dispute_fee", "payment_dispute_reversal", "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_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_covered_dispute", "platform_credits_granted", "platform_credits_payment", "platform_credits_payment_refund", "platform_earning", "platform_markup_fee", "platform_markup_fee_payout", "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_fee", "topup_reversal", "treasury_payin", "whop_processing_fee", "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", "psp_payment_receivable", "ad_spend_purchase", "psp_refund_payable", "passthrough_gmv_offset", "aggregated_fee", "sales_tax_collected", "sales_tax_collected_reversal", "sales_tax_remitted", "dispute_hold_blocked", "psp_dispute_payable", "withdrawal_payable", "withdrawal_payable_reversal", "payout_receivable", "clawback_receivable", "clawback_receivable_reversal", "treasury_payin_receivable", "onchain_deposit_offset", "onchain_withdrawal_offset", "trading_account_withdrawal", "trading_account_withdrawal_offset", "trading_account_deposit", "trading_account_deposit_offset", "onchain_swap_offset", "whop_swap_fee_received", "internal_withdrawal_payable", "internal_withdrawal_payable_reversal", "external_card_load_offset", "card_spend_authorization_hold", "card_spend_capture", "card_spend_capture_offset", "card_spend_authorization_void_release", "card_spend_refund_offset", "cashback_expense", "card_interchange_receivable", "balance_reservation_hold", "balance_reservation_release", "bad_debt_offset", "bad_debt_expense", "connected_account_clawback", "payment_referral_payable", "application_fee_payable", "airdrop_expense", "airdrop_expense_reversal", "airdrop_link_funded", "airdrop_link_canceled", "airdrop_link_claimed", "ad_funding_disbursement", "ads_card_spread", "ad_network_cost", "ad_spend_margin", "ad_income_expense", "ad_income_receipt", "ad_network_settlement", "ad_affiliate_payout", "ad_balance_funding_receipt", "fx_gain_loss", "fx_markup", "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_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", "deposit", "wallet_transfer_incoming", "wallet_transfer_outgoing", "swap_source", or "swap_target".string
required
Signed amount in the currency’s smallest precision units.
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
required
When the activity posted to the ledger.
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 | null
required
Resource associated with this ledger activity.
Show shape 1
Show shape 1
Show shape 2
Show shape 2
Show shape 4
Show shape 4
Show shape 5
Show shape 5
"payment_method"
required
string
required
string | null
required
string | null
required
object | null
required
object | null
required
string | null
required
Show shape 6
Show shape 6
Show shape 7
Show shape 7
"card_transaction"
required
string
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
object | null
required
Source of this ledger activity. Platform markup fees use object platform_fee and the ledger activity ID.
Show properties
Show properties
string
required
string
required
string | null
One of
"transfer", "card_spend", "deposit", "swap", "payout", or null.string | null
Money | null
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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
string | null
string | null
string | null
string | null
boolean | null
string | null
number | null
Money | null
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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.Money | null
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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."exclusive" | "inclusive" | null
UserSummary | null
Show properties
Show properties
string
required
User ID, prefixed
user_.string
required
Public username.
string | null
required
Display name.
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
unknown
required
object | null
Payment related to this ledger activity. Included when rich resource hydration is enabled and the movement is tied to a payment.
Show properties
Show properties
"payment"
required
string
required
Money | null
required
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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
string | null
required
string | null
required
string | null
required
string
required
string | null
Payment ID for any payment-related activity, including refunds and disputes.
string | null
ID of the customer associated with the payment.
string | null
Display name of the customer associated with the payment.
string | null
Email of the customer associated with the payment. Requires member:email:read.
string | null
ID of the product associated with the payment, when applicable.
string | null
Name of the product associated with the payment, when applicable.
string | null
ID of the variant associated with the payment, when applicable.
string | null
Name of the variant associated with the payment, when applicable.
object
The viewer account that owns this row’s ledger. Present only when the response aggregates owned accounts (include_owned_accounts=true); omitted otherwise.
Show shape 1
Show shape 1
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.onActivityHovered
The pointer entered a row, or left one (null). Point something of your own at the same moment, like marking the row on a balance chart.object | null
Hide properties
Hide properties
LedgerActivity
required
Show properties
Show properties
"ledger_activity"
required
string
required
Ledger activity ID.
string
required
The ledger line category this activity was posted under.
Show values
Show values
One of
"platform_balance_transfer_outgoing", "payment_gross", "withdrawal", "topup", "payment_dispute", "payment_revshare", "card_spend_authorization", "airdrop", "onchain_swap_target", "cashback", "account_settlement", "ad_affiliate_payout_received", "ad_budget_release", "ad_campaign_budget", "ad_publisher_payout", "ad_publisher_payout_received", "ad_spend_charge", "affiliate_fee", "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_void", "card_spend_refund", "card_unload_deposit", "card_unload_transfer", "cashback_funding", "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", "economic_intelligence_percentage_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_wallet_transfer_incoming", "onchain_wallet_transfer_outgoing", "onchain_withdrawal", "orchestration_percentage_fee", "partner_grant_reward", "passthrough_gmv", "payment_dispute_adjustment", "payment_dispute_fee", "payment_dispute_reversal", "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_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_covered_dispute", "platform_credits_granted", "platform_credits_payment", "platform_credits_payment_refund", "platform_earning", "platform_markup_fee", "platform_markup_fee_payout", "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_fee", "topup_reversal", "treasury_payin", "whop_processing_fee", "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", "psp_payment_receivable", "ad_spend_purchase", "psp_refund_payable", "passthrough_gmv_offset", "aggregated_fee", "sales_tax_collected", "sales_tax_collected_reversal", "sales_tax_remitted", "dispute_hold_blocked", "psp_dispute_payable", "withdrawal_payable", "withdrawal_payable_reversal", "payout_receivable", "clawback_receivable", "clawback_receivable_reversal", "treasury_payin_receivable", "onchain_deposit_offset", "onchain_withdrawal_offset", "trading_account_withdrawal", "trading_account_withdrawal_offset", "trading_account_deposit", "trading_account_deposit_offset", "onchain_swap_offset", "whop_swap_fee_received", "internal_withdrawal_payable", "internal_withdrawal_payable_reversal", "external_card_load_offset", "card_spend_authorization_hold", "card_spend_capture", "card_spend_capture_offset", "card_spend_authorization_void_release", "card_spend_refund_offset", "cashback_expense", "card_interchange_receivable", "balance_reservation_hold", "balance_reservation_release", "bad_debt_offset", "bad_debt_expense", "connected_account_clawback", "payment_referral_payable", "application_fee_payable", "airdrop_expense", "airdrop_expense_reversal", "airdrop_link_funded", "airdrop_link_canceled", "airdrop_link_claimed", "ad_funding_disbursement", "ads_card_spread", "ad_network_cost", "ad_spend_margin", "ad_income_expense", "ad_income_receipt", "ad_network_settlement", "ad_affiliate_payout", "ad_balance_funding_receipt", "fx_gain_loss", "fx_markup", "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_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", "deposit", "wallet_transfer_incoming", "wallet_transfer_outgoing", "swap_source", or "swap_target".string
required
Signed amount in the currency’s smallest precision units.
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
required
When the activity posted to the ledger.
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 | null
required
Resource associated with this ledger activity.
Show shape 1
Show shape 1
Show shape 2
Show shape 2
Show shape 4
Show shape 4
Show shape 5
Show shape 5
"payment_method"
required
string
required
string | null
required
string | null
required
object | null
required
object | null
required
string | null
required
Show shape 6
Show shape 6
Show shape 7
Show shape 7
"card_transaction"
required
string
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
object | null
required
Source of this ledger activity. Platform markup fees use object platform_fee and the ledger activity ID.
Show properties
Show properties
string
required
string
required
string | null
One of
"transfer", "card_spend", "deposit", "swap", "payout", or null.string | null
Money | null
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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
string | null
string | null
string | null
string | null
boolean | null
string | null
number | null
Money | null
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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.Money | null
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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."exclusive" | "inclusive" | null
UserSummary | null
Show properties
Show properties
string
required
User ID, prefixed
user_.string
required
Public username.
string | null
required
Display name.
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
unknown
required
object | null
Payment related to this ledger activity. Included when rich resource hydration is enabled and the movement is tied to a payment.
Show properties
Show properties
"payment"
required
string
required
Money | null
required
Show properties
Show properties
string
required
Three-letter ISO 4217 currency code, lowercase.
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.number
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
number
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
string | null
required
string | null
required
string | null
required
string
required
string | null
Payment ID for any payment-related activity, including refunds and disputes.
string | null
ID of the customer associated with the payment.
string | null
Display name of the customer associated with the payment.
string | null
Email of the customer associated with the payment. Requires member:email:read.
string | null
ID of the product associated with the payment, when applicable.
string | null
Name of the product associated with the payment, when applicable.
string | null
ID of the variant associated with the payment, when applicable.
string | null
Name of the variant associated with the payment, when applicable.
object
The viewer account that owns this row’s ledger. Present only when the response aggregates owned accounts (include_owned_accounts=true); omitted otherwise.
Show shape 1
Show shape 1
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.onSeeAllRequested
The viewer pressed See all activity on a maxItems list. Open your own full activity screen; the element never navigates.onDateRangeChanged
The viewer changed the date filter through the filter chips rather than through setDateRange. Clear any range selection of your own, like a chart brush, that no longer matches.onLoaderStart
Runs after the loading skeleton first paints and before onReady.onReady
Runs after the element’s first complete paint.onError
Runs when the element fails to load or crashes. The fallback remains visible. Use code for programmatic handling. sourceKey identifies a failed host-state source.Methods
Call these on the handle returned bycreate, or through a React ref.refresh
Re-fetch the account’s activity from the first page. Call it after a mutation made elsewhere (a deposit, a send) so the list reflects it without waiting for the cache to expire.Returns Promise<void>setDateRange
Set the date filter from outside the element, for example wiring a chart brush selection into the list. Pass null to clear it.ParametersActivityDateRangeOverride | null
required
Promise<void>mount
Mounts the element in target and starts loading. React components mount themselves.Parametersstring | HTMLElement
required
destroy
Removes the element and releases its frame and subscriptions. You can call it more than once. React removes the element automatically.update
Merges new props into the mounted element. In React, change the component props instead.ParametersPartial<ActivityElementProps>
required
Styling
Style these parts throughappearance.classes. Use camel case or kebab case for property names and include units. Page stylesheets can’t reach the element’s frame. The framework validates each declaration before injecting it.| Class | Targets |
|---|---|
.whop-ActivityRow | One ledger activity row — its icon, title, timestamp, and amount |
.whop-ActivitySurface | The activity feed — title, filters, and up to every fetched row |
const wallet = whop.wallet.create({
appearance: {
classes: {
'whop-ActivityRow': { borderRadius: '8px', fontWeight: '600' },
'whop-ActivitySurface': { borderRadius: '8px', fontWeight: '600' }
}
}
});
wallet.update({
appearance: { classes: { 'whop-ActivityRow': { fontWeight: '700' } } }
});
appearance to <Wallet>. Set it globally with WhopElements({ appearance }).Parameters
String
required
Whose ledger to list. Use an account ID prefixed
biz_ or a user ID prefixed user_. Both work directly because the feed reads the ID without resolving a ledger first.Bool
Shows the built-in “Activity” heading. Defaults to
true. Turn it off when your screen already has one.((WalletActivity) -> Void)?
Called with the row the viewer tapped. The view never navigates, so route to your own detail screen.
WalletActivity
What a selection hands back:id: String: stable per rowtitle: String/subtitle: String: the row’s two linesamount: Decimal: signed, negative for money outcurrencyCode: StringpostedAt: DateisIncoming: Bool
States
Shows a skeleton list while the first page loads,No activity found when the ledger has no movements, and the failure message with a Try again button when the read fails. If a later page fails, the rows already loaded stay on screen and a Try again appears at the bottom.Good to know
- Give it a scroll container. The feed is a
LazyVStackand pages as its last row appears, so outside aScrollViewit renders page one and never loads another. - Takes
biz_…anduser_…tags directly, so unlike the other wallet views it never has to resolve a ledger first.
Call
WhopSDK.configure(tokenProvider:) once at launch. Views wait for the token. See Getting started. Apply a theme with .whopTheme(_:).
