import type * as Whop from "../index.js"; export interface LedgerActivity { /** The viewer account that owns this row's ledger. Present only when the response aggregates owned accounts (include_owned_accounts=true); omitted otherwise. */ account?: Whop.LedgerActivityAccount | undefined; /** Signed amount in the currency's smallest precision units. */ amount: string; /** 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. */ available_at: string | null; /** Currency for this ledger activity. */ currency: LedgerActivity.Currency; /** Ledger activity ID. */ id: string; /** 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. */ ledger_account_id?: (string | null) | undefined; /** The ledger line category this activity was posted under. */ line_type: LedgerActivity.LineType; object: LedgerActivity.Object_; /** Payment related to this ledger activity. Included when rich resource hydration is enabled and the movement is tied to a payment. */ payment?: (LedgerActivity.Payment | null) | undefined; /** Payment ID for any payment-related activity, including refunds and disputes. */ payment_id?: (string | null) | undefined; /** ID of the variant associated with the payment, when applicable. */ plan_id?: (string | null) | undefined; /** Name of the variant associated with the payment, when applicable. */ plan_name?: (string | null) | undefined; /** When the activity posted to the ledger. */ posted_at: string; /** ID of the product associated with the payment, when applicable. */ product_id?: (string | null) | undefined; /** Name of the product associated with the payment, when applicable. */ product_name?: (string | null) | undefined; /** Resource associated with this ledger activity. */ resource: LedgerActivity.Resource | null; /** Source of this ledger activity. Platform markup fees use object platform_fee and the ledger activity ID. */ source: LedgerActivity.Source | null; /** 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. */ usd_amount: string | null; /** Email of the customer associated with the payment. Requires member:email:read. */ user_email?: (string | null) | undefined; /** ID of the customer associated with the payment. */ user_id?: (string | null) | undefined; /** Display name of the customer associated with the payment. */ user_name?: (string | null) | undefined; } export declare namespace LedgerActivity { /** * Currency for this ledger activity. */ interface Currency { /** Currency code. */ code: string; /** Precision factor for the currency, for example `100000000` for USD. */ precision: string; } /** The ledger line category this activity was posted under. */ const LineType: { readonly PspPaymentReceivable: "psp_payment_receivable"; readonly PaymentGross: "payment_gross"; readonly Topup: "topup"; readonly TopupFee: "topup_fee"; readonly PaymentGrossReversal: "payment_gross_reversal"; readonly TopupReversal: "topup_reversal"; readonly PaymentRefund: "payment_refund"; readonly PaymentRefundReversal: "payment_refund_reversal"; readonly PlatformBalancePayment: "platform_balance_payment"; readonly PlatformBalancePaymentRefund: "platform_balance_payment_refund"; readonly AdSpendPurchase: "ad_spend_purchase"; readonly PspRefundPayable: "psp_refund_payable"; readonly PassthroughGmv: "passthrough_gmv"; readonly PassthroughGmvOffset: "passthrough_gmv_offset"; readonly InstallmentDefault: "installment_default"; readonly AggregatedFee: "aggregated_fee"; readonly PaymentProcessingFixedFee: "payment_processing_fixed_fee"; readonly PaymentProcessingPercentageFee: "payment_processing_percentage_fee"; readonly BillingPercentageFee: "billing_percentage_fee"; readonly CrossBorderPercentageFee: "cross_border_percentage_fee"; readonly FxPercentageFee: "fx_percentage_fee"; readonly OrchestrationPercentageFee: "orchestration_percentage_fee"; readonly RevsharePercentageFee: "revshare_percentage_fee"; readonly StripeDomesticProcessingFee: "stripe_domestic_processing_fee"; readonly StripeInternationalProcessingFee: "stripe_international_processing_fee"; readonly ThreeDsFixedFee: "three_ds_fixed_fee"; readonly WhopProcessingFee: "whop_processing_fee"; readonly EconomicIntelligencePercentageFee: "economic_intelligence_percentage_fee"; readonly HighRiskMerchantFee: "high_risk_merchant_fee"; readonly FraudPreventionFee: "fraud_prevention_fee"; readonly BuyerFee: "buyer_fee"; readonly SalesTaxFee: "sales_tax_fee"; readonly PayoutFee: "payout_fee"; readonly AffiliateFee: "affiliate_fee"; readonly MarketplaceAffiliateFee: "marketplace_affiliate_fee"; readonly ApplicationFee: "application_fee"; readonly PlatformMarkupFee: "platform_markup_fee"; readonly PlatformMarkupFeePayout: "platform_markup_fee_payout"; readonly SalesTaxRemittance: "sales_tax_remittance"; readonly SalesTaxRemittanceReversal: "sales_tax_remittance_reversal"; readonly SalesTaxCollected: "sales_tax_collected"; readonly SalesTaxCollectedReversal: "sales_tax_collected_reversal"; readonly SalesTaxRemitted: "sales_tax_remitted"; readonly PaymentDispute: "payment_dispute"; readonly PaymentDisputeAdjustment: "payment_dispute_adjustment"; readonly PaymentDisputeFee: "payment_dispute_fee"; readonly PaymentDisputeReversal: "payment_dispute_reversal"; readonly PlatformCoveredDispute: "platform_covered_dispute"; readonly DisputeAlertFee: "dispute_alert_fee"; readonly DisputeRepresentmentFee: "dispute_representment_fee"; readonly PaymentReturnFee: "payment_return_fee"; readonly DisputeHoldAdjustment: "dispute_hold_adjustment"; readonly DisputeHoldBlocked: "dispute_hold_blocked"; readonly PspDisputePayable: "psp_dispute_payable"; readonly Withdrawal: "withdrawal"; readonly WithdrawalPayable: "withdrawal_payable"; readonly WithdrawalPayableReversal: "withdrawal_payable_reversal"; readonly WithdrawalFee: "withdrawal_fee"; readonly WithdrawalFeeReversal: "withdrawal_fee_reversal"; readonly WithdrawalMarkupFee: "withdrawal_markup_fee"; readonly WithdrawalMarkupFeeReversal: "withdrawal_markup_fee_reversal"; readonly WithdrawalMarkupFeePayout: "withdrawal_markup_fee_payout"; readonly WithdrawalMarkupFeePayoutReversal: "withdrawal_markup_fee_payout_reversal"; readonly WithdrawalReversal: "withdrawal_reversal"; readonly WithdrawalClawback: "withdrawal_clawback"; readonly WithdrawalClawbackReversal: "withdrawal_clawback_reversal"; readonly PayoutReceivable: "payout_receivable"; readonly WithdrawalReclassification: "withdrawal_reclassification"; readonly ClawbackReceivable: "clawback_receivable"; readonly ClawbackReceivableReversal: "clawback_receivable_reversal"; readonly TreasuryPayin: "treasury_payin"; readonly TreasuryPayinReceivable: "treasury_payin_receivable"; readonly OnchainDeposit: "onchain_deposit"; readonly OnchainDepositOffset: "onchain_deposit_offset"; readonly OnchainWithdrawal: "onchain_withdrawal"; readonly OnchainWithdrawalOffset: "onchain_withdrawal_offset"; readonly TradingAccountWithdrawal: "trading_account_withdrawal"; readonly TradingAccountWithdrawalOffset: "trading_account_withdrawal_offset"; readonly TradingAccountDeposit: "trading_account_deposit"; readonly TradingAccountDepositOffset: "trading_account_deposit_offset"; readonly OnchainWalletTransferOutgoing: "onchain_wallet_transfer_outgoing"; readonly OnchainWalletTransferIncoming: "onchain_wallet_transfer_incoming"; readonly OnchainPlatformTransferOutgoing: "onchain_platform_transfer_outgoing"; readonly OnchainPlatformTransferIncoming: "onchain_platform_transfer_incoming"; readonly OnchainInternalTransferOutgoing: "onchain_internal_transfer_outgoing"; readonly OnchainInternalTransferIncoming: "onchain_internal_transfer_incoming"; readonly OnchainSwapSource: "onchain_swap_source"; readonly OnchainSwapTarget: "onchain_swap_target"; readonly OnchainSwapOffset: "onchain_swap_offset"; readonly WhopSwapFeeReceived: "whop_swap_fee_received"; readonly SwapFee: "swap_fee"; readonly InternalWithdrawal: "internal_withdrawal"; readonly InternalWithdrawalReversal: "internal_withdrawal_reversal"; readonly InternalWithdrawalPayable: "internal_withdrawal_payable"; readonly InternalWithdrawalPayableReversal: "internal_withdrawal_payable_reversal"; readonly InternalWithdrawalFee: "internal_withdrawal_fee"; readonly InternalWithdrawalFeeReversal: "internal_withdrawal_fee_reversal"; readonly InternalWithdrawalMarkupFee: "internal_withdrawal_markup_fee"; readonly InternalWithdrawalMarkupFeeReversal: "internal_withdrawal_markup_fee_reversal"; readonly InternalWithdrawalMarkupFeePayout: "internal_withdrawal_markup_fee_payout"; readonly InternalWithdrawalMarkupFeePayoutReversal: "internal_withdrawal_markup_fee_payout_reversal"; readonly InternalWithdrawalInTransit: "internal_withdrawal_in_transit"; readonly InternalWithdrawalComplete: "internal_withdrawal_complete"; readonly InternalWithdrawalInTransitReversal: "internal_withdrawal_in_transit_reversal"; readonly CardLoadTransfer: "card_load_transfer"; readonly CardLoadDeposit: "card_load_deposit"; readonly CardUnloadTransfer: "card_unload_transfer"; readonly CardUnloadDeposit: "card_unload_deposit"; readonly ExternalCardLoadDeposit: "external_card_load_deposit"; readonly ExternalCardLoadOffset: "external_card_load_offset"; readonly CardSpendAuthorization: "card_spend_authorization"; readonly CardSpendAuthorizationHold: "card_spend_authorization_hold"; readonly CardSpendCapture: "card_spend_capture"; readonly CardSpendCaptureOffset: "card_spend_capture_offset"; readonly CardSpendAuthorizationVoid: "card_spend_authorization_void"; readonly CardSpendAuthorizationVoidRelease: "card_spend_authorization_void_release"; readonly CardSpendRefund: "card_spend_refund"; readonly CardSpendRefundOffset: "card_spend_refund_offset"; readonly Cashback: "cashback"; readonly CashbackExpense: "cashback_expense"; readonly CashbackFunding: "cashback_funding"; readonly CardInterchangeReceivable: "card_interchange_receivable"; readonly CardInterchange: "card_interchange"; readonly AccountSettlement: "account_settlement"; readonly CurrencyConversionOutgoing: "currency_conversion_outgoing"; readonly CurrencyConversionIncoming: "currency_conversion_incoming"; readonly BalanceReservation: "balance_reservation"; readonly BalanceReservationHold: "balance_reservation_hold"; readonly BalanceReservationReversal: "balance_reservation_reversal"; readonly BalanceReservationRelease: "balance_reservation_release"; readonly BadDebtOffset: "bad_debt_offset"; readonly BadDebtExpense: "bad_debt_expense"; readonly PlatformCreditsPayment: "platform_credits_payment"; readonly PlatformCreditsPaymentRefund: "platform_credits_payment_refund"; readonly PlatformCreditsGranted: "platform_credits_granted"; readonly PlatformBalanceTransferOutgoing: "platform_balance_transfer_outgoing"; readonly PlatformBalanceTransferIncoming: "platform_balance_transfer_incoming"; readonly InternalBalanceTransferOutgoing: "internal_balance_transfer_outgoing"; readonly InternalBalanceTransferIncoming: "internal_balance_transfer_incoming"; readonly PlatformBalanceTransferFee: "platform_balance_transfer_fee"; readonly ConnectedAccountClawback: "connected_account_clawback"; readonly ConnectedAccountNegativeBalance: "connected_account_negative_balance"; readonly AdPublisherPayout: "ad_publisher_payout"; readonly AdPublisherPayoutReceived: "ad_publisher_payout_received"; readonly CompanyReferral: "company_referral"; readonly PlatformAffiliatePayment: "platform_affiliate_payment"; readonly PlatformAffiliatePaymentReversal: "platform_affiliate_payment_reversal"; readonly OnboardingReward: "onboarding_reward"; readonly PartnerGrantReward: "partner_grant_reward"; readonly PaymentRevshare: "payment_revshare"; readonly PaymentRevsharePayout: "payment_revshare_payout"; readonly PaymentRevshareReversal: "payment_revshare_reversal"; readonly PaymentRevshareRefund: "payment_revshare_refund"; readonly PaymentReferral: "payment_referral"; readonly PaymentReferralPayable: "payment_referral_payable"; readonly PaymentReferralReversal: "payment_referral_reversal"; readonly PaymentReferralRefund: "payment_referral_refund"; readonly ApplicationFeePayable: "application_fee_payable"; readonly ApplicationFeePayout: "application_fee_payout"; readonly PlatformEarning: "platform_earning"; readonly Airdrop: "airdrop"; readonly AirdropReversal: "airdrop_reversal"; readonly AirdropExpense: "airdrop_expense"; readonly AirdropExpenseReversal: "airdrop_expense_reversal"; readonly AirdropLinkFunded: "airdrop_link_funded"; readonly AirdropLinkCanceled: "airdrop_link_canceled"; readonly AirdropLinkReturned: "airdrop_link_returned"; readonly AirdropLinkClaimed: "airdrop_link_claimed"; readonly AirdropLinkRedeemed: "airdrop_link_redeemed"; readonly AirdropLinkCreated: "airdrop_link_created"; readonly ResolutionCenterRefund: "resolution_center_refund"; readonly AdFundingDisbursement: "ad_funding_disbursement"; readonly AdCampaignBudget: "ad_campaign_budget"; readonly AdsCardSpread: "ads_card_spread"; readonly AdSpendCharge: "ad_spend_charge"; readonly AdNetworkCost: "ad_network_cost"; readonly AdSpendMargin: "ad_spend_margin"; readonly AdIncomeExpense: "ad_income_expense"; readonly AdIncomeReceipt: "ad_income_receipt"; readonly AdBudgetRelease: "ad_budget_release"; readonly AdNetworkSettlement: "ad_network_settlement"; readonly AdAffiliatePayout: "ad_affiliate_payout"; readonly AdAffiliatePayoutReceived: "ad_affiliate_payout_received"; readonly AdBalanceFundingReceipt: "ad_balance_funding_receipt"; readonly MiscReversal: "misc_reversal"; readonly FxGainLoss: "fx_gain_loss"; readonly FxMarkup: "fx_markup"; readonly LegacyCryptoPayment: "legacy_crypto_payment"; readonly LegacyPayment: "legacy_payment"; readonly LegacyPaymentRefund: "legacy_payment_refund"; readonly LicenseSale: "license_sale"; readonly LicenseSaleCommission: "license_sale_commission"; readonly LicenseSaleRevenue: "license_sale_revenue"; readonly SoftwareRentalRevshare: "software_rental_revshare"; readonly SoftwareRentalTransaction: "software_rental_transaction"; readonly MiscPurchase: "misc_purchase"; readonly MiscRefund: "misc_refund"; readonly ReferralBonus: "referral_bonus"; readonly PromoReversal: "promo_reversal"; readonly PaymentReceivableSettlement: "payment_receivable_settlement"; readonly PlatformEarningSettlement: "platform_earning_settlement"; readonly PlatformEarningUnreconciledClearing: "platform_earning_unreconciled_clearing"; readonly PaymentReceivableClearing: "payment_receivable_clearing"; readonly PaymentReceivableReversal: "payment_receivable_reversal"; readonly PaymentUnreconciledClearing: "payment_unreconciled_clearing"; readonly PaymentUnreconciledReversal: "payment_unreconciled_reversal"; readonly SettlementShortfallLoss: "settlement_shortfall_loss"; readonly FxSettlementGainLoss: "fx_settlement_gain_loss"; readonly SettlementRoundingVariance: "settlement_rounding_variance"; readonly PspPayoutSettlement: "psp_payout_settlement"; readonly PspPayoutDeposit: "psp_payout_deposit"; readonly PspPayoutReceivable: "psp_payout_receivable"; readonly PspPayoutReceivableClearing: "psp_payout_receivable_clearing"; readonly PayoutUnreconciledClearing: "payout_unreconciled_clearing"; readonly PspCurrencyConversionOutgoing: "psp_currency_conversion_outgoing"; readonly PspCurrencyConversionIncoming: "psp_currency_conversion_incoming"; readonly PspCurrencyConversionReceivable: "psp_currency_conversion_receivable"; readonly PspCurrencyConversionReceivableClearing: "psp_currency_conversion_receivable_clearing"; readonly PspFxAdjustment: "psp_fx_adjustment"; readonly RefundSettlement: "refund_settlement"; readonly RefundSettlementReversal: "refund_settlement_reversal"; readonly RefundPayableClearing: "refund_payable_clearing"; readonly RefundPayableReversal: "refund_payable_reversal"; readonly RefundUnreconciledClearing: "refund_unreconciled_clearing"; readonly RefundUnreconciledReversal: "refund_unreconciled_reversal"; readonly PspAccountDebit: "psp_account_debit"; readonly PaymentRefundFee: "payment_refund_fee"; readonly DisputeSettlement: "dispute_settlement"; readonly DisputeSettlementReversal: "dispute_settlement_reversal"; readonly DisputePayableClearing: "dispute_payable_clearing"; readonly DisputePayableReversal: "dispute_payable_reversal"; readonly DisputeUnreconciledClearing: "dispute_unreconciled_clearing"; readonly DisputeUnreconciledReversal: "dispute_unreconciled_reversal"; readonly PspReserveHold: "psp_reserve_hold"; readonly PspReserveRelease: "psp_reserve_release"; readonly PspDisputeFee: "psp_dispute_fee"; readonly PspDisputeAlertFee: "psp_dispute_alert_fee"; readonly PspRefundFee: "psp_refund_fee"; readonly PspAccountUpdaterFee: "psp_account_updater_fee"; readonly PspAdjustedProcessingFee: "psp_adjusted_processing_fee"; readonly PspAuthenticationFee: "psp_authentication_fee"; readonly PspCommissionFee: "psp_commission_fee"; readonly PspFixedFee: "psp_fixed_fee"; readonly PspGatewayFee: "psp_gateway_fee"; readonly PspInterchangeFee: "psp_interchange_fee"; readonly PspInvoiceTaxFee: "psp_invoice_tax_fee"; readonly PspMarkupFee: "psp_markup_fee"; readonly PspNetworkTokenFee: "psp_network_token_fee"; readonly PspOptimizationFee: "psp_optimization_fee"; readonly PspPaymentMethodFee: "psp_payment_method_fee"; readonly PspPayoutFee: "psp_payout_fee"; readonly PspProcessingFee: "psp_processing_fee"; readonly PspRiskFee: "psp_risk_fee"; readonly PspSchemeFee: "psp_scheme_fee"; readonly PspVariableFee: "psp_variable_fee"; readonly PspBillingFee: "psp_billing_fee"; readonly PspTaxServiceFee: "psp_tax_service_fee"; readonly PspConnectFee: "psp_connect_fee"; readonly ExternalAccountConnectionFee: "external_account_connection_fee"; readonly PspExternalAccountConnectionFee: "psp_external_account_connection_fee"; readonly PspInvoicingFee: "psp_invoicing_fee"; readonly PspTerminalFee: "psp_terminal_fee"; readonly TreasuryFee: "treasury_fee"; readonly PspTreasuryFee: "psp_treasury_fee"; readonly AcceleratedSettlementFee: "accelerated_settlement_fee"; readonly PspAcceleratedSettlementFee: "psp_accelerated_settlement_fee"; readonly PspReceivablePooled: "psp_receivable_pooled"; readonly PspPoolSettlement: "psp_pool_settlement"; readonly PspPoolClearing: "psp_pool_clearing"; readonly PspPoolRefundSettlement: "psp_pool_refund_settlement"; readonly PspPoolRefundClearing: "psp_pool_refund_clearing"; readonly PspCorrection: "psp_correction"; readonly PspPayinSettlement: "psp_payin_settlement"; readonly PspPayinClearing: "psp_payin_clearing"; readonly PspBankPullSettlement: "psp_bank_pull_settlement"; readonly PspBankPullClearing: "psp_bank_pull_clearing"; readonly PspPoolDisputeSettlement: "psp_pool_dispute_settlement"; readonly PspPayoutConsolidation: "psp_payout_consolidation"; readonly PspWithholdingTax: "psp_withholding_tax"; readonly PspPayoutSettlementReversal: "psp_payout_settlement_reversal"; readonly PspTransferSettlement: "psp_transfer_settlement"; readonly PspTransferSettlementReversal: "psp_transfer_settlement_reversal"; readonly PspCollectionSettlement: "psp_collection_settlement"; readonly PayoutSubsidy: "payout_subsidy"; readonly WithdrawalTopupAdjustment: "withdrawal_topup_adjustment"; readonly WithdrawalPayableClearing: "withdrawal_payable_clearing"; readonly WithdrawalPayableClearingReversal: "withdrawal_payable_clearing_reversal"; readonly IdentityVerificationFee: "identity_verification_fee"; readonly PspIdentityVerificationFee: "psp_identity_verification_fee"; readonly TaxFilingFee: "tax_filing_fee"; readonly PspTaxFilingFee: "psp_tax_filing_fee"; readonly PspServiceFee: "psp_service_fee"; readonly RecipientWalletLoad: "recipient_wallet_load"; readonly PspRecipientWalletLoad: "psp_recipient_wallet_load"; readonly DisputeManagementFee: "dispute_management_fee"; readonly PspDisputeManagementFee: "psp_dispute_management_fee"; readonly PspClawbackSettlement: "psp_clawback_settlement"; readonly PspClawbackSettlementReversal: "psp_clawback_settlement_reversal"; readonly ClawbackReceivableSettlement: "clawback_receivable_settlement"; readonly ClawbackReceivableSettlementReversal: "clawback_receivable_settlement_reversal"; readonly ClawbackFee: "clawback_fee"; readonly PspClawbackFee: "psp_clawback_fee"; readonly BankTransfer: "bank_transfer"; readonly Deposit: "deposit"; readonly WalletTransferIncoming: "wallet_transfer_incoming"; readonly WalletTransferOutgoing: "wallet_transfer_outgoing"; readonly SwapSource: "swap_source"; readonly SwapTarget: "swap_target"; }; type LineType = (typeof LineType)[keyof typeof LineType]; const Object_: { readonly LedgerActivity: "ledger_activity"; }; type Object_ = (typeof Object_)[keyof typeof Object_]; interface Payment { /** Total charged by the payment. */ amount: Whop.Money | null; /** Card brand, when the customer paid by card. */ card_brand: string | null; /** Last four digits of the card, when the customer paid by card. */ card_last4: string | null; /** When the payment was created. */ created_at: string; /** Payment ID, prefixed `pay_`. */ id: string; object: Payment.Object_; /** How the customer paid, such as `card` or `paypal`. */ payment_method_type: string | null; /** Processor that handled the payment, such as `stripe`. */ payment_processor: string | null; /** Variant associated with the payment, when applicable. */ plan: Payment.Plan | null; /** Product associated with the payment, when applicable. */ product: Payment.Product | null; /** Customer associated with the payment. Email requires member:email:read. */ user: Payment.User | null; } namespace Payment { const Object_: { readonly Payment: "payment"; }; type Object_ = (typeof Object_)[keyof typeof Object_]; /** * Variant associated with the payment, when applicable. */ interface Plan { /** Variant ID, prefixed `plan_`. */ id: string; /** Variant name. */ name: string | null; } /** * Product associated with the payment, when applicable. */ interface Product { /** Product ID, prefixed `prod_`. */ id: string; /** Product name. */ name: string; } /** * Customer associated with the payment. Email requires member:email:read. */ interface User { /** Customer email, or null without member:email:read. */ email: string | null; /** Customer ID, prefixed `user_`. */ id: string; /** Customer display name. */ name: string; } } /** * Resource associated with this ledger activity. */ type Resource = { id: string; logo_url: string | null; object: "account"; route: string | null; title: string | null; } | { id: string; name: string | null; object: "user"; profile_picture_url: string | null; username: string | null; } | { id: string; object: "bounty"; status: string; title: string; } | { id: string; object: "ledger_account"; owner: ({ id: string; logo_url: string | null; object: "account"; route: string | null; title: string | null; } | { id: string; name: string | null; object: "user"; profile_picture_url: string | null; username: string | null; }) | null; } | { bank: { account_name: string | null; account_type: string | null; bank_name: string | null; last4: string | null; } | null; card: { brand: string | null; exp_month: number | null; exp_year: number | null; last4: string | null; } | null; email_identifier: string | null; gateway_type: string | null; id: string; object: "payment_method"; payment_method_type: string | null; } | { account_reference: string | null; destination_currency_code: string | null; id: string; institution_name: string | null; nickname: string | null; object: "payout_method"; provider: string | null; } | { authorized_at: string | null; card_id: string | null; cashback_usd: string | null; declined_reason: string | null; id: string; local_amount: string | null; local_currency: string | null; merchant_category: string | null; merchant_icon_url: string | null; merchant_name: string | null; object: "card_transaction"; posted_at: string | null; status: string | null; usd_amount: string | null; }; /** * Source of this ledger activity. Platform markup fees use object platform_fee and the ledger activity ID. */ interface Source { /** Payout amount as a decimal number in the destination currency (payout sources only; requires payout:withdrawal:read). */ amount_float?: (number | null) | undefined; /** Card brand used by the payment source. */ card_brand?: (string | null) | undefined; /** Chain the deposit landed on, for example plasma (onchain_transaction sources only). */ chain?: (string | null) | undefined; /** The airdrop's claim URL. Null unless the caller can manage claim links on the funding company or withdraw from the funding personal balance. */ claim_url?: (string | null) | undefined; /** Payout creation time as an ISO 8601 timestamp (payout sources only; requires payout:withdrawal:read). */ created_at?: (string | null) | undefined; /** User who requested the withdrawal. Null for system-generated withdrawals or without payout:withdrawal:read. */ created_by_user?: (Whop.UserSummary | null) | undefined; /** Estimated arrival as an ISO 8601 timestamp (payout sources only; requires payout:withdrawal:read). */ estimated_arrival?: (string | null) | undefined; /** Total withdrawal fees, including markup fees. Requires payout:withdrawal:read. */ fee_amount?: (Whop.Money | null) | undefined; /** 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. */ fee_kind?: (Source.FeeKind | null) | undefined; /** Whether withdrawal fees are inclusive or exclusive. Requires payout:withdrawal:read. */ fee_type?: (Source.FeeType | null) | undefined; /** Amount converted out of from_currency as a decimal string (swap sources only). */ from_amount?: (string | null) | undefined; /** Lowercase currency code converted from (swap sources only). */ from_currency?: (string | null) | undefined; id: string; /** Memo attached to the transfer, payout, or bank_deposit source, or null when none was provided (on payout sources requires payout:withdrawal:read). */ notes?: (string | null) | undefined; object: string; /** On payout sources, the name of the entity processing the payout (requires payout:withdrawal:read). On bank_deposit sources, the name of the account that sent the deposit. */ payer_name?: (string | null) | undefined; /** Total charged by the payment source. */ payment_amount?: (Whop.Money | null) | undefined; /** Payment method used by the payment source. On bank_deposit sources, the transfer rail: `wire`, `ach`, or `rtp`. */ payment_method_type?: (string | null) | undefined; /** Processor used by the payment source. */ payment_processor?: (string | null) | undefined; /** Withdrawal principal sent to the destination, excluding fees, in the withdrawal currency. Requires payout:withdrawal:read. */ payout_amount?: (Whop.Money | null) | undefined; /** Payout destination display info (payout sources only). */ payout_destination?: (Source.PayoutDestination | null) | undefined; /** Saved payout destination nickname (payout sources only). */ payout_token_nickname?: (string | null) | undefined; /** 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. */ reason?: (string | null) | undefined; /** Whether this payout is currently held for manual risk review (payout sources only; requires payout:withdrawal:read). */ risk_review_hold?: (boolean | null) | undefined; /** On onchain_transaction sources, the sender wallet address or onramp provider identifier. On bank_deposit sources, the last four digits of the sending bank account, such as `••••1547`. */ sender_address?: (string | null) | undefined; /** 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); on bank_deposit sources it is succeeded, reversal_in_progress or reversed (ungated). */ status?: (string | null) | undefined; /** Amount received in to_currency as a decimal string (swap sources only). */ to_amount?: (string | null) | undefined; /** Lowercase currency code converted to (swap sources only). */ to_currency?: (string | null) | undefined; /** Bank trace reference for the withdrawal. Requires payout:withdrawal:read. */ trace_code?: (string | null) | undefined; /** On-chain transaction hash (onchain_transaction and swap sources only). */ tx_hash?: (string | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } namespace Source { /** 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. */ const FeeKind: { readonly Payout: "payout"; readonly Transfer: "transfer"; readonly Deposit: "deposit"; readonly Swap: "swap"; readonly CardSpend: "card_spend"; }; type FeeKind = (typeof FeeKind)[keyof typeof FeeKind]; /** Whether withdrawal fees are inclusive or exclusive. Requires payout:withdrawal:read. */ const FeeType: { readonly Exclusive: "exclusive"; readonly Inclusive: "inclusive"; }; type FeeType = (typeof FeeType)[keyof typeof FeeType]; /** * Payout destination display info (payout sources only). */ interface PayoutDestination { icon_url?: (string | null) | undefined; payer_name?: (string | null) | undefined; } } }