@whop/elements 1.0.0 → 1.2.0
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/ads.d.cts +1 -1
- package/ads.d.ts +1 -1
- package/checkout.d.cts +61 -1
- package/checkout.d.ts +61 -1
- package/dashboard.d.cts +1 -1
- package/dashboard.d.ts +1 -1
- package/index.d.cts +1 -1
- package/index.d.ts +1 -1
- package/package.json +2 -2
- package/payments.d.cts +40 -27
- package/payments.d.ts +40 -27
- package/wallet.d.cts +18 -10
- package/wallet.d.ts +18 -10
package/ads.d.cts
CHANGED
|
@@ -560,7 +560,7 @@ export interface AdsHandle {
|
|
|
560
560
|
*/
|
|
561
561
|
create(name: "billing-setup", options?: BillingSetupElementCreateOptions): BillingSetupElementHandle;
|
|
562
562
|
/**
|
|
563
|
-
* The advertising campaign builder: objective and budget, ad groups with their targeting and schedule, and the ads themselves with their creative — the whole flow through to launch. Opens empty to build a new campaign, or on an existing one when you pass `campaignId`. It runs the pixel checker too: a launch is gated on the ad group’s conversion event being live on the destination URL, and the `pixel-setup` wizard opens inside this element to fix an install that is missing. The one token you set on the `ads` handle must carry the pixel scopes alongside the campaign scopes — `ad_campaign:create` and `company:basic:read` — rather than using a separate token per element.
|
|
563
|
+
* The advertising campaign builder: objective and budget, ad groups with their targeting and schedule, and the ads themselves with their creative — the whole flow through to launch. Opens empty to build a new campaign, or on an existing one when you pass `campaignId`. It runs the pixel checker too: a launch is gated on the ad group’s conversion event being live on the destination URL, and the `pixel-setup` wizard opens inside this element to fix an install that is missing. Budgets are entered and shown in the account’s `ads_reporting_currency` — the currency its reports already use — and converted to and billed in USD at the current exchange rate. The one token you set on the `ads` handle must carry the pixel scopes alongside the campaign scopes — `ad_campaign:create` and `company:basic:read` — rather than using a separate token per element.
|
|
564
564
|
*/
|
|
565
565
|
createOverlay(name: "campaign-creator", options?: CampaignCreatorElementCreateOptions): CampaignCreatorElementOverlayHandle;
|
|
566
566
|
/**
|
package/ads.d.ts
CHANGED
|
@@ -560,7 +560,7 @@ export interface AdsHandle {
|
|
|
560
560
|
*/
|
|
561
561
|
create(name: "billing-setup", options?: BillingSetupElementCreateOptions): BillingSetupElementHandle;
|
|
562
562
|
/**
|
|
563
|
-
* The advertising campaign builder: objective and budget, ad groups with their targeting and schedule, and the ads themselves with their creative — the whole flow through to launch. Opens empty to build a new campaign, or on an existing one when you pass `campaignId`. It runs the pixel checker too: a launch is gated on the ad group’s conversion event being live on the destination URL, and the `pixel-setup` wizard opens inside this element to fix an install that is missing. The one token you set on the `ads` handle must carry the pixel scopes alongside the campaign scopes — `ad_campaign:create` and `company:basic:read` — rather than using a separate token per element.
|
|
563
|
+
* The advertising campaign builder: objective and budget, ad groups with their targeting and schedule, and the ads themselves with their creative — the whole flow through to launch. Opens empty to build a new campaign, or on an existing one when you pass `campaignId`. It runs the pixel checker too: a launch is gated on the ad group’s conversion event being live on the destination URL, and the `pixel-setup` wizard opens inside this element to fix an install that is missing. Budgets are entered and shown in the account’s `ads_reporting_currency` — the currency its reports already use — and converted to and billed in USD at the current exchange rate. The one token you set on the `ads` handle must carry the pixel scopes alongside the campaign scopes — `ad_campaign:create` and `company:basic:read` — rather than using a separate token per element.
|
|
564
564
|
*/
|
|
565
565
|
createOverlay(name: "campaign-creator", options?: CampaignCreatorElementCreateOptions): CampaignCreatorElementOverlayHandle;
|
|
566
566
|
/**
|
package/checkout.d.cts
CHANGED
|
@@ -43,9 +43,13 @@ export interface CheckoutOptions {
|
|
|
43
43
|
*/
|
|
44
44
|
metadata?: Record<string, string>;
|
|
45
45
|
/**
|
|
46
|
-
* Where the buyer lands after an off-site payment step. Https-only (http for localhost). Set at create only.
|
|
46
|
+
* Where the buyer lands after an off-site payment step, whatever its outcome. The tab arrives with `payment` (the `pay_` ID; `setup` with the `sint_` ID for a setup-mode checkout) and `status` (`succeeded`, `failed`, or `canceled`) appended, and your other query parameters intact. Branch on `status` before showing a success page: a declined or abandoned off-site step lands here too. Fulfill from webhooks, not from this visit. Https-only (http for localhost). Set at create only.
|
|
47
47
|
*/
|
|
48
48
|
returnUrl?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Fires once per mount when the checkout completes and its result stands. `result` says what stands: `payment` (the buyer paid — `paymentId`), `waitlist_entry` (the buyer joined a waitlist — `entryId`) or `setup` (a setup-mode checkout saved the payment method — `setupIntentId`); `sessionId` is the checkout session either way. Fires before any `returnUrl` navigation, so this is where your own analytics or ad pixels record the purchase. Fulfill from webhooks, not from this callback: a checkout restored on a later page load fires it again for the same result.
|
|
51
|
+
*/
|
|
52
|
+
onComplete?: ((payload: CheckoutPaymentCompletion | CheckoutWaitlistCompletion | CheckoutSetupCompletion) => void);
|
|
49
53
|
/**
|
|
50
54
|
* Runs when the grouped loading state changes. The value is `true` while any mounted element is still loading.
|
|
51
55
|
*/
|
|
@@ -79,6 +83,10 @@ export interface CheckoutElementProps {
|
|
|
79
83
|
* @default false
|
|
80
84
|
*/
|
|
81
85
|
lockBuyerEmail?: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* Prefills what the host page already knows about the buyer. The buyer can edit every prefilled field, and a phone number or complete shipping address the session already holds wins over it. `phone` fills the checkout's phone number field when the seller collects one, in E.164 format such as `+14155552671`; when that field exists it also supplies the billing phone for methods that need one, so pass `phone` rather than `billingDetails.phone`. `shippingAddress` fills the shipping address when the checkout collects one (`country` is an ISO 3166-1 alpha-2 code; with a country the form cannot use, only the name is prefilled). `billingDetails` prefills the payment method's billing details like the payment element's `defaultValues.billingDetails`. Use `buyerEmail` for the email.
|
|
88
|
+
*/
|
|
89
|
+
defaultValues?: { phone?: string | undefined; shippingAddress?: { name?: string | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
82
90
|
}
|
|
83
91
|
|
|
84
92
|
/**
|
|
@@ -120,6 +128,10 @@ export interface CheckoutElementCreateOptions {
|
|
|
120
128
|
* @default false
|
|
121
129
|
*/
|
|
122
130
|
lockBuyerEmail?: boolean;
|
|
131
|
+
/**
|
|
132
|
+
* Prefills what the host page already knows about the buyer. The buyer can edit every prefilled field, and a phone number or complete shipping address the session already holds wins over it. `phone` fills the checkout's phone number field when the seller collects one, in E.164 format such as `+14155552671`; when that field exists it also supplies the billing phone for methods that need one, so pass `phone` rather than `billingDetails.phone`. `shippingAddress` fills the shipping address when the checkout collects one (`country` is an ISO 3166-1 alpha-2 code; with a country the form cannot use, only the name is prefilled). `billingDetails` prefills the payment method's billing details like the payment element's `defaultValues.billingDetails`. Use `buyerEmail` for the email.
|
|
133
|
+
*/
|
|
134
|
+
defaultValues?: { phone?: string | undefined; shippingAddress?: { name?: string | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
123
135
|
/**
|
|
124
136
|
* Runs after the loading skeleton first paints and before `onReady`.
|
|
125
137
|
*/
|
|
@@ -263,3 +275,51 @@ export interface CheckoutAttributionInput {
|
|
|
263
275
|
funnelId?: string | undefined;
|
|
264
276
|
source?: string | undefined;
|
|
265
277
|
}
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* The buyer paid.
|
|
281
|
+
* Declared from the app's `CheckoutPaymentCompletion`, referenced by a host-capability surface.
|
|
282
|
+
*/
|
|
283
|
+
export interface CheckoutPaymentCompletion {
|
|
284
|
+
/**
|
|
285
|
+
* The checkout session, prefixed `chs_`.
|
|
286
|
+
*/
|
|
287
|
+
sessionId: string;
|
|
288
|
+
result: "payment";
|
|
289
|
+
/**
|
|
290
|
+
* The payment, prefixed `pay_` — the id to record the purchase under.
|
|
291
|
+
*/
|
|
292
|
+
paymentId: string;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* The buyer joined a waitlist; nothing was charged.
|
|
297
|
+
* Declared from the app's `CheckoutWaitlistCompletion`, referenced by a host-capability surface.
|
|
298
|
+
*/
|
|
299
|
+
export interface CheckoutWaitlistCompletion {
|
|
300
|
+
/**
|
|
301
|
+
* The checkout session, prefixed `chs_`.
|
|
302
|
+
*/
|
|
303
|
+
sessionId: string;
|
|
304
|
+
result: "waitlist_entry";
|
|
305
|
+
/**
|
|
306
|
+
* The waitlist entry, prefixed `ent_`.
|
|
307
|
+
*/
|
|
308
|
+
entryId: string;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* A setup-mode checkout saved the buyer's payment method; nothing was charged.
|
|
313
|
+
* Declared from the app's `CheckoutSetupCompletion`, referenced by a host-capability surface.
|
|
314
|
+
*/
|
|
315
|
+
export interface CheckoutSetupCompletion {
|
|
316
|
+
/**
|
|
317
|
+
* The checkout session, prefixed `chs_`.
|
|
318
|
+
*/
|
|
319
|
+
sessionId: string;
|
|
320
|
+
result: "setup";
|
|
321
|
+
/**
|
|
322
|
+
* The saved setup, prefixed `sint_`.
|
|
323
|
+
*/
|
|
324
|
+
setupIntentId: string;
|
|
325
|
+
}
|
package/checkout.d.ts
CHANGED
|
@@ -43,9 +43,13 @@ export interface CheckoutOptions {
|
|
|
43
43
|
*/
|
|
44
44
|
metadata?: Record<string, string>;
|
|
45
45
|
/**
|
|
46
|
-
* Where the buyer lands after an off-site payment step. Https-only (http for localhost). Set at create only.
|
|
46
|
+
* Where the buyer lands after an off-site payment step, whatever its outcome. The tab arrives with `payment` (the `pay_` ID; `setup` with the `sint_` ID for a setup-mode checkout) and `status` (`succeeded`, `failed`, or `canceled`) appended, and your other query parameters intact. Branch on `status` before showing a success page: a declined or abandoned off-site step lands here too. Fulfill from webhooks, not from this visit. Https-only (http for localhost). Set at create only.
|
|
47
47
|
*/
|
|
48
48
|
returnUrl?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Fires once per mount when the checkout completes and its result stands. `result` says what stands: `payment` (the buyer paid — `paymentId`), `waitlist_entry` (the buyer joined a waitlist — `entryId`) or `setup` (a setup-mode checkout saved the payment method — `setupIntentId`); `sessionId` is the checkout session either way. Fires before any `returnUrl` navigation, so this is where your own analytics or ad pixels record the purchase. Fulfill from webhooks, not from this callback: a checkout restored on a later page load fires it again for the same result.
|
|
51
|
+
*/
|
|
52
|
+
onComplete?: ((payload: CheckoutPaymentCompletion | CheckoutWaitlistCompletion | CheckoutSetupCompletion) => void);
|
|
49
53
|
/**
|
|
50
54
|
* Runs when the grouped loading state changes. The value is `true` while any mounted element is still loading.
|
|
51
55
|
*/
|
|
@@ -79,6 +83,10 @@ export interface CheckoutElementProps {
|
|
|
79
83
|
* @default false
|
|
80
84
|
*/
|
|
81
85
|
lockBuyerEmail?: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* Prefills what the host page already knows about the buyer. The buyer can edit every prefilled field, and a phone number or complete shipping address the session already holds wins over it. `phone` fills the checkout's phone number field when the seller collects one, in E.164 format such as `+14155552671`; when that field exists it also supplies the billing phone for methods that need one, so pass `phone` rather than `billingDetails.phone`. `shippingAddress` fills the shipping address when the checkout collects one (`country` is an ISO 3166-1 alpha-2 code; with a country the form cannot use, only the name is prefilled). `billingDetails` prefills the payment method's billing details like the payment element's `defaultValues.billingDetails`. Use `buyerEmail` for the email.
|
|
88
|
+
*/
|
|
89
|
+
defaultValues?: { phone?: string | undefined; shippingAddress?: { name?: string | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
82
90
|
}
|
|
83
91
|
|
|
84
92
|
/**
|
|
@@ -120,6 +128,10 @@ export interface CheckoutElementCreateOptions {
|
|
|
120
128
|
* @default false
|
|
121
129
|
*/
|
|
122
130
|
lockBuyerEmail?: boolean;
|
|
131
|
+
/**
|
|
132
|
+
* Prefills what the host page already knows about the buyer. The buyer can edit every prefilled field, and a phone number or complete shipping address the session already holds wins over it. `phone` fills the checkout's phone number field when the seller collects one, in E.164 format such as `+14155552671`; when that field exists it also supplies the billing phone for methods that need one, so pass `phone` rather than `billingDetails.phone`. `shippingAddress` fills the shipping address when the checkout collects one (`country` is an ISO 3166-1 alpha-2 code; with a country the form cannot use, only the name is prefilled). `billingDetails` prefills the payment method's billing details like the payment element's `defaultValues.billingDetails`. Use `buyerEmail` for the email.
|
|
133
|
+
*/
|
|
134
|
+
defaultValues?: { phone?: string | undefined; shippingAddress?: { name?: string | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
123
135
|
/**
|
|
124
136
|
* Runs after the loading skeleton first paints and before `onReady`.
|
|
125
137
|
*/
|
|
@@ -263,3 +275,51 @@ export interface CheckoutAttributionInput {
|
|
|
263
275
|
funnelId?: string | undefined;
|
|
264
276
|
source?: string | undefined;
|
|
265
277
|
}
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* The buyer paid.
|
|
281
|
+
* Declared from the app's `CheckoutPaymentCompletion`, referenced by a host-capability surface.
|
|
282
|
+
*/
|
|
283
|
+
export interface CheckoutPaymentCompletion {
|
|
284
|
+
/**
|
|
285
|
+
* The checkout session, prefixed `chs_`.
|
|
286
|
+
*/
|
|
287
|
+
sessionId: string;
|
|
288
|
+
result: "payment";
|
|
289
|
+
/**
|
|
290
|
+
* The payment, prefixed `pay_` — the id to record the purchase under.
|
|
291
|
+
*/
|
|
292
|
+
paymentId: string;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* The buyer joined a waitlist; nothing was charged.
|
|
297
|
+
* Declared from the app's `CheckoutWaitlistCompletion`, referenced by a host-capability surface.
|
|
298
|
+
*/
|
|
299
|
+
export interface CheckoutWaitlistCompletion {
|
|
300
|
+
/**
|
|
301
|
+
* The checkout session, prefixed `chs_`.
|
|
302
|
+
*/
|
|
303
|
+
sessionId: string;
|
|
304
|
+
result: "waitlist_entry";
|
|
305
|
+
/**
|
|
306
|
+
* The waitlist entry, prefixed `ent_`.
|
|
307
|
+
*/
|
|
308
|
+
entryId: string;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* A setup-mode checkout saved the buyer's payment method; nothing was charged.
|
|
313
|
+
* Declared from the app's `CheckoutSetupCompletion`, referenced by a host-capability surface.
|
|
314
|
+
*/
|
|
315
|
+
export interface CheckoutSetupCompletion {
|
|
316
|
+
/**
|
|
317
|
+
* The checkout session, prefixed `chs_`.
|
|
318
|
+
*/
|
|
319
|
+
sessionId: string;
|
|
320
|
+
result: "setup";
|
|
321
|
+
/**
|
|
322
|
+
* The saved setup, prefixed `sint_`.
|
|
323
|
+
*/
|
|
324
|
+
setupIntentId: string;
|
|
325
|
+
}
|
package/dashboard.d.cts
CHANGED
|
@@ -89,7 +89,7 @@ export interface RequiredActionsElementCreateOptions {
|
|
|
89
89
|
/**
|
|
90
90
|
* The viewer pressed a banner button. Fires for every action, including ones the element also handles itself.
|
|
91
91
|
*/
|
|
92
|
-
onActionRequested?: ((payload: { action: "deposit_funds" | "review_held_payments" | "submit_information_request" | "update_automatic_withdrawal_method" | "reauthorize_payout_methods" | "update_payout_profile" | "card_usage_review" | "verify_identity" | "scale_account_setup" | "sign_formation_documents" | "connect_fulfillment_tracker" | "setup_apple_pay_domains" | "configure_tax_remitter" | "add_vat_registration" | "enable_two_factor_authentication"; accountId: string; }) => void);
|
|
92
|
+
onActionRequested?: ((payload: { action: "deposit_funds" | "review_held_payments" | "submit_information_request" | "update_automatic_withdrawal_method" | "reauthorize_payout_methods" | "update_payout_profile" | "card_usage_review" | "verify_identity" | "scale_account_setup" | "sign_formation_documents" | "connect_fulfillment_tracker" | "setup_apple_pay_domains" | "configure_tax_remitter" | "add_vat_registration" | "accept_payout_terms" | "enable_two_factor_authentication"; accountId: string; }) => void);
|
|
93
93
|
/**
|
|
94
94
|
* 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.
|
|
95
95
|
*/
|
package/dashboard.d.ts
CHANGED
|
@@ -89,7 +89,7 @@ export interface RequiredActionsElementCreateOptions {
|
|
|
89
89
|
/**
|
|
90
90
|
* The viewer pressed a banner button. Fires for every action, including ones the element also handles itself.
|
|
91
91
|
*/
|
|
92
|
-
onActionRequested?: ((payload: { action: "deposit_funds" | "review_held_payments" | "submit_information_request" | "update_automatic_withdrawal_method" | "reauthorize_payout_methods" | "update_payout_profile" | "card_usage_review" | "verify_identity" | "scale_account_setup" | "sign_formation_documents" | "connect_fulfillment_tracker" | "setup_apple_pay_domains" | "configure_tax_remitter" | "add_vat_registration" | "enable_two_factor_authentication"; accountId: string; }) => void);
|
|
92
|
+
onActionRequested?: ((payload: { action: "deposit_funds" | "review_held_payments" | "submit_information_request" | "update_automatic_withdrawal_method" | "reauthorize_payout_methods" | "update_payout_profile" | "card_usage_review" | "verify_identity" | "scale_account_setup" | "sign_formation_documents" | "connect_fulfillment_tracker" | "setup_apple_pay_domains" | "configure_tax_remitter" | "add_vat_registration" | "accept_payout_terms" | "enable_two_factor_authentication"; accountId: string; }) => void);
|
|
93
93
|
/**
|
|
94
94
|
* 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.
|
|
95
95
|
*/
|
package/index.d.cts
CHANGED
|
@@ -22,7 +22,7 @@ export interface Whop {
|
|
|
22
22
|
*/
|
|
23
23
|
verifications: { create(options: VerificationsOptions): VerificationsHandle } & VerificationsStatics;
|
|
24
24
|
/**
|
|
25
|
-
* Drives a full hosted checkout for one or more plans — itemized price summary, promo codes, the currency the buyer pays in, and the whole payment collection surface (the payments elements, composed inside) — against the Whop checkout sessions API. Mount it with `items`, a single `plan`, or a `checkoutConfiguration` you authored and the element opens the checkout session itself; the session credential never leaves the element. A setup-mode checkout configuration mounts the same element as a payment-method save: nothing is charged, the buyer’s method is stored for you to charge later, and the finished checkout redirects with `setup_intent_id`. The buyer pays inside the element, and a finished checkout redirects the current tab to `returnUrl`, including the page that contains the element. Fulfill from webhooks rather than a browser callback. Without a `returnUrl`, the buyer rests on the element’s own success face. The element automatically drives an off-site payment step, such as 3DS or a bank page. On whop.com, it brings the buyer back into the restored checkout; in an embed, the buyer returns to the same `returnUrl
|
|
25
|
+
* Drives a full hosted checkout for one or more plans — itemized price summary, promo codes, the currency the buyer pays in, and the whole payment collection surface (the payments elements, composed inside) — against the Whop checkout sessions API. Mount it with `items`, a single `plan`, or a `checkoutConfiguration` you authored and the element opens the checkout session itself; the session credential never leaves the element. A setup-mode checkout configuration mounts the same element as a payment-method save: nothing is charged, the buyer’s method is stored for you to charge later, and the finished checkout redirects with `setup_intent_id`. The buyer pays inside the element, and a finished checkout redirects the current tab to `returnUrl`, including the page that contains the element. Fulfill from webhooks rather than a browser callback. Without a `returnUrl`, the buyer rests on the element’s own success face. The element automatically drives an off-site payment step, such as 3DS or a bank page. On whop.com, it brings the buyer back into the restored checkout; in an embed, the buyer returns to the same `returnUrl` whatever the outcome, with `payment` and `status` query parameters (`succeeded`, `failed`, or `canceled`), so the page at `returnUrl` must read `status` before it treats the visit as a sale. A payment that fails inside the element reopens the same checkout with the reason shown, so the buyer can pay again. Every option is set at creation: the element mints a checkout session from these values when it mounts. Changing one later with `update()` or new React props fails instead of changing the existing order. Mount a new checkout to change what is being purchased.
|
|
26
26
|
*/
|
|
27
27
|
checkout: { create(options: CheckoutOptions): CheckoutHandle } & CheckoutStatics;
|
|
28
28
|
/**
|
package/index.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export interface Whop {
|
|
|
22
22
|
*/
|
|
23
23
|
verifications: { create(options: VerificationsOptions): VerificationsHandle } & VerificationsStatics;
|
|
24
24
|
/**
|
|
25
|
-
* Drives a full hosted checkout for one or more plans — itemized price summary, promo codes, the currency the buyer pays in, and the whole payment collection surface (the payments elements, composed inside) — against the Whop checkout sessions API. Mount it with `items`, a single `plan`, or a `checkoutConfiguration` you authored and the element opens the checkout session itself; the session credential never leaves the element. A setup-mode checkout configuration mounts the same element as a payment-method save: nothing is charged, the buyer’s method is stored for you to charge later, and the finished checkout redirects with `setup_intent_id`. The buyer pays inside the element, and a finished checkout redirects the current tab to `returnUrl`, including the page that contains the element. Fulfill from webhooks rather than a browser callback. Without a `returnUrl`, the buyer rests on the element’s own success face. The element automatically drives an off-site payment step, such as 3DS or a bank page. On whop.com, it brings the buyer back into the restored checkout; in an embed, the buyer returns to the same `returnUrl
|
|
25
|
+
* Drives a full hosted checkout for one or more plans — itemized price summary, promo codes, the currency the buyer pays in, and the whole payment collection surface (the payments elements, composed inside) — against the Whop checkout sessions API. Mount it with `items`, a single `plan`, or a `checkoutConfiguration` you authored and the element opens the checkout session itself; the session credential never leaves the element. A setup-mode checkout configuration mounts the same element as a payment-method save: nothing is charged, the buyer’s method is stored for you to charge later, and the finished checkout redirects with `setup_intent_id`. The buyer pays inside the element, and a finished checkout redirects the current tab to `returnUrl`, including the page that contains the element. Fulfill from webhooks rather than a browser callback. Without a `returnUrl`, the buyer rests on the element’s own success face. The element automatically drives an off-site payment step, such as 3DS or a bank page. On whop.com, it brings the buyer back into the restored checkout; in an embed, the buyer returns to the same `returnUrl` whatever the outcome, with `payment` and `status` query parameters (`succeeded`, `failed`, or `canceled`), so the page at `returnUrl` must read `status` before it treats the visit as a sale. A payment that fails inside the element reopens the same checkout with the reason shown, so the buyer can pay again. Every option is set at creation: the element mints a checkout session from these values when it mounts. Changing one later with `update()` or new React props fails instead of changing the existing order. Mount a new checkout to change what is being purchased.
|
|
26
26
|
*/
|
|
27
27
|
checkout: { create(options: CheckoutOptions): CheckoutHandle } & CheckoutStatics;
|
|
28
28
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@whop/elements",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Whop Elements — vanilla-js loader + types. Loads the hosted SDK and exposes the typed WhopElements factory.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"checkout",
|
|
@@ -97,5 +97,5 @@
|
|
|
97
97
|
}
|
|
98
98
|
}
|
|
99
99
|
},
|
|
100
|
-
"whopElementsApiHash": "
|
|
100
|
+
"whopElementsApiHash": "2b14d0c22a80bdf6595a304c0c3f516a3c4978e44a77ee608ad640a377b4bca8"
|
|
101
101
|
}
|
package/payments.d.cts
CHANGED
|
@@ -28,7 +28,7 @@ export type PaymentsOptions = (
|
|
|
28
28
|
*/
|
|
29
29
|
offerAmounts?: undefined;
|
|
30
30
|
/**
|
|
31
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
31
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
32
32
|
*/
|
|
33
33
|
returnUrl?: string;
|
|
34
34
|
/**
|
|
@@ -78,7 +78,7 @@ export type PaymentsOptions = (
|
|
|
78
78
|
*/
|
|
79
79
|
paymentMethodConfiguration?: { enabled?: string[] | undefined; disabled?: string[] | undefined; include_platform_defaults?: boolean | undefined; };
|
|
80
80
|
/**
|
|
81
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
81
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
82
82
|
*/
|
|
83
83
|
returnUrl?: string;
|
|
84
84
|
/**
|
|
@@ -132,7 +132,7 @@ export type PaymentsOptions = (
|
|
|
132
132
|
*/
|
|
133
133
|
paymentMethodConfiguration?: { enabled?: string[] | undefined; disabled?: string[] | undefined; include_platform_defaults?: boolean | undefined; };
|
|
134
134
|
/**
|
|
135
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
135
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
136
136
|
*/
|
|
137
137
|
returnUrl?: string;
|
|
138
138
|
/**
|
|
@@ -186,7 +186,7 @@ export type PaymentsOptions = (
|
|
|
186
186
|
*/
|
|
187
187
|
paymentMethodConfiguration?: undefined;
|
|
188
188
|
/**
|
|
189
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
189
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
190
190
|
*/
|
|
191
191
|
returnUrl?: string;
|
|
192
192
|
/**
|
|
@@ -236,6 +236,10 @@ export interface PaymentElementProps {
|
|
|
236
236
|
* @default {"billingDetails":"minimal"}
|
|
237
237
|
*/
|
|
238
238
|
fields?: { billingDetails?: "full" | "minimal" | "never" | undefined; phone?: "never" | "auto" | undefined; };
|
|
239
|
+
/**
|
|
240
|
+
* Prefills the billing details when each method's billing block first renders. The buyer can edit every prefilled field. `address.country` is an ISO 3166-1 alpha-2 code and applies only when the selected method accepts it. `phone` fills the billing phone input for methods that collect one, in E.164 format such as `+14155552671`; a number outside the method's supported phone countries is ignored. Only fields the block renders are prefilled and sent. Pass anything else to `createConfirmationToken` in `billingDetails`.
|
|
241
|
+
*/
|
|
242
|
+
defaultValues?: { billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
239
243
|
/**
|
|
240
244
|
* Picker layout. `accordion` (default) stacks methods and expands details inline. `horizontal` shows equal-width, non-scrolling tiles with selected details below. After four methods, a More tile opens a native selector. The method picked there occupies the final tile until the next selection. Selection and confirmation behave identically.
|
|
241
245
|
* @default "accordion"
|
|
@@ -296,6 +300,10 @@ export interface PaymentElementCreateOptions {
|
|
|
296
300
|
* @default {"billingDetails":"minimal"}
|
|
297
301
|
*/
|
|
298
302
|
fields?: { billingDetails?: "full" | "minimal" | "never" | undefined; phone?: "never" | "auto" | undefined; };
|
|
303
|
+
/**
|
|
304
|
+
* Prefills the billing details when each method's billing block first renders. The buyer can edit every prefilled field. `address.country` is an ISO 3166-1 alpha-2 code and applies only when the selected method accepts it. `phone` fills the billing phone input for methods that collect one, in E.164 format such as `+14155552671`; a number outside the method's supported phone countries is ignored. Only fields the block renders are prefilled and sent. Pass anything else to `createConfirmationToken` in `billingDetails`.
|
|
305
|
+
*/
|
|
306
|
+
defaultValues?: { billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
299
307
|
/**
|
|
300
308
|
* Picker layout. `accordion` (default) stacks methods and expands details inline. `horizontal` shows equal-width, non-scrolling tiles with selected details below. After four methods, a More tile opens a native selector. The method picked there occupies the final tile until the next selection. Selection and confirmation behave identically.
|
|
301
309
|
* @default "accordion"
|
|
@@ -339,25 +347,29 @@ export interface PaymentElementCreateOptions {
|
|
|
339
347
|
*/
|
|
340
348
|
export interface AddressElementProps {
|
|
341
349
|
/**
|
|
342
|
-
*
|
|
350
|
+
* Which address this collects: `billing` (default) or `shipping`. Also sets the browser autocomplete purpose. You can mount one of each under one handle. Billing details come from the billing element, or from the shipping element when no billing element is mounted.
|
|
343
351
|
* @default "billing"
|
|
344
352
|
*/
|
|
345
353
|
mode?: "billing" | "shipping";
|
|
346
354
|
/**
|
|
347
|
-
*
|
|
348
|
-
* @default "
|
|
355
|
+
* The name row: one full-name field (default), split first/last fields, or none.
|
|
356
|
+
* @default "combined"
|
|
349
357
|
*/
|
|
350
|
-
|
|
358
|
+
name?: "split" | "combined" | "none";
|
|
351
359
|
/**
|
|
352
360
|
* Address line 2: always visible (default), revealed by a text button (`toggle`), or never collected.
|
|
353
361
|
* @default "always"
|
|
354
362
|
*/
|
|
355
363
|
line2?: "never" | "toggle" | "always";
|
|
356
364
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @default "combined"
|
|
365
|
+
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
359
366
|
*/
|
|
360
|
-
name?: "
|
|
367
|
+
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
368
|
+
/**
|
|
369
|
+
* `full` (default) stacks labeled fields. `compact` groups placeholder-labeled fields within one border.
|
|
370
|
+
* @default "full"
|
|
371
|
+
*/
|
|
372
|
+
layout?: "full" | "compact";
|
|
361
373
|
/**
|
|
362
374
|
* `full` (default) follows the selected country's complete address format. `minimal` collects only country and postal code. `name` independently adds required name fields. Set `name` to `none` to omit them. This element does not add fields required by a payment method. Card confirmation requires a name, country, and postal code, so keep `name` enabled or pass `billingDetails.name`.
|
|
363
375
|
* @default "full"
|
|
@@ -368,10 +380,6 @@ export interface AddressElementProps {
|
|
|
368
380
|
* @default "none"
|
|
369
381
|
*/
|
|
370
382
|
organization?: "name" | "none" | "name_with_type";
|
|
371
|
-
/**
|
|
372
|
-
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
373
|
-
*/
|
|
374
|
-
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
375
383
|
/**
|
|
376
384
|
* Default the country from the buyer's IP (resolved before first paint). Falls back to the controller's `countryHint`, then US.
|
|
377
385
|
* @default true
|
|
@@ -435,25 +443,29 @@ export interface AddressElementHandle {
|
|
|
435
443
|
*/
|
|
436
444
|
export interface AddressElementCreateOptions {
|
|
437
445
|
/**
|
|
438
|
-
*
|
|
446
|
+
* Which address this collects: `billing` (default) or `shipping`. Also sets the browser autocomplete purpose. You can mount one of each under one handle. Billing details come from the billing element, or from the shipping element when no billing element is mounted.
|
|
439
447
|
* @default "billing"
|
|
440
448
|
*/
|
|
441
449
|
mode?: "billing" | "shipping";
|
|
442
450
|
/**
|
|
443
|
-
*
|
|
444
|
-
* @default "
|
|
451
|
+
* The name row: one full-name field (default), split first/last fields, or none.
|
|
452
|
+
* @default "combined"
|
|
445
453
|
*/
|
|
446
|
-
|
|
454
|
+
name?: "split" | "combined" | "none";
|
|
447
455
|
/**
|
|
448
456
|
* Address line 2: always visible (default), revealed by a text button (`toggle`), or never collected.
|
|
449
457
|
* @default "always"
|
|
450
458
|
*/
|
|
451
459
|
line2?: "never" | "toggle" | "always";
|
|
452
460
|
/**
|
|
453
|
-
*
|
|
454
|
-
* @default "combined"
|
|
461
|
+
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
455
462
|
*/
|
|
456
|
-
name?: "
|
|
463
|
+
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
464
|
+
/**
|
|
465
|
+
* `full` (default) stacks labeled fields. `compact` groups placeholder-labeled fields within one border.
|
|
466
|
+
* @default "full"
|
|
467
|
+
*/
|
|
468
|
+
layout?: "full" | "compact";
|
|
457
469
|
/**
|
|
458
470
|
* `full` (default) follows the selected country's complete address format. `minimal` collects only country and postal code. `name` independently adds required name fields. Set `name` to `none` to omit them. This element does not add fields required by a payment method. Card confirmation requires a name, country, and postal code, so keep `name` enabled or pass `billingDetails.name`.
|
|
459
471
|
* @default "full"
|
|
@@ -464,10 +476,6 @@ export interface AddressElementCreateOptions {
|
|
|
464
476
|
* @default "none"
|
|
465
477
|
*/
|
|
466
478
|
organization?: "name" | "none" | "name_with_type";
|
|
467
|
-
/**
|
|
468
|
-
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
469
|
-
*/
|
|
470
|
-
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
471
479
|
/**
|
|
472
480
|
* Default the country from the buyer's IP (resolved before first paint). Falls back to the controller's `countryHint`, then US.
|
|
473
481
|
* @default true
|
|
@@ -1055,7 +1063,7 @@ export interface PaymentRequestResource {
|
|
|
1055
1063
|
*/
|
|
1056
1064
|
show: (type: "apple_pay" | "google_pay", provided?: { email?: string | undefined; } | undefined) => Promise<PaymentRequestResult>;
|
|
1057
1065
|
/**
|
|
1058
|
-
* The sheet's shipping address changed (redacted pre-authorization: city/state/postal/country only).
|
|
1066
|
+
* The sheet's shipping address changed (redacted pre-authorization: city/state/postal/country only). An error in the answer that names a `field` (`city`, `state`, `postal_code`, `country`) marks that field in Apple Pay; Google Pay shows the message alone.
|
|
1059
1067
|
* Call `updateWith(…)` exactly once per event or the flow waits until the vendor times out.
|
|
1060
1068
|
* Returns the unsubscribe function.
|
|
1061
1069
|
*/
|
|
@@ -1096,6 +1104,7 @@ export interface PaymentsHandle {
|
|
|
1096
1104
|
create(name: "payment", options?: PaymentElementCreateOptions): PaymentElementHandle;
|
|
1097
1105
|
/**
|
|
1098
1106
|
* Collects a billing or shipping address. Fields, order, and validation follow the selected country. Includes street autocomplete and methods to read or validate the address.
|
|
1107
|
+
* One per "mode": call once per "mode" value; a second "address" with the same "mode" throws. "mode" is fixed at create.
|
|
1099
1108
|
*/
|
|
1100
1109
|
create(name: "address", options?: AddressElementCreateOptions): AddressElementHandle;
|
|
1101
1110
|
/**
|
|
@@ -1230,6 +1239,10 @@ export interface PaymentRequestResult {
|
|
|
1230
1239
|
export interface PaymentRequestError {
|
|
1231
1240
|
code?: "shipping_address_invalid" | "shipping_address_unserviceable" | "shipping_option_invalid" | "other" | undefined;
|
|
1232
1241
|
message: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* The address field the error is about: one of the fields the redacted address carries. Apple Pay marks that field with the message, whatever the `code`; Google Pay shows the message alone. Omit it for an error about the whole address.
|
|
1244
|
+
*/
|
|
1245
|
+
field?: "state" | "city" | "postal_code" | "country" | undefined;
|
|
1233
1246
|
}
|
|
1234
1247
|
|
|
1235
1248
|
/**
|
package/payments.d.ts
CHANGED
|
@@ -28,7 +28,7 @@ export type PaymentsOptions = (
|
|
|
28
28
|
*/
|
|
29
29
|
offerAmounts?: undefined;
|
|
30
30
|
/**
|
|
31
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
31
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
32
32
|
*/
|
|
33
33
|
returnUrl?: string;
|
|
34
34
|
/**
|
|
@@ -78,7 +78,7 @@ export type PaymentsOptions = (
|
|
|
78
78
|
*/
|
|
79
79
|
paymentMethodConfiguration?: { enabled?: string[] | undefined; disabled?: string[] | undefined; include_platform_defaults?: boolean | undefined; };
|
|
80
80
|
/**
|
|
81
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
81
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
82
82
|
*/
|
|
83
83
|
returnUrl?: string;
|
|
84
84
|
/**
|
|
@@ -132,7 +132,7 @@ export type PaymentsOptions = (
|
|
|
132
132
|
*/
|
|
133
133
|
paymentMethodConfiguration?: { enabled?: string[] | undefined; disabled?: string[] | undefined; include_platform_defaults?: boolean | undefined; };
|
|
134
134
|
/**
|
|
135
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
135
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
136
136
|
*/
|
|
137
137
|
returnUrl?: string;
|
|
138
138
|
/**
|
|
@@ -186,7 +186,7 @@ export type PaymentsOptions = (
|
|
|
186
186
|
*/
|
|
187
187
|
paymentMethodConfiguration?: undefined;
|
|
188
188
|
/**
|
|
189
|
-
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page.
|
|
189
|
+
* Return URL for off-site bank or 3DS steps. Defaults to the mounting page. The buyer lands there whatever the outcome, with `payment` (or `setup`), `status` (`succeeded`, `failed`, `canceled`, or a still-pending status such as `processing`), and `client_secret` appended, so branch on `status` before showing a success page.
|
|
190
190
|
*/
|
|
191
191
|
returnUrl?: string;
|
|
192
192
|
/**
|
|
@@ -236,6 +236,10 @@ export interface PaymentElementProps {
|
|
|
236
236
|
* @default {"billingDetails":"minimal"}
|
|
237
237
|
*/
|
|
238
238
|
fields?: { billingDetails?: "full" | "minimal" | "never" | undefined; phone?: "never" | "auto" | undefined; };
|
|
239
|
+
/**
|
|
240
|
+
* Prefills the billing details when each method's billing block first renders. The buyer can edit every prefilled field. `address.country` is an ISO 3166-1 alpha-2 code and applies only when the selected method accepts it. `phone` fills the billing phone input for methods that collect one, in E.164 format such as `+14155552671`; a number outside the method's supported phone countries is ignored. Only fields the block renders are prefilled and sent. Pass anything else to `createConfirmationToken` in `billingDetails`.
|
|
241
|
+
*/
|
|
242
|
+
defaultValues?: { billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
239
243
|
/**
|
|
240
244
|
* Picker layout. `accordion` (default) stacks methods and expands details inline. `horizontal` shows equal-width, non-scrolling tiles with selected details below. After four methods, a More tile opens a native selector. The method picked there occupies the final tile until the next selection. Selection and confirmation behave identically.
|
|
241
245
|
* @default "accordion"
|
|
@@ -296,6 +300,10 @@ export interface PaymentElementCreateOptions {
|
|
|
296
300
|
* @default {"billingDetails":"minimal"}
|
|
297
301
|
*/
|
|
298
302
|
fields?: { billingDetails?: "full" | "minimal" | "never" | undefined; phone?: "never" | "auto" | undefined; };
|
|
303
|
+
/**
|
|
304
|
+
* Prefills the billing details when each method's billing block first renders. The buyer can edit every prefilled field. `address.country` is an ISO 3166-1 alpha-2 code and applies only when the selected method accepts it. `phone` fills the billing phone input for methods that collect one, in E.164 format such as `+14155552671`; a number outside the method's supported phone countries is ignored. Only fields the block renders are prefilled and sent. Pass anything else to `createConfirmationToken` in `billingDetails`.
|
|
305
|
+
*/
|
|
306
|
+
defaultValues?: { billingDetails?: { name?: string | undefined; phone?: string | undefined; address?: { line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; } | undefined; };
|
|
299
307
|
/**
|
|
300
308
|
* Picker layout. `accordion` (default) stacks methods and expands details inline. `horizontal` shows equal-width, non-scrolling tiles with selected details below. After four methods, a More tile opens a native selector. The method picked there occupies the final tile until the next selection. Selection and confirmation behave identically.
|
|
301
309
|
* @default "accordion"
|
|
@@ -339,25 +347,29 @@ export interface PaymentElementCreateOptions {
|
|
|
339
347
|
*/
|
|
340
348
|
export interface AddressElementProps {
|
|
341
349
|
/**
|
|
342
|
-
*
|
|
350
|
+
* Which address this collects: `billing` (default) or `shipping`. Also sets the browser autocomplete purpose. You can mount one of each under one handle. Billing details come from the billing element, or from the shipping element when no billing element is mounted.
|
|
343
351
|
* @default "billing"
|
|
344
352
|
*/
|
|
345
353
|
mode?: "billing" | "shipping";
|
|
346
354
|
/**
|
|
347
|
-
*
|
|
348
|
-
* @default "
|
|
355
|
+
* The name row: one full-name field (default), split first/last fields, or none.
|
|
356
|
+
* @default "combined"
|
|
349
357
|
*/
|
|
350
|
-
|
|
358
|
+
name?: "split" | "combined" | "none";
|
|
351
359
|
/**
|
|
352
360
|
* Address line 2: always visible (default), revealed by a text button (`toggle`), or never collected.
|
|
353
361
|
* @default "always"
|
|
354
362
|
*/
|
|
355
363
|
line2?: "never" | "toggle" | "always";
|
|
356
364
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @default "combined"
|
|
365
|
+
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
359
366
|
*/
|
|
360
|
-
name?: "
|
|
367
|
+
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
368
|
+
/**
|
|
369
|
+
* `full` (default) stacks labeled fields. `compact` groups placeholder-labeled fields within one border.
|
|
370
|
+
* @default "full"
|
|
371
|
+
*/
|
|
372
|
+
layout?: "full" | "compact";
|
|
361
373
|
/**
|
|
362
374
|
* `full` (default) follows the selected country's complete address format. `minimal` collects only country and postal code. `name` independently adds required name fields. Set `name` to `none` to omit them. This element does not add fields required by a payment method. Card confirmation requires a name, country, and postal code, so keep `name` enabled or pass `billingDetails.name`.
|
|
363
375
|
* @default "full"
|
|
@@ -368,10 +380,6 @@ export interface AddressElementProps {
|
|
|
368
380
|
* @default "none"
|
|
369
381
|
*/
|
|
370
382
|
organization?: "name" | "none" | "name_with_type";
|
|
371
|
-
/**
|
|
372
|
-
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
373
|
-
*/
|
|
374
|
-
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
375
383
|
/**
|
|
376
384
|
* Default the country from the buyer's IP (resolved before first paint). Falls back to the controller's `countryHint`, then US.
|
|
377
385
|
* @default true
|
|
@@ -435,25 +443,29 @@ export interface AddressElementHandle {
|
|
|
435
443
|
*/
|
|
436
444
|
export interface AddressElementCreateOptions {
|
|
437
445
|
/**
|
|
438
|
-
*
|
|
446
|
+
* Which address this collects: `billing` (default) or `shipping`. Also sets the browser autocomplete purpose. You can mount one of each under one handle. Billing details come from the billing element, or from the shipping element when no billing element is mounted.
|
|
439
447
|
* @default "billing"
|
|
440
448
|
*/
|
|
441
449
|
mode?: "billing" | "shipping";
|
|
442
450
|
/**
|
|
443
|
-
*
|
|
444
|
-
* @default "
|
|
451
|
+
* The name row: one full-name field (default), split first/last fields, or none.
|
|
452
|
+
* @default "combined"
|
|
445
453
|
*/
|
|
446
|
-
|
|
454
|
+
name?: "split" | "combined" | "none";
|
|
447
455
|
/**
|
|
448
456
|
* Address line 2: always visible (default), revealed by a text button (`toggle`), or never collected.
|
|
449
457
|
* @default "always"
|
|
450
458
|
*/
|
|
451
459
|
line2?: "never" | "toggle" | "always";
|
|
452
460
|
/**
|
|
453
|
-
*
|
|
454
|
-
* @default "combined"
|
|
461
|
+
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
455
462
|
*/
|
|
456
|
-
name?: "
|
|
463
|
+
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
464
|
+
/**
|
|
465
|
+
* `full` (default) stacks labeled fields. `compact` groups placeholder-labeled fields within one border.
|
|
466
|
+
* @default "full"
|
|
467
|
+
*/
|
|
468
|
+
layout?: "full" | "compact";
|
|
457
469
|
/**
|
|
458
470
|
* `full` (default) follows the selected country's complete address format. `minimal` collects only country and postal code. `name` independently adds required name fields. Set `name` to `none` to omit them. This element does not add fields required by a payment method. Card confirmation requires a name, country, and postal code, so keep `name` enabled or pass `billingDetails.name`.
|
|
459
471
|
* @default "full"
|
|
@@ -464,10 +476,6 @@ export interface AddressElementCreateOptions {
|
|
|
464
476
|
* @default "none"
|
|
465
477
|
*/
|
|
466
478
|
organization?: "name" | "none" | "name_with_type";
|
|
467
|
-
/**
|
|
468
|
-
* Seed values applied once before first paint (`address.country` is an ISO 3166-1 alpha-2 country code). Takes precedence over IP-country detection.
|
|
469
|
-
*/
|
|
470
|
-
defaultValues?: { name?: string | undefined; address?: { name?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; organization?: string | undefined; organization_type?: "business" | "individual" | undefined; line1?: string | undefined; line2?: string | undefined; city?: string | undefined; state?: string | undefined; postal_code?: string | undefined; country?: string | undefined; } | undefined; };
|
|
471
479
|
/**
|
|
472
480
|
* Default the country from the buyer's IP (resolved before first paint). Falls back to the controller's `countryHint`, then US.
|
|
473
481
|
* @default true
|
|
@@ -1055,7 +1063,7 @@ export interface PaymentRequestResource {
|
|
|
1055
1063
|
*/
|
|
1056
1064
|
show: (type: "apple_pay" | "google_pay", provided?: { email?: string | undefined; } | undefined) => Promise<PaymentRequestResult>;
|
|
1057
1065
|
/**
|
|
1058
|
-
* The sheet's shipping address changed (redacted pre-authorization: city/state/postal/country only).
|
|
1066
|
+
* The sheet's shipping address changed (redacted pre-authorization: city/state/postal/country only). An error in the answer that names a `field` (`city`, `state`, `postal_code`, `country`) marks that field in Apple Pay; Google Pay shows the message alone.
|
|
1059
1067
|
* Call `updateWith(…)` exactly once per event or the flow waits until the vendor times out.
|
|
1060
1068
|
* Returns the unsubscribe function.
|
|
1061
1069
|
*/
|
|
@@ -1096,6 +1104,7 @@ export interface PaymentsHandle {
|
|
|
1096
1104
|
create(name: "payment", options?: PaymentElementCreateOptions): PaymentElementHandle;
|
|
1097
1105
|
/**
|
|
1098
1106
|
* Collects a billing or shipping address. Fields, order, and validation follow the selected country. Includes street autocomplete and methods to read or validate the address.
|
|
1107
|
+
* One per "mode": call once per "mode" value; a second "address" with the same "mode" throws. "mode" is fixed at create.
|
|
1099
1108
|
*/
|
|
1100
1109
|
create(name: "address", options?: AddressElementCreateOptions): AddressElementHandle;
|
|
1101
1110
|
/**
|
|
@@ -1230,6 +1239,10 @@ export interface PaymentRequestResult {
|
|
|
1230
1239
|
export interface PaymentRequestError {
|
|
1231
1240
|
code?: "shipping_address_invalid" | "shipping_address_unserviceable" | "shipping_option_invalid" | "other" | undefined;
|
|
1232
1241
|
message: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* The address field the error is about: one of the fields the redacted address carries. Apple Pay marks that field with the message, whatever the `code`; Google Pay shows the message alone. Omit it for an error about the whole address.
|
|
1244
|
+
*/
|
|
1245
|
+
field?: "state" | "city" | "postal_code" | "country" | undefined;
|
|
1233
1246
|
}
|
|
1234
1247
|
|
|
1235
1248
|
/**
|
package/wallet.d.cts
CHANGED
|
@@ -28,6 +28,10 @@ export interface WalletOptions {
|
|
|
28
28
|
* Account or user ID whose money these surfaces read. Account IDs are prefixed `biz_`; user IDs are prefixed `user_` and can read only the viewer's own balance.
|
|
29
29
|
*/
|
|
30
30
|
accountId: string;
|
|
31
|
+
/**
|
|
32
|
+
* A deposit requires identity verification. Handle this callback to open your settings or verification flow; Wallet does not navigate.
|
|
33
|
+
*/
|
|
34
|
+
onIdentityVerificationRequested?: ((payload: { accountId: string; }) => void);
|
|
31
35
|
/**
|
|
32
36
|
* Runs when the grouped loading state changes. The value is `true` while any mounted element is still loading.
|
|
33
37
|
*/
|
|
@@ -242,7 +246,7 @@ export interface ActivityElementProps {
|
|
|
242
246
|
* Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters.
|
|
243
247
|
* @default []
|
|
244
248
|
*/
|
|
245
|
-
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" | "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_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")[];
|
|
249
|
+
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" | "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" | "withdrawal_reversal")[];
|
|
246
250
|
/**
|
|
247
251
|
* Hide the filter chips, for a compact list that the viewer does not filter.
|
|
248
252
|
* @default false
|
|
@@ -308,7 +312,7 @@ export interface ActivityElementCreateOptions {
|
|
|
308
312
|
* Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters.
|
|
309
313
|
* @default []
|
|
310
314
|
*/
|
|
311
|
-
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" | "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_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")[];
|
|
315
|
+
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" | "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" | "withdrawal_reversal")[];
|
|
312
316
|
/**
|
|
313
317
|
* Hide the filter chips, for a compact list that the viewer does not filter.
|
|
314
318
|
* @default false
|
|
@@ -1342,7 +1346,7 @@ export interface CardDetailsElementProps {
|
|
|
1342
1346
|
/**
|
|
1343
1347
|
* Non-sensitive card metadata a host has already loaded. Supplying it saves the card face a list request; its authorized secrets are still fetched so the reveal stays instant.
|
|
1344
1348
|
*/
|
|
1345
|
-
card?: { name: string | null;
|
|
1349
|
+
card?: { id: string; name: string | null; status: "active" | "frozen" | "canceled" | "invited" | "denied" | null; last4: string | null; billing: Billing | null; expiration_month: string | null; expiration_year: string | null; };
|
|
1346
1350
|
/**
|
|
1347
1351
|
* The card this drawer describes, prefixed `icrd_`.
|
|
1348
1352
|
* @default ""
|
|
@@ -1401,7 +1405,7 @@ export interface CardDetailsElementCreateOptions {
|
|
|
1401
1405
|
/**
|
|
1402
1406
|
* Non-sensitive card metadata a host has already loaded. Supplying it saves the card face a list request; its authorized secrets are still fetched so the reveal stays instant.
|
|
1403
1407
|
*/
|
|
1404
|
-
card?: { name: string | null;
|
|
1408
|
+
card?: { id: string; name: string | null; status: "active" | "frozen" | "canceled" | "invited" | "denied" | null; last4: string | null; billing: Billing | null; expiration_month: string | null; expiration_year: string | null; };
|
|
1405
1409
|
/**
|
|
1406
1410
|
* The card this drawer describes, prefixed `icrd_`.
|
|
1407
1411
|
* @default ""
|
|
@@ -1726,7 +1730,7 @@ export interface BreakdownElementCreateOptions {
|
|
|
1726
1730
|
/**
|
|
1727
1731
|
* A balance row or its matching bar segment was clicked. The host can open details for `available`, `pending`, `reserve`, or `debt`.
|
|
1728
1732
|
*/
|
|
1729
|
-
onBreakdownSelected?: ((payload: { category: "available" | "
|
|
1733
|
+
onBreakdownSelected?: ((payload: { category: "available" | "pending" | "reserve" | "debt"; }) => void);
|
|
1730
1734
|
/**
|
|
1731
1735
|
* Runs after the loading skeleton first paints and before `onReady`.
|
|
1732
1736
|
*/
|
|
@@ -1928,6 +1932,10 @@ export interface ListElementCreateOptions {
|
|
|
1928
1932
|
* An account row was clicked, with `includeOwnedAccounts` on. `accountId` is the personal `user_…` tag or an owned `biz_…` tag, and `kind` lets you route without inspecting it. The element never navigates.
|
|
1929
1933
|
*/
|
|
1930
1934
|
onAccountSelected?: ((payload: { accountId: string; kind: "personal" | "business"; }) => void);
|
|
1935
|
+
/**
|
|
1936
|
+
* The Whop credits row was clicked. Credits are spendable on Whop only and never withdrawable, so they sit outside every holding row; the host opens its own credits screen. The element never navigates.
|
|
1937
|
+
*/
|
|
1938
|
+
onCreditsSelected?: ((payload: Record<string, never>) => void);
|
|
1931
1939
|
/**
|
|
1932
1940
|
* Runs after the loading skeleton first paints and before `onReady`.
|
|
1933
1941
|
*/
|
|
@@ -2832,7 +2840,7 @@ export interface LedgerActivity {
|
|
|
2832
2840
|
/**
|
|
2833
2841
|
* The ledger line category this activity was posted under.
|
|
2834
2842
|
*/
|
|
2835
|
-
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" | "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_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";
|
|
2843
|
+
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" | "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" | "deposit" | "wallet_transfer_incoming" | "wallet_transfer_outgoing" | "swap_source" | "swap_target";
|
|
2836
2844
|
/**
|
|
2837
2845
|
* Signed amount in the currency's smallest precision units.
|
|
2838
2846
|
*/
|
|
@@ -2850,7 +2858,7 @@ export interface LedgerActivity {
|
|
|
2850
2858
|
*/
|
|
2851
2859
|
posted_at: string;
|
|
2852
2860
|
/**
|
|
2853
|
-
* ISO 8601 timestamp
|
|
2861
|
+
* 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.
|
|
2854
2862
|
*/
|
|
2855
2863
|
available_at: string | null;
|
|
2856
2864
|
/**
|
|
@@ -2890,11 +2898,11 @@ export interface LedgerActivity {
|
|
|
2890
2898
|
*/
|
|
2891
2899
|
product_name?: string | null | undefined;
|
|
2892
2900
|
/**
|
|
2893
|
-
* ID of the
|
|
2901
|
+
* ID of the variant associated with the payment, when applicable.
|
|
2894
2902
|
*/
|
|
2895
2903
|
plan_id?: string | null | undefined;
|
|
2896
2904
|
/**
|
|
2897
|
-
* Name of the
|
|
2905
|
+
* Name of the variant associated with the payment, when applicable.
|
|
2898
2906
|
*/
|
|
2899
2907
|
plan_name?: string | null | undefined;
|
|
2900
2908
|
/**
|
|
@@ -3162,7 +3170,7 @@ export interface ReportActivityFilters {
|
|
|
3162
3170
|
postedAfter?: string | undefined;
|
|
3163
3171
|
postedBefore?: string | undefined;
|
|
3164
3172
|
direction?: "money_in" | "money_out" | undefined;
|
|
3165
|
-
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" | "economic_intelligence_percentage_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" | "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_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;
|
|
3173
|
+
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" | "economic_intelligence_percentage_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" | "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")[] | undefined;
|
|
3166
3174
|
resourceId?: string | undefined;
|
|
3167
3175
|
}
|
|
3168
3176
|
|
package/wallet.d.ts
CHANGED
|
@@ -28,6 +28,10 @@ export interface WalletOptions {
|
|
|
28
28
|
* Account or user ID whose money these surfaces read. Account IDs are prefixed `biz_`; user IDs are prefixed `user_` and can read only the viewer's own balance.
|
|
29
29
|
*/
|
|
30
30
|
accountId: string;
|
|
31
|
+
/**
|
|
32
|
+
* A deposit requires identity verification. Handle this callback to open your settings or verification flow; Wallet does not navigate.
|
|
33
|
+
*/
|
|
34
|
+
onIdentityVerificationRequested?: ((payload: { accountId: string; }) => void);
|
|
31
35
|
/**
|
|
32
36
|
* Runs when the grouped loading state changes. The value is `true` while any mounted element is still loading.
|
|
33
37
|
*/
|
|
@@ -242,7 +246,7 @@ export interface ActivityElementProps {
|
|
|
242
246
|
* Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters.
|
|
243
247
|
* @default []
|
|
244
248
|
*/
|
|
245
|
-
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" | "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_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")[];
|
|
249
|
+
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" | "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" | "withdrawal_reversal")[];
|
|
246
250
|
/**
|
|
247
251
|
* Hide the filter chips, for a compact list that the viewer does not filter.
|
|
248
252
|
* @default false
|
|
@@ -308,7 +312,7 @@ export interface ActivityElementCreateOptions {
|
|
|
308
312
|
* Activity types selected when the element mounts or its account changes. The viewer can change them with the built-in filters.
|
|
309
313
|
* @default []
|
|
310
314
|
*/
|
|
311
|
-
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" | "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_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")[];
|
|
315
|
+
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" | "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" | "withdrawal_reversal")[];
|
|
312
316
|
/**
|
|
313
317
|
* Hide the filter chips, for a compact list that the viewer does not filter.
|
|
314
318
|
* @default false
|
|
@@ -1342,7 +1346,7 @@ export interface CardDetailsElementProps {
|
|
|
1342
1346
|
/**
|
|
1343
1347
|
* Non-sensitive card metadata a host has already loaded. Supplying it saves the card face a list request; its authorized secrets are still fetched so the reveal stays instant.
|
|
1344
1348
|
*/
|
|
1345
|
-
card?: { name: string | null;
|
|
1349
|
+
card?: { id: string; name: string | null; status: "active" | "frozen" | "canceled" | "invited" | "denied" | null; last4: string | null; billing: Billing | null; expiration_month: string | null; expiration_year: string | null; };
|
|
1346
1350
|
/**
|
|
1347
1351
|
* The card this drawer describes, prefixed `icrd_`.
|
|
1348
1352
|
* @default ""
|
|
@@ -1401,7 +1405,7 @@ export interface CardDetailsElementCreateOptions {
|
|
|
1401
1405
|
/**
|
|
1402
1406
|
* Non-sensitive card metadata a host has already loaded. Supplying it saves the card face a list request; its authorized secrets are still fetched so the reveal stays instant.
|
|
1403
1407
|
*/
|
|
1404
|
-
card?: { name: string | null;
|
|
1408
|
+
card?: { id: string; name: string | null; status: "active" | "frozen" | "canceled" | "invited" | "denied" | null; last4: string | null; billing: Billing | null; expiration_month: string | null; expiration_year: string | null; };
|
|
1405
1409
|
/**
|
|
1406
1410
|
* The card this drawer describes, prefixed `icrd_`.
|
|
1407
1411
|
* @default ""
|
|
@@ -1726,7 +1730,7 @@ export interface BreakdownElementCreateOptions {
|
|
|
1726
1730
|
/**
|
|
1727
1731
|
* A balance row or its matching bar segment was clicked. The host can open details for `available`, `pending`, `reserve`, or `debt`.
|
|
1728
1732
|
*/
|
|
1729
|
-
onBreakdownSelected?: ((payload: { category: "available" | "
|
|
1733
|
+
onBreakdownSelected?: ((payload: { category: "available" | "pending" | "reserve" | "debt"; }) => void);
|
|
1730
1734
|
/**
|
|
1731
1735
|
* Runs after the loading skeleton first paints and before `onReady`.
|
|
1732
1736
|
*/
|
|
@@ -1928,6 +1932,10 @@ export interface ListElementCreateOptions {
|
|
|
1928
1932
|
* An account row was clicked, with `includeOwnedAccounts` on. `accountId` is the personal `user_…` tag or an owned `biz_…` tag, and `kind` lets you route without inspecting it. The element never navigates.
|
|
1929
1933
|
*/
|
|
1930
1934
|
onAccountSelected?: ((payload: { accountId: string; kind: "personal" | "business"; }) => void);
|
|
1935
|
+
/**
|
|
1936
|
+
* The Whop credits row was clicked. Credits are spendable on Whop only and never withdrawable, so they sit outside every holding row; the host opens its own credits screen. The element never navigates.
|
|
1937
|
+
*/
|
|
1938
|
+
onCreditsSelected?: ((payload: Record<string, never>) => void);
|
|
1931
1939
|
/**
|
|
1932
1940
|
* Runs after the loading skeleton first paints and before `onReady`.
|
|
1933
1941
|
*/
|
|
@@ -2832,7 +2840,7 @@ export interface LedgerActivity {
|
|
|
2832
2840
|
/**
|
|
2833
2841
|
* The ledger line category this activity was posted under.
|
|
2834
2842
|
*/
|
|
2835
|
-
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" | "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_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";
|
|
2843
|
+
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" | "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" | "deposit" | "wallet_transfer_incoming" | "wallet_transfer_outgoing" | "swap_source" | "swap_target";
|
|
2836
2844
|
/**
|
|
2837
2845
|
* Signed amount in the currency's smallest precision units.
|
|
2838
2846
|
*/
|
|
@@ -2850,7 +2858,7 @@ export interface LedgerActivity {
|
|
|
2850
2858
|
*/
|
|
2851
2859
|
posted_at: string;
|
|
2852
2860
|
/**
|
|
2853
|
-
* ISO 8601 timestamp
|
|
2861
|
+
* 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.
|
|
2854
2862
|
*/
|
|
2855
2863
|
available_at: string | null;
|
|
2856
2864
|
/**
|
|
@@ -2890,11 +2898,11 @@ export interface LedgerActivity {
|
|
|
2890
2898
|
*/
|
|
2891
2899
|
product_name?: string | null | undefined;
|
|
2892
2900
|
/**
|
|
2893
|
-
* ID of the
|
|
2901
|
+
* ID of the variant associated with the payment, when applicable.
|
|
2894
2902
|
*/
|
|
2895
2903
|
plan_id?: string | null | undefined;
|
|
2896
2904
|
/**
|
|
2897
|
-
* Name of the
|
|
2905
|
+
* Name of the variant associated with the payment, when applicable.
|
|
2898
2906
|
*/
|
|
2899
2907
|
plan_name?: string | null | undefined;
|
|
2900
2908
|
/**
|
|
@@ -3162,7 +3170,7 @@ export interface ReportActivityFilters {
|
|
|
3162
3170
|
postedAfter?: string | undefined;
|
|
3163
3171
|
postedBefore?: string | undefined;
|
|
3164
3172
|
direction?: "money_in" | "money_out" | undefined;
|
|
3165
|
-
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" | "economic_intelligence_percentage_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" | "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_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;
|
|
3173
|
+
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" | "economic_intelligence_percentage_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" | "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")[] | undefined;
|
|
3166
3174
|
resourceId?: string | undefined;
|
|
3167
3175
|
}
|
|
3168
3176
|
|