Skip to main content
Hver række har en typet resource og source, så du kan præsentere og linke til hændelsen uden ekstra opslag. Brug Financial Activity-API’et til at bygge et kontoudtog eller et transaktionsfeed for en konto eller bruger, og finansielle rapporter til at opsummere saldoaktivitet, indtægter og saldi over et datointerval og derefter nedbryde en rapporttotal i det, der drev den.

Endpoints

Attributter

string
påkrævet
ID for ledger-aktivitet.
account or user
Den seerkonto, der ejer denne rækkes ledger. Kun til stede, når svaret samler ejede konti (include_owned_accounts=true); ellers udeladt.
string
påkrævet
Beløb med fortegn i valutaens mindste præcisionsenheder.
string | null
påkrævet
ISO 8601-tidsstempel for, hvornår denne aktivitet påvirker tilgængelige midler: 00:00:00 UTC på den planlagte frigivelsesdato for krediteringer og debiteringer i en afventende good-funds- frigivelsesbeholder; bogføringstidspunktet for krediteringer og debiteringer til afregnede tilgængelige midler, herunder refusioner, tvister og udbetalinger. Null for aktivitet uden for disse forløb, herunder on-chain-rækker. Filtrene available_after/before bruger dens UTC-dato; standardaktivitet udelukker visse bevægelser, herunder opt-in- reserver.
object
påkrævet
Valuta for denne ledger-aktivitet.

Egenskaber

string
påkrævet
Valutakode.
string
påkrævet
Præcisionsfaktor for valutaen, for eksempel 100000000 for USD.
string | null
Den ledger-konto (en ldgr_-identifikator), som denne række tilhører. Kun til stede, når svaret samler ejede konti (include_owned_accounts=true); ellers udeladt. Kombiner den med account for at afgrænse skuffer og dashboard-links til den ejende virksomhed.
string
påkrævet
Den ledger-linjekategori, som denne aktivitet blev bogført under.Tilgængelige muligheder: 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, payment_return_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, capital_withholding, capital_withholding_reversal, capital_hold, capital_hold_release, capital_remittance, capital_remittance_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, perps_load_transfer, perps_load_deposit, perps_unload_transfer, perps_unload_deposit, perps_bridge_fee, perps_bridge_fee_offset, perps_volume, perps_volume_offset, perps_fee, perps_fee_offset, platform_trading_commission, trading_fee, perps_realized_pnl, perps_realized_pnl_offset, onchain_wallet_transfer_outgoing, onchain_wallet_transfer_incoming, onchain_platform_transfer_outgoing, onchain_platform_transfer_incoming, onchain_internal_transfer_outgoing, onchain_internal_transfer_incoming, onchain_swap_source, onchain_swap_target, savings_revaluation, 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, levels_points_card, levels_points_ads, levels_points_trading, levels_points_partner, levels_points_action, levels_points_burned, levels_points_issued, levels_rebate, marketing_expense, 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, deposit, wallet_transfer_incoming, wallet_transfer_outgoing, swap_source, swap_target
string
påkrævet
payment | null
Betaling relateret til denne ledger-aktivitet. Inkluderet, når udvidet ressourcehydrering er aktiveret, og bevægelsen er knyttet til en betaling.

Egenskaber

string
påkrævet
Betalings-ID, med præfikset pay_.
object | null
påkrævet
Samlet beløb opkrævet af betalingen.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string | null
påkrævet
Kortmærke, når kunden betalte med kort.
string | null
påkrævet
Kortets sidste fire cifre, når kunden betalte med kort.
string
påkrævet
Hvornår betalingen blev oprettet.
string
påkrævet
string | null
påkrævet
Hvordan kunden betalte, såsom card eller paypal.
string | null
påkrævet
Processor, der håndterede betalingen, såsom stripe.
object | null
påkrævet
Variant knyttet til betalingen, når det er relevant.

Egenskaber

string
påkrævet
Variant-ID, med præfikset plan_.
string | null
påkrævet
Variantnavn.
object | null
påkrævet
Produkt knyttet til betalingen, når det er relevant.

Egenskaber

string
påkrævet
Produkt-ID, med præfikset prod_.
string
påkrævet
Produktnavn.
object | null
påkrævet
Kunde knyttet til betalingen. E-mail kræver member:email:read.

Egenskaber

string
påkrævet
Kunde-ID, med præfikset user_.
string | null
påkrævet
Kundens e-mail, eller null uden member:email:read.
string
påkrævet
Kundens visningsnavn.
string | null
Betalings-ID for al betalingsrelateret aktivitet, herunder refusioner og tvister.
string | null
ID for den variant, der er knyttet til betalingen, når det er relevant.
string | null
Navn på den variant, der er knyttet til betalingen, når det er relevant.
string
påkrævet
Hvornår aktiviteten blev bogført i ledgeren.
string | null
ID for det produkt, der er knyttet til betalingen, når det er relevant.
string | null
Navn på det produkt, der er knyttet til betalingen, når det er relevant.
account or user or bounty or ledger_account or payment_method or payout_method or card_transaction | null
påkrævet
Ressource knyttet til denne ledger-aktivitet.
object | null
påkrævet
Kilde til denne ledger-aktivitet. Platformens markup-gebyrer bruger objektet platform_fee og ledger-aktivitetens ID.

Egenskaber

string
påkrævet
number | null
Udbetalingsbeløb som et decimaltal i destinationsvalutaen (kun udbetalingskilder; kræver payout:withdrawal:read).
string | null
Kortmærke brugt af betalingskilden.
string | null
Den kæde, indbetalingen landede på, for eksempel plasma (kun onchain_transaction- kilder).
string | null
Airdroppens claim-URL. Null, medmindre kalderen kan administrere claim-links på finansieringskontoen eller hæve fra den personlige finansieringssaldo.
string | null
Udbetalingens oprettelsestidspunkt som et ISO 8601-tidsstempel (kun udbetalingskilder; kræver payout:withdrawal:read).
object | null
Bruger, der anmodede om hævningen. Null for systemgenererede hævninger eller uden payout:withdrawal:read.

Egenskaber

string
påkrævet
Bruger-ID, med præfikset user_.
string | null
påkrævet
Visningsnavn.
object
påkrævet
Avatar-wrapper. Dens url er altid til stede og er en genereret pladsholder, når brugeren ikke har angivet noget billede.

Egenskaber

string
påkrævet
URL til avatarbillede. Altid til stede. Det er en genereret pladsholder, når brugeren ikke har angivet noget billede.
string
påkrævet
Offentligt brugernavn.
string | null
Forventet ankomst som et ISO 8601-tidsstempel (kun udbetalingskilder; kræver payout:withdrawal:read).
object | null
Samlede hævningsgebyrer, inklusive markup-gebyrer. Kræver payout:withdrawal:read.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string | null
Handling, der genererede et platform-markup-gebyr: deposit, swap, transfer, card_spend eller payout. Til stede for platform_markup_fee og platform_markup_fee_payout, også når include_resource er false. Null, når den oprindelige handling ikke er tilgængelig; udeladt på andre kildetyper.Tilgængelige muligheder: payout, transfer, deposit, swap, card_spend
string | null
Om hævningsgebyrer er inklusive eller eksklusive. Kræver payout:withdrawal:read.Tilgængelige muligheder: exclusive, inclusive
string | null
Beløb konverteret fra from_currency som en decimalstreng (kun swap-kilder).
string | null
Valutakode med små bogstaver, der er konverteret fra (kun swap-kilder).
string | null
Notat vedhæftet transfer-, payout- eller bank_deposit-kilden, eller null, når der ikke blev angivet noget (på udbetalingskilder kræves payout:withdrawal:read).
string
påkrævet
string | null
På udbetalingskilder navnet på den enhed, der behandler udbetalingen (kræver payout:withdrawal:read). På bank_deposit-kilder navnet på den konto, der sendte indbetalingen.
object | null
Samlet beløb opkrævet af betalingskilden.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string | null
Betalingsmetode brugt af betalingskilden. På bank_deposit-kilder overførselskanalen: wire, ach eller rtp.
string | null
Processor brugt af betalingskilden.
object | null
Hævningens hovedstol sendt til destinationen, eksklusive gebyrer, i hævningsvalutaen. Kræver payout:withdrawal:read.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
object | null
Visningsoplysninger for udbetalingsdestination (kun udbetalingskilder).

Egenskaber

string | null
string | null
string | null
Det sikkerhedssvar, forhandleren angav, da denne udbetalingsmetode blev tilføjet (for eksempel en Interac e-Transfer), og som er nødvendigt for at hæve udbetalingen. null, når destinationen ikke har noget brugerdefineret svar. Kræver payout:destination:read.
string | null
Kaldenavn for gemt udbetalingsdestination (kun udbetalingskilder).
string | null
Hvorfor aktiviteten fandt sted. På transfer-kilder er dette overførselsårsagen, for eksempel pool_top_up eller bounty_return. På udbetalingskilder forklarer den, hvorfor udbetalingen blev annulleret, afvist eller mislykkedes (kræver payout:withdrawal:read); null, mens udbetalingen forløber normalt.
boolean | null
Om denne udbetaling i øjeblikket er tilbageholdt til manuel risikogennemgang (kun udbetalingskilder; kræver payout:withdrawal:read).
string | null
På onchain_transaction-kilder afsenderens wallet-adresse eller onramp-udbyderens identifikator. På bank_deposit-kilder de sidste fire cifre i den afsendende bank- konto, såsom ••••1547.
string | null
Livscyklusstatus. På udbetalingskilder er dette udbetalingsstatussen (kræver payout:withdrawal:read); på airdrop_link-kilder er det claim-linkets status (uden adgangskrav); på betalings- og top-up-kilder er det den brugervenlige betalingsstatus såsom succeeded/pending/failed (uden adgangskrav); på bank_deposit-kilder er det succeeded, reversal_in_progress eller reversed (uden adgangskrav).
string | null
Beløb modtaget i to_currency som en decimalstreng (kun swap-kilder).
string | null
Valutakode med små bogstaver, der er konverteret til (kun swap-kilder).
string | null
Bankens sporingsreference for hævningen. Kræver payout:withdrawal:read.
string | null
On-chain-transaktionshash (kun onchain_transaction- og swap-kilder).
string | null
påkrævet
Dollarværdien af denne bevægelse som en decimalstreng, med fortegn som amount. Konverteret fra det bogførte beløb til den kurs, der var gældende, da linjen blev bogført — den samme prissætning, som wallet-saldodiagrammet og de finansielle rapporter bruger — så en kryptorække også har sin dollarværdi. null for en valuta, som Whop ikke har nogen vekselkurs for.
string | null
E-mail for den kunde, der er knyttet til betalingen. Kræver member:email:read.
string | null
ID for den kunde, der er knyttet til betalingen.
string | null
Visningsnavn for den kunde, der er knyttet til betalingen.
LedgerActivity

Ordliste over linjetyper

Hver aktivitetsrække har en line_type, der navngiver den finansielle hændelse, den repræsenterer. Send en eller flere line_types til Vis finansiel aktivitet for at filtrere feedet til specifikke hændelser — enten som gentagne line_types[]-parametre eller som en enkelt kommasepareret værdi (line_types=payment_gross,payment_refund). Ukendte linjetyper returnerer en 400. Udtrykket Local Payment Method (LPM) betyder en metode, der ikke er et kort, herunder bankdebiteringer, bankoverførsler og wallets.

Kategorier

I stedet for at angive individuelle linjetyper kan du sende en kategoriforkortelse. En kategori udvides til alle de linjetyper, den indeholder.

Betalinger

Refusioner

Tvister

Reserver

Udbetalinger

Overførsler

Valutaomregning

Affiliates og omsætningsdeling

Airdrops

Annoncering

On-chain-aktiver og kort

onchain_deposit er opt-in: den er udelukket fra standardfeedet og returneres kun, når du eksplicit anmoder om den i line_types.

Ældre og diverse

Gebyrer