@whop/elements 1.0.0-beta.3 → 1.0.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/wallet.d.ts CHANGED
@@ -107,7 +107,7 @@ export interface RequiredActionsElementCreateOptions {
107
107
  /**
108
108
  * The viewer pressed a banner button. Fires for every action, including ones the element also handles itself.
109
109
  */
110
- onActionRequested?: ((payload: { action: "deposit_funds" | "submit_information_request" | "update_automatic_withdrawal_method" | "reauthorize_payout_methods" | "update_payout_profile" | "card_usage_review" | "verify_identity" | "sign_formation_documents" | "connect_fulfillment_tracker" | "setup_apple_pay_domains" | "configure_tax_remitter" | "add_vat_registration"; accountId: string; }) => void);
110
+ onActionRequested?: ((payload: { action: "deposit_funds" | "accept_airwallex_terms" | "submit_information_request" | "update_automatic_withdrawal_method" | "reauthorize_payout_methods" | "update_payout_profile" | "card_usage_review" | "verify_identity" | "sign_formation_documents" | "connect_fulfillment_tracker" | "setup_apple_pay_domains" | "configure_tax_remitter" | "add_vat_registration"; accountId: string; }) => void);
111
111
  /**
112
112
  * The viewer pressed Verify on a `verify_identity` action the element can start. The element opens identity verification itself — this fires alongside, so a host can record the trip.
113
113
  */
@@ -326,7 +326,7 @@ export interface ActivityElementProps {
326
326
  * Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters.
327
327
  * @default []
328
328
  */
329
- defaultLineTypes?: ("platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "payment_gross_reversal" | "payment_refund" | "payment_refund_reversal" | "payment_dispute_reversal" | "payment_dispute_adjustment" | "dispute_hold_adjustment" | "topup_reversal" | "platform_balance_payment" | "platform_balance_payment_refund" | "platform_balance_transfer_incoming" | "internal_balance_transfer_incoming" | "internal_balance_transfer_outgoing" | "onchain_wallet_transfer_incoming" | "onchain_wallet_transfer_outgoing" | "withdrawal_reversal" | "withdrawal_clawback" | "withdrawal_clawback_reversal" | "payment_revshare_refund" | "payment_revshare_reversal" | "payment_referral" | "payment_referral_reversal" | "application_fee_payout" | "airdrop_reversal" | "airdrop_link_created" | "airdrop_link_returned" | "card_spend_authorization_void" | "card_spend_refund" | "onchain_deposit" | "bank_transfer" | "currency_conversion_outgoing" | "currency_conversion_incoming" | "airdrop_link_redeemed" | "resolution_center_refund" | "withdrawal_reclassification" | "payment_revshare_payout" | "platform_affiliate_payment" | "platform_affiliate_payment_reversal" | "onboarding_reward" | "platform_covered_dispute" | "treasury_payin" | "passthrough_gmv" | "promo_reversal" | "misc_reversal" | "ad_spend_charge" | "ad_campaign_budget" | "ad_budget_release" | "ad_publisher_payout" | "ad_publisher_payout_received" | "affiliate_fee" | "application_fee" | "billing_percentage_fee" | "buyer_fee" | "cross_border_percentage_fee" | "dispute_alert_fee" | "fraud_prevention_fee" | "fx_percentage_fee" | "high_risk_merchant_fee" | "orchestration_percentage_fee" | "payment_dispute_fee" | "payment_processing_fixed_fee" | "payment_processing_percentage_fee" | "payout_fee" | "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" | "whop_processing_fee")[];
329
+ defaultLineTypes?: ("platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "cashback" | "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" | "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" | "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_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" | "withdrawal_reversal")[];
330
330
  /**
331
331
  * Hide the filter chips, for a compact list that the viewer does not filter.
332
332
  * @default false
@@ -392,7 +392,7 @@ export interface ActivityElementCreateOptions {
392
392
  * Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters.
393
393
  * @default []
394
394
  */
395
- defaultLineTypes?: ("platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "payment_gross_reversal" | "payment_refund" | "payment_refund_reversal" | "payment_dispute_reversal" | "payment_dispute_adjustment" | "dispute_hold_adjustment" | "topup_reversal" | "platform_balance_payment" | "platform_balance_payment_refund" | "platform_balance_transfer_incoming" | "internal_balance_transfer_incoming" | "internal_balance_transfer_outgoing" | "onchain_wallet_transfer_incoming" | "onchain_wallet_transfer_outgoing" | "withdrawal_reversal" | "withdrawal_clawback" | "withdrawal_clawback_reversal" | "payment_revshare_refund" | "payment_revshare_reversal" | "payment_referral" | "payment_referral_reversal" | "application_fee_payout" | "airdrop_reversal" | "airdrop_link_created" | "airdrop_link_returned" | "card_spend_authorization_void" | "card_spend_refund" | "onchain_deposit" | "bank_transfer" | "currency_conversion_outgoing" | "currency_conversion_incoming" | "airdrop_link_redeemed" | "resolution_center_refund" | "withdrawal_reclassification" | "payment_revshare_payout" | "platform_affiliate_payment" | "platform_affiliate_payment_reversal" | "onboarding_reward" | "platform_covered_dispute" | "treasury_payin" | "passthrough_gmv" | "promo_reversal" | "misc_reversal" | "ad_spend_charge" | "ad_campaign_budget" | "ad_budget_release" | "ad_publisher_payout" | "ad_publisher_payout_received" | "affiliate_fee" | "application_fee" | "billing_percentage_fee" | "buyer_fee" | "cross_border_percentage_fee" | "dispute_alert_fee" | "fraud_prevention_fee" | "fx_percentage_fee" | "high_risk_merchant_fee" | "orchestration_percentage_fee" | "payment_dispute_fee" | "payment_processing_fixed_fee" | "payment_processing_percentage_fee" | "payout_fee" | "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" | "whop_processing_fee")[];
395
+ defaultLineTypes?: ("platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "cashback" | "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" | "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" | "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_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" | "withdrawal_reversal")[];
396
396
  /**
397
397
  * Hide the filter chips, for a compact list that the viewer does not filter.
398
398
  * @default false
@@ -607,6 +607,11 @@ export interface DepositElementProps {
607
607
  * @default null
608
608
  */
609
609
  cardFee?: DepositCardFee | null;
610
+ /**
611
+ * Deposit fees to preview under the rail picker, keyed by rail (`bank`, `crypto`). `percentageFee` is in percentage POINTS (`1.5` is 1.5%); `fixedFeeUsd` is USD major units (`2` is $2.00) whatever the deposit currency. Shows the rate before an amount is typed and the charged amount after.
612
+ * @default {}
613
+ */
614
+ depositRailFees?: Partial<Record<"bank" | "crypto", DepositRailFee>>;
610
615
  /**
611
616
  * Preselect a rail by id (`bank`, `crypto`, `platform_balance`, or a saved card id). Continue stays disabled while that rail is not yet offered, rather than funding through another one.
612
617
  * @default ""
@@ -705,6 +710,11 @@ export interface DepositElementCreateOptions {
705
710
  * @default null
706
711
  */
707
712
  cardFee?: DepositCardFee | null;
713
+ /**
714
+ * Deposit fees to preview under the rail picker, keyed by rail (`bank`, `crypto`). `percentageFee` is in percentage POINTS (`1.5` is 1.5%); `fixedFeeUsd` is USD major units (`2` is $2.00) whatever the deposit currency. Shows the rate before an amount is typed and the charged amount after.
715
+ * @default {}
716
+ */
717
+ depositRailFees?: Partial<Record<"bank" | "crypto", DepositRailFee>>;
708
718
  /**
709
719
  * Preselect a rail by id (`bank`, `crypto`, `platform_balance`, or a saved card id). Continue stays disabled while that rail is not yet offered, rather than funding through another one.
710
720
  * @default ""
@@ -1567,6 +1577,11 @@ export interface VerificationElementProps {
1567
1577
  * @default "individual"
1568
1578
  */
1569
1579
  kind?: "individual" | "business";
1580
+ /**
1581
+ * Show a compact inline prompt without the supporting description.
1582
+ * @default false
1583
+ */
1584
+ compact?: boolean;
1570
1585
  }
1571
1586
 
1572
1587
  /**
@@ -1611,6 +1626,11 @@ export interface VerificationElementCreateOptions {
1611
1626
  * @default "individual"
1612
1627
  */
1613
1628
  kind?: "individual" | "business";
1629
+ /**
1630
+ * Show a compact inline prompt without the supporting description.
1631
+ * @default false
1632
+ */
1633
+ compact?: boolean;
1614
1634
  /**
1615
1635
  * The viewer pressed the verify button. The element never navigates — mount your own verification, such as the `verifications` controller, in answer to this.
1616
1636
  */
@@ -2123,6 +2143,158 @@ export interface BalancesSubHandle {
2123
2143
  destroy(): void;
2124
2144
  }
2125
2145
 
2146
+ /**
2147
+ * Consumer props for the "reports" sub-controller: the `create("reports")` options and the minted sub handle's `update()` payload (React: `<Reports>` props). Parent-injected props never appear here.
2148
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2149
+ */
2150
+ export interface ReportsSubOptions {}
2151
+
2152
+ /**
2153
+ * Consumer props for the "reports" sub-controller's "balanceReport" element.
2154
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2155
+ */
2156
+ export interface BalanceReportElementProps {}
2157
+
2158
+ /**
2159
+ * The live handle for a mounted "balanceReport" element. Returned by the "reports" sub handle's `create("balanceReport")`.
2160
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2161
+ */
2162
+ export interface BalanceReportElementHandle {
2163
+ /**
2164
+ * Refresh the report data after activity changes.
2165
+ */
2166
+ refresh: () => Promise<void>;
2167
+ /**
2168
+ * Mounts the element in `target` and starts loading. React components mount themselves.
2169
+ */
2170
+ mount: (target: string | HTMLElement) => void;
2171
+ /**
2172
+ * Removes the element and releases its frame and subscriptions. You can call it more than once. React removes the element automatically.
2173
+ */
2174
+ destroy: () => void;
2175
+ /**
2176
+ * Merges new props into the mounted element. In React, change the component props instead.
2177
+ */
2178
+ update: (options: Partial<BalanceReportElementProps>) => void;
2179
+ }
2180
+
2181
+ /**
2182
+ * Options for the "reports" sub handle's `create("balanceReport")`: the consumer props plus event callbacks and lifecycle hooks.
2183
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2184
+ */
2185
+ export interface BalanceReportElementCreateOptions {
2186
+ /**
2187
+ * Emitted when activity opens inline, with its exact filters. Your host can also use this callback to navigate to its own activity page.
2188
+ */
2189
+ onActivityRequested?: ((payload: ReportActivityFilters) => void);
2190
+ /**
2191
+ * Providing this callback enables payment-method links. Open your payments page for the supplied method and time window.
2192
+ */
2193
+ onPaymentsRequested?: ((payload: ReportPaymentsRequest) => void);
2194
+ /**
2195
+ * A CSV is ready. The element also shows an explicit download link.
2196
+ */
2197
+ onExportReady?: ((payload: ReportExportReady) => void);
2198
+ /**
2199
+ * Runs after the loading skeleton first paints and before `onReady`.
2200
+ */
2201
+ onLoaderStart?: (() => void);
2202
+ /**
2203
+ * Runs after the element's first complete paint.
2204
+ */
2205
+ onReady?: (() => void);
2206
+ /**
2207
+ * 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.
2208
+ */
2209
+ onError?: ((e: { message: string; code?: string | undefined; sourceKey?: string | undefined; }) => void);
2210
+ }
2211
+
2212
+ /**
2213
+ * Consumer props for the "reports" sub-controller's "reportActivity" element.
2214
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2215
+ */
2216
+ export interface ReportActivityElementProps {
2217
+ /**
2218
+ * Initial filters. Changing these resets the table to the requested activity.
2219
+ * @default {}
2220
+ */
2221
+ filters?: ReportActivityFilters;
2222
+ }
2223
+
2224
+ /**
2225
+ * The live handle for a mounted "reportActivity" element. Returned by the "reports" sub handle's `create("reportActivity")`.
2226
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2227
+ */
2228
+ export interface ReportActivityElementHandle {
2229
+ /**
2230
+ * Refresh the report data after activity changes.
2231
+ */
2232
+ refresh: () => Promise<void>;
2233
+ /**
2234
+ * Mounts the element in `target` and starts loading. React components mount themselves.
2235
+ */
2236
+ mount: (target: string | HTMLElement) => void;
2237
+ /**
2238
+ * Removes the element and releases its frame and subscriptions. You can call it more than once. React removes the element automatically.
2239
+ */
2240
+ destroy: () => void;
2241
+ /**
2242
+ * Merges new props into the mounted element. In React, change the component props instead.
2243
+ */
2244
+ update: (options: Partial<ReportActivityElementProps>) => void;
2245
+ }
2246
+
2247
+ /**
2248
+ * Options for the "reports" sub handle's `create("reportActivity")`: the consumer props plus event callbacks and lifecycle hooks.
2249
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2250
+ */
2251
+ export interface ReportActivityElementCreateOptions {
2252
+ /**
2253
+ * Initial filters. Changing these resets the table to the requested activity.
2254
+ * @default {}
2255
+ */
2256
+ filters?: ReportActivityFilters;
2257
+ /**
2258
+ * The CSV is ready; downloadUrl also appears as a clickable link.
2259
+ */
2260
+ onExportReady?: ((payload: ReportExportReady) => void);
2261
+ /**
2262
+ * Runs after the loading skeleton first paints and before `onReady`.
2263
+ */
2264
+ onLoaderStart?: (() => void);
2265
+ /**
2266
+ * Runs after the element's first complete paint.
2267
+ */
2268
+ onReady?: (() => void);
2269
+ /**
2270
+ * 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.
2271
+ */
2272
+ onError?: ((e: { message: string; code?: string | undefined; sourceKey?: string | undefined; }) => void);
2273
+ }
2274
+
2275
+ /**
2276
+ * The "reports" sub-handle, minted by `handle.create("reports", …)`. Mounts the sub-controller's elements and carries its actions.
2277
+ * @see https://docs.whop.com/elements/latest/wallet/overview
2278
+ */
2279
+ export interface ReportsSubHandle {
2280
+ /**
2281
+ * Balance history with date, timezone, and currency controls, starting and ending balances, and money-in and money-out breakdowns. Drill into activity and export it without leaving the element.
2282
+ */
2283
+ create(name: "balanceReport", options?: BalanceReportElementCreateOptions): BalanceReportElementHandle;
2284
+ /**
2285
+ * Financial activity with date, currency, direction, and movement filters, pagination, and CSV export. Mount independently or open it from the balance report.
2286
+ */
2287
+ create(name: "reportActivity", options?: ReportActivityElementCreateOptions): ReportActivityElementHandle;
2288
+ /**
2289
+ * Merges new props and callbacks into the sub-controller.
2290
+ */
2291
+ update(options: Partial<ReportsSubOptions>): void;
2292
+ /**
2293
+ * Destroys the sub-controller and its elements, then frees its exclusive slot. A later `create("reports")` starts fresh.
2294
+ */
2295
+ destroy(): void;
2296
+ }
2297
+
2126
2298
  /**
2127
2299
  * Consumer props for the "cards" sub-controller: the `create("cards")` options and the minted sub handle's `update()` payload (React: `<Cards>` props). Parent-injected props never appear here.
2128
2300
  * @see https://docs.whop.com/elements/latest/wallet/overview
@@ -2760,13 +2932,17 @@ export interface WalletHandle {
2760
2932
  */
2761
2933
  createOverlay(name: "cardDetails", options?: CardDetailsElementCreateOptions): CardDetailsElementOverlayHandle;
2762
2934
  /**
2763
- * A banner asking the account holder to verify their identity, shown only while verification is outstanding — an account that has already verified renders nothing at all, so the element can sit permanently in a layout. The headline and body come from the API, so they track the account's actual state: an unstarted account is invited to unlock cards and payouts, one under review reads as pending, and a failed or flagged one says so. Pressing the button reports `verificationRequested` and stays put, so the host mounts its own verification — the `verifications` controller's `kyc` element, say. Needs an `accessToken`. A failed read renders nothing rather than an error — a nudge should never become the loudest thing on the page.
2935
+ * A banner asking the account holder to verify their identity, shown only while verification is outstanding — an account that has already verified renders nothing at all, so the element can sit permanently in a layout. The headline and status messages come from the API, with a shorter description when inviting the account holder to start verification, so they track the account's actual state: an unstarted account is invited to unlock cards and payouts, one under review reads as pending, and a failed or flagged one says so. Pressing the button reports `verificationRequested` and stays put, so the host mounts its own verification — the `verifications` controller's `kyc` element, say. Needs an `accessToken`. A failed read renders nothing rather than an error — a nudge should never become the loudest thing on the page.
2764
2936
  */
2765
2937
  create(name: "verification", options?: VerificationElementCreateOptions): VerificationElementHandle;
2766
2938
  /**
2767
2939
  * Three views of an account's money. The balance view shows the total, a chart of how it changed, and a picker for the time range. The list view shows the holdings that make up that total, valued in dollars. The breakdown view splits one currency into available, pending, reserve, and negative amounts without money-movement controls. When `openHoldingOnSelect` is on, a list row replaces this unit's canvas — the chart and the list — with that holding's balance page instead of only reporting the click.
2768
2940
  */
2769
2941
  create(name: "balances", options?: BalancesSubOptions): BalancesSubHandle;
2942
+ /**
2943
+ * Balance history and the financial activity behind it, including CSV exports. Account statements are available in the Whop dashboard.
2944
+ */
2945
+ create(name: "reports", options?: ReportsSubOptions): ReportsSubHandle;
2770
2946
  /**
2771
2947
  * An account's card surfaces, mounted from one place: the compact issued-card list, the full sortable roster, the spend chart, and a single revealable card. Mount the faces the page needs — they share the account and the credential this unit is minted with, so a page showing a chart above a roster wires them once.
2772
2948
  */
@@ -2834,7 +3010,7 @@ export interface LedgerActivity {
2834
3010
  /**
2835
3011
  * The ledger line category this activity was posted under.
2836
3012
  */
2837
- line_type: "platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "payment_gross_reversal" | "payment_refund" | "payment_refund_reversal" | "payment_dispute_reversal" | "payment_dispute_adjustment" | "dispute_hold_adjustment" | "topup_reversal" | "platform_balance_payment" | "platform_balance_payment_refund" | "platform_balance_transfer_incoming" | "internal_balance_transfer_incoming" | "internal_balance_transfer_outgoing" | "onchain_wallet_transfer_incoming" | "onchain_wallet_transfer_outgoing" | "withdrawal_reversal" | "withdrawal_clawback" | "withdrawal_clawback_reversal" | "payment_revshare_refund" | "payment_revshare_reversal" | "payment_referral" | "payment_referral_reversal" | "application_fee_payout" | "airdrop_reversal" | "airdrop_link_created" | "airdrop_link_returned" | "card_spend_authorization_void" | "card_spend_refund" | "onchain_deposit" | "bank_transfer" | "currency_conversion_outgoing" | "currency_conversion_incoming" | "airdrop_link_redeemed" | "resolution_center_refund" | "withdrawal_reclassification" | "payment_revshare_payout" | "platform_affiliate_payment" | "platform_affiliate_payment_reversal" | "onboarding_reward" | "platform_covered_dispute" | "treasury_payin" | "passthrough_gmv" | "promo_reversal" | "misc_reversal" | "ad_spend_charge" | "ad_campaign_budget" | "ad_budget_release" | "ad_publisher_payout" | "ad_publisher_payout_received" | "affiliate_fee" | "application_fee" | "billing_percentage_fee" | "buyer_fee" | "cross_border_percentage_fee" | "dispute_alert_fee" | "fraud_prevention_fee" | "fx_percentage_fee" | "high_risk_merchant_fee" | "orchestration_percentage_fee" | "payment_dispute_fee" | "payment_processing_fixed_fee" | "payment_processing_percentage_fee" | "payout_fee" | "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" | "whop_processing_fee" | "balance_reservation" | "balance_reservation_reversal" | "card_interchange" | "card_load_deposit" | "card_load_transfer" | "card_unload_deposit" | "card_unload_transfer" | "company_referral" | "connected_account_negative_balance" | "dispute_representment_fee" | "external_card_load_deposit" | "installment_default" | "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" | "onchain_swap_source" | "onchain_withdrawal" | "payment_referral_refund" | "platform_balance_transfer_fee" | "platform_earning" | "referral_bonus" | "software_rental_revshare" | "software_rental_transaction" | "swap_fee" | "topup_fee" | "withdrawal_fee" | "withdrawal_fee_reversal" | "withdrawal_markup_fee" | "withdrawal_markup_fee_payout" | "withdrawal_markup_fee_payout_reversal" | "withdrawal_markup_fee_reversal" | "withdrawal_topup_adjustment" | "deposit" | "wallet_transfer_incoming" | "wallet_transfer_outgoing" | "swap_source" | "swap_target";
3013
+ line_type: "platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "cashback" | "account_settlement" | "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" | "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" | "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_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" | "deposit" | "wallet_transfer_incoming" | "wallet_transfer_outgoing" | "swap_source" | "swap_target";
2838
3014
  /**
2839
3015
  * Signed amount in the currency's smallest precision units.
2840
3016
  */
@@ -2860,9 +3036,9 @@ export interface LedgerActivity {
2860
3036
  */
2861
3037
  resource: { object: "account"; id: string; title: string | null; route: string | null; logo_url: string | null; } | { object: "user"; id: string; name: string | null; username: string | null; profile_picture_url: string | null; } | { object: "bounty"; id: string; title: string; status: string; } | { object: "ledger_account"; id: string; owner: { object: "account"; id: string; title: string | null; route: string | null; logo_url: string | null; } | { object: "user"; id: string; name: string | null; username: string | null; profile_picture_url: string | null; } | null; } | { object: "payment_method"; id: string; payment_method_type: string | null; gateway_type: string | null; card: { brand: string | null; last4: string | null; exp_month: number | null; exp_year: number | null; } | null; bank: { bank_name: string | null; account_name: string | null; last4: string | null; account_type: string | null; } | null; email_identifier: string | null; } | { object: "payout_method"; id: string; nickname: string | null; institution_name: string | null; account_reference: string | null; provider: string | null; destination_currency_code: string | null; } | { object: "card_transaction"; id: string; card_id: string | null; merchant_name: string | null; merchant_icon_url: string | null; merchant_category: string | null; status: string | null; usd_amount: string | null; local_amount: string | null; local_currency: string | null; cashback_usd: string | null; authorized_at: string | null; posted_at: string | null; declined_reason: string | null; } | null;
2862
3038
  /**
2863
- * Source of this ledger activity.
3039
+ * Source of this ledger activity. Platform markup fees use object platform_fee and the ledger activity ID.
2864
3040
  */
2865
- source: { object: string; id: string; status?: string | null | undefined; payment_amount?: Money | null | undefined; payment_method_type?: string | null | undefined; payment_processor?: string | null | undefined; card_brand?: string | null | undefined; reason?: string | null | undefined; notes?: string | null | undefined; risk_review_hold?: boolean | null | undefined; claim_url?: string | null | undefined; amount_float?: number | null | undefined; created_at?: string | null | undefined; estimated_arrival?: string | null | undefined; payer_name?: string | null | undefined; payout_token_nickname?: string | null | undefined; tx_hash?: string | null | undefined; sender_address?: string | null | undefined; chain?: string | null | undefined; from_amount?: string | null | undefined; from_currency?: string | null | undefined; to_amount?: string | null | undefined; to_currency?: string | null | undefined; payout_destination?: { payer_name?: string | null | undefined; icon_url?: string | null | undefined; } | null | undefined; [key: string]: unknown; } | null;
3041
+ source: { object: string; id: string; fee_kind?: "transfer" | "card_spend" | "deposit" | "swap" | "payout" | null | undefined; status?: string | null | undefined; payment_amount?: Money | null | undefined; payment_method_type?: string | null | undefined; payment_processor?: string | null | undefined; card_brand?: string | null | undefined; reason?: string | null | undefined; notes?: string | null | undefined; risk_review_hold?: boolean | null | undefined; claim_url?: string | null | undefined; amount_float?: number | null | undefined; created_at?: string | null | undefined; estimated_arrival?: string | null | undefined; payer_name?: string | null | undefined; payout_token_nickname?: string | null | undefined; tx_hash?: string | null | undefined; sender_address?: string | null | undefined; chain?: string | null | undefined; from_amount?: string | null | undefined; from_currency?: string | null | undefined; to_amount?: string | null | undefined; to_currency?: string | null | undefined; payout_destination?: { payer_name?: string | null | undefined; icon_url?: string | null | undefined; } | null | undefined; [key: string]: unknown; } | null;
2866
3042
  /**
2867
3043
  * Payment related to this ledger activity. Included when rich resource hydration is enabled and the movement is tied to a payment.
2868
3044
  */
@@ -2946,6 +3122,20 @@ export interface DepositCardFee {
2946
3122
  radarFee: number;
2947
3123
  }
2948
3124
 
3125
+ /**
3126
+ * Declared from the app's `DepositRailFee`, referenced by a host-capability surface.
3127
+ */
3128
+ export interface DepositRailFee {
3129
+ /**
3130
+ * Percentage POINTS, not a fraction: `1.5` means 1.5%.
3131
+ */
3132
+ percentageFee: number;
3133
+ /**
3134
+ * Flat fee in USD major units: `2` means $2.00, whatever the deposit currency.
3135
+ */
3136
+ fixedFeeUsd: number;
3137
+ }
3138
+
2949
3139
  /**
2950
3140
  * Declared from the app's `WithdrawalQuoteSpeed`, referenced by a host-capability surface.
2951
3141
  */
@@ -3141,3 +3331,32 @@ export interface Billing {
3141
3331
  */
3142
3332
  region: string | null;
3143
3333
  }
3334
+
3335
+ /**
3336
+ * Declared from the app's `ReportActivityFilters`, referenced by a host-capability surface.
3337
+ */
3338
+ export interface ReportActivityFilters {
3339
+ currency?: string | undefined;
3340
+ postedAfter?: string | undefined;
3341
+ postedBefore?: string | undefined;
3342
+ direction?: "money_in" | "money_out" | undefined;
3343
+ lineTypes?: ("platform_balance_transfer_outgoing" | "payment_gross" | "withdrawal" | "topup" | "payment_dispute" | "payment_revshare" | "card_spend_authorization" | "airdrop" | "onchain_swap_target" | "cashback" | "account_settlement" | "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" | "external_card_load_deposit" | "fees" | "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" | "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_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")[] | undefined;
3344
+ resourceId?: string | undefined;
3345
+ }
3346
+
3347
+ /**
3348
+ * Declared from the app's `ReportPaymentsRequest`, referenced by a host-capability surface.
3349
+ */
3350
+ export interface ReportPaymentsRequest {
3351
+ postedAfter: string;
3352
+ postedBefore: string;
3353
+ paymentMethod: string;
3354
+ }
3355
+
3356
+ /**
3357
+ * Declared from the app's `ReportExportReady`, referenced by a host-capability surface.
3358
+ */
3359
+ export interface ReportExportReady {
3360
+ exportId: string;
3361
+ downloadUrl: string;
3362
+ }