@delopay/sdk 0.83.0 → 0.86.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/dist/{chunk-G44EQT6Q.js → chunk-DQ36QCU7.js} +680 -4
- package/dist/chunk-DQ36QCU7.js.map +1 -0
- package/dist/index.cjs +682 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1219 -9
- package/dist/index.d.ts +1219 -9
- package/dist/index.js +7 -1
- package/dist/internal.cjs +888 -3
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +312 -3
- package/dist/internal.d.ts +312 -3
- package/dist/internal.js +213 -1
- package/dist/internal.js.map +1 -1
- package/package.json +1 -1
- package/dist/chunk-G44EQT6Q.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1203,15 +1203,22 @@ interface ShopResponse {
|
|
|
1203
1203
|
*/
|
|
1204
1204
|
payment_id_format?: PaymentIdFormatConfig | null;
|
|
1205
1205
|
}
|
|
1206
|
-
/**
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1206
|
+
/**
|
|
1207
|
+
* Branding and behavior overrides for a shop's hosted checkout.
|
|
1208
|
+
*
|
|
1209
|
+
* On the wire the {@link PaymentLinkConfigRequest} fields sit at the TOP
|
|
1210
|
+
* LEVEL of `payment_link_config` (the backend flattens them), with the
|
|
1211
|
+
* fields declared below alongside them.
|
|
1212
|
+
*/
|
|
1213
|
+
interface BusinessPaymentLinkConfig extends PaymentLinkConfigRequest {
|
|
1214
|
+
/** Custom domain name used to host the link on the merchant's own domain. */
|
|
1215
|
+
domain_name?: string | null;
|
|
1210
1216
|
/** Per-sub-business overrides, keyed by a merchant-defined identifier. */
|
|
1211
1217
|
business_specific_configs?: Record<string, PaymentLinkConfigRequest> | null;
|
|
1212
|
-
/** Host domains the payment link may be
|
|
1218
|
+
/** Host domains (glob patterns) the payment link may be embedded / opened from. */
|
|
1213
1219
|
allowed_domains?: string[] | null;
|
|
1214
|
-
|
|
1220
|
+
/** Toggle for DeloPay branding visibility. */
|
|
1221
|
+
branding_visibility?: boolean | null;
|
|
1215
1222
|
}
|
|
1216
1223
|
/** Appearance and behavior customization for the hosted checkout. */
|
|
1217
1224
|
interface PaymentLinkConfigRequest {
|
|
@@ -2273,6 +2280,16 @@ interface UserResponse {
|
|
|
2273
2280
|
verification_days_left?: number | null;
|
|
2274
2281
|
recovery_codes_left?: number | null;
|
|
2275
2282
|
theme_id?: string | null;
|
|
2283
|
+
/**
|
|
2284
|
+
* The caller's user-scoped metadata bucket (free-form JSON), as updated by
|
|
2285
|
+
* `users.updateMetadata`. Absent/null = bucket unused.
|
|
2286
|
+
*/
|
|
2287
|
+
user_metadata?: Record<string, unknown> | null;
|
|
2288
|
+
/**
|
|
2289
|
+
* The merchant-scoped metadata bucket shared by every dashboard user of
|
|
2290
|
+
* the merchant, as updated by `users.updateMerchantMetadata`.
|
|
2291
|
+
*/
|
|
2292
|
+
merchant_metadata?: Record<string, unknown> | null;
|
|
2276
2293
|
}
|
|
2277
2294
|
interface ChangePasswordRequest {
|
|
2278
2295
|
old_password: string;
|
|
@@ -2972,6 +2989,44 @@ interface SubscriptionPaymentData {
|
|
|
2972
2989
|
payment_type?: string | null;
|
|
2973
2990
|
payment_token?: string | null;
|
|
2974
2991
|
}
|
|
2992
|
+
/**
|
|
2993
|
+
* Ask which of these payments were raised by a subscription.
|
|
2994
|
+
*
|
|
2995
|
+
* The linkage exists in one direction only: an invoice points at the payment it
|
|
2996
|
+
* settled, and nothing is stamped on the payment itself. So a caller holding a
|
|
2997
|
+
* page of payments — a transactions list, a reconciliation export — cannot tell
|
|
2998
|
+
* subscription charges from one-off ones without asking.
|
|
2999
|
+
*
|
|
3000
|
+
* Do **not** infer it from `off_session` or the presence of a mandate. A saved
|
|
3001
|
+
* card charged in the background looks identical there, and would be mislabelled
|
|
3002
|
+
* as a subscription.
|
|
3003
|
+
*
|
|
3004
|
+
* Batched on purpose: resolve a whole page in one call. The backend accepts at
|
|
3005
|
+
* most **200** ids per request.
|
|
3006
|
+
*/
|
|
3007
|
+
interface SubscriptionPaymentLookupRequest {
|
|
3008
|
+
payment_ids: string[];
|
|
3009
|
+
}
|
|
3010
|
+
/** One resolved payment → subscription link. */
|
|
3011
|
+
interface SubscriptionPaymentLink {
|
|
3012
|
+
/** The payment that was asked about. */
|
|
3013
|
+
payment_id: string;
|
|
3014
|
+
/** The subscription that raised it. */
|
|
3015
|
+
subscription_id: string;
|
|
3016
|
+
/** The invoice (billing cycle) the payment settles. */
|
|
3017
|
+
invoice_id: string;
|
|
3018
|
+
invoice_status: InvoiceStatus;
|
|
3019
|
+
}
|
|
3020
|
+
interface SubscriptionPaymentLookupResponse {
|
|
3021
|
+
/**
|
|
3022
|
+
* Only the payments that resolved to a subscription, in no guaranteed order.
|
|
3023
|
+
*
|
|
3024
|
+
* An id that is absent is not an error — it means "not a subscription
|
|
3025
|
+
* payment". A page mixing the two is the normal case, so match on presence
|
|
3026
|
+
* rather than expecting one entry per id.
|
|
3027
|
+
*/
|
|
3028
|
+
links: SubscriptionPaymentLink[];
|
|
3029
|
+
}
|
|
2975
3030
|
/** A single invoice raised for one billing cycle of a subscription. */
|
|
2976
3031
|
interface SubscriptionInvoice {
|
|
2977
3032
|
id: string;
|
|
@@ -3533,6 +3588,668 @@ interface AnalyticsScopeResponse {
|
|
|
3533
3588
|
*/
|
|
3534
3589
|
methods?: AnalyticsMethodSlice[];
|
|
3535
3590
|
}
|
|
3591
|
+
/** Payout progress of a settlement statement. */
|
|
3592
|
+
type SettlementPayoutStatus = 'unpaid' | 'partial' | 'paid';
|
|
3593
|
+
/**
|
|
3594
|
+
* Who owns the connector a settlement line ran through. `unknown` marks
|
|
3595
|
+
* lines frozen before ownership tracking existed.
|
|
3596
|
+
*/
|
|
3597
|
+
type ConnectorOwnership = 'host' | 'shop' | 'unknown';
|
|
3598
|
+
/**
|
|
3599
|
+
* Per-connector/currency rollup inside a statement or current-period view.
|
|
3600
|
+
* Amounts are native minor units of `currency`.
|
|
3601
|
+
*/
|
|
3602
|
+
interface SettlementBucket {
|
|
3603
|
+
connector?: string | null;
|
|
3604
|
+
ownership: ConnectorOwnership;
|
|
3605
|
+
currency: string;
|
|
3606
|
+
gross_amount: number;
|
|
3607
|
+
platform_fee_amount: number;
|
|
3608
|
+
/**
|
|
3609
|
+
* `true` when at least one line in this bucket is still awaiting its
|
|
3610
|
+
* platform-fee figure. Absent platform-fee fields on shop-owner reads are
|
|
3611
|
+
* a server-side permission boundary, not a gap — never re-derive them.
|
|
3612
|
+
*/
|
|
3613
|
+
platform_fee_incomplete: boolean;
|
|
3614
|
+
merchant_fee_amount: number;
|
|
3615
|
+
refund_amount: number;
|
|
3616
|
+
net_to_shop: number;
|
|
3617
|
+
line_count: number;
|
|
3618
|
+
refund_count: number;
|
|
3619
|
+
/** Fee schedule applied, e.g. `"2.9"` percent. Absent when mixed. */
|
|
3620
|
+
fee_percentage?: string | null;
|
|
3621
|
+
fee_flat_amount?: number | null;
|
|
3622
|
+
}
|
|
3623
|
+
/** One generated monthly settlement statement. All `*_usd` amounts are USD minor units. */
|
|
3624
|
+
interface FeeStatementSummary {
|
|
3625
|
+
id: string;
|
|
3626
|
+
merchant_id: string;
|
|
3627
|
+
profile_id: string;
|
|
3628
|
+
/** ISO-8601 period start (UTC). */
|
|
3629
|
+
period_start: string;
|
|
3630
|
+
/** ISO-8601 period end (UTC). */
|
|
3631
|
+
period_end: string;
|
|
3632
|
+
test_mode: boolean;
|
|
3633
|
+
gross_usd: number;
|
|
3634
|
+
platform_fee_usd: number;
|
|
3635
|
+
merchant_fee_usd: number;
|
|
3636
|
+
refund_usd: number;
|
|
3637
|
+
net_to_shop_usd: number;
|
|
3638
|
+
line_count: number;
|
|
3639
|
+
refund_count: number;
|
|
3640
|
+
fx_incomplete: boolean;
|
|
3641
|
+
platform_fee_incomplete: boolean;
|
|
3642
|
+
includes_backfill: boolean;
|
|
3643
|
+
payout_status: SettlementPayoutStatus;
|
|
3644
|
+
paid_amount_usd: number;
|
|
3645
|
+
paid_at?: string | null;
|
|
3646
|
+
payout_note?: string | null;
|
|
3647
|
+
generated_at: string;
|
|
3648
|
+
/**
|
|
3649
|
+
* Signed sum of manual adjustments, USD minor units. Positive means the
|
|
3650
|
+
* shop owner owes more (their payout shrinks).
|
|
3651
|
+
*/
|
|
3652
|
+
adjustments_usd: number;
|
|
3653
|
+
/**
|
|
3654
|
+
* `net_to_shop_usd - adjustments_usd`: what the shop owner is actually
|
|
3655
|
+
* paid once the host's positions are applied. **This is the payable
|
|
3656
|
+
* figure** — `net_to_shop_usd` is the computed sub-total before them.
|
|
3657
|
+
*/
|
|
3658
|
+
net_after_adjustments_usd: number;
|
|
3659
|
+
}
|
|
3660
|
+
/** A statement with its per-connector/currency breakdown. */
|
|
3661
|
+
interface FeeStatementDetail extends FeeStatementSummary {
|
|
3662
|
+
breakdown: SettlementBucket[];
|
|
3663
|
+
}
|
|
3664
|
+
interface SettlementStatementListParams {
|
|
3665
|
+
/**
|
|
3666
|
+
* Statement environment. Required so test and live figures can never
|
|
3667
|
+
* blend by accident: `false` is transmitted, not dropped.
|
|
3668
|
+
*/
|
|
3669
|
+
test_mode: boolean;
|
|
3670
|
+
/** Restrict to one shop. Enforced from the token for shop-owner callers. */
|
|
3671
|
+
profile_id?: string;
|
|
3672
|
+
limit?: number;
|
|
3673
|
+
offset?: number;
|
|
3674
|
+
}
|
|
3675
|
+
interface SettlementStatementListResponse {
|
|
3676
|
+
statements: FeeStatementSummary[];
|
|
3677
|
+
total_count: number;
|
|
3678
|
+
}
|
|
3679
|
+
interface SettlementOverviewParams {
|
|
3680
|
+
/** Environment switch — see {@link SettlementStatementListParams.test_mode}. */
|
|
3681
|
+
test_mode: boolean;
|
|
3682
|
+
}
|
|
3683
|
+
/** Per-shop settlement rollup for the host merchant's overview. */
|
|
3684
|
+
interface ShopSettlementOverview {
|
|
3685
|
+
profile_id: string;
|
|
3686
|
+
profile_name?: string | null;
|
|
3687
|
+
unpaid_net_usd: number;
|
|
3688
|
+
unpaid_statement_count: number;
|
|
3689
|
+
current_period_net_usd: number;
|
|
3690
|
+
current_period_merchant_fee_usd: number;
|
|
3691
|
+
current_period_gross_usd: number;
|
|
3692
|
+
fx_incomplete: boolean;
|
|
3693
|
+
has_fee_config: boolean;
|
|
3694
|
+
visible_to_shop: boolean;
|
|
3695
|
+
}
|
|
3696
|
+
interface SettlementOverviewResponse {
|
|
3697
|
+
shops: ShopSettlementOverview[];
|
|
3698
|
+
}
|
|
3699
|
+
interface SettlementCurrentParams {
|
|
3700
|
+
/** Environment switch — see {@link SettlementStatementListParams.test_mode}. */
|
|
3701
|
+
test_mode: boolean;
|
|
3702
|
+
profile_id?: string;
|
|
3703
|
+
}
|
|
3704
|
+
/** Live rollup of the current (not yet statemented) period. */
|
|
3705
|
+
interface SettlementCurrentResponse {
|
|
3706
|
+
period_start: string;
|
|
3707
|
+
period_end: string;
|
|
3708
|
+
test_mode: boolean;
|
|
3709
|
+
gross_usd: number;
|
|
3710
|
+
platform_fee_usd: number;
|
|
3711
|
+
merchant_fee_usd: number;
|
|
3712
|
+
refund_usd: number;
|
|
3713
|
+
net_to_shop_usd: number;
|
|
3714
|
+
line_count: number;
|
|
3715
|
+
refund_count: number;
|
|
3716
|
+
fx_incomplete: boolean;
|
|
3717
|
+
platform_fee_incomplete: boolean;
|
|
3718
|
+
breakdown: SettlementBucket[];
|
|
3719
|
+
}
|
|
3720
|
+
interface StatementGenerateRequest {
|
|
3721
|
+
profile_id: string;
|
|
3722
|
+
/** Calendar year (UTC). */
|
|
3723
|
+
year: number;
|
|
3724
|
+
/** Calendar month 1..=12 (UTC). */
|
|
3725
|
+
month: number;
|
|
3726
|
+
/** Environment switch — see {@link SettlementStatementListParams.test_mode}. */
|
|
3727
|
+
test_mode: boolean;
|
|
3728
|
+
}
|
|
3729
|
+
interface StatementPayoutUpdateRequest {
|
|
3730
|
+
payout_status: SettlementPayoutStatus;
|
|
3731
|
+
/**
|
|
3732
|
+
* Amount handed over so far, USD minor units — makes `partial` a real
|
|
3733
|
+
* figure. Omitted it defaults to the full net for `paid` and zero for
|
|
3734
|
+
* `unpaid`.
|
|
3735
|
+
*/
|
|
3736
|
+
paid_amount_usd?: number;
|
|
3737
|
+
/** ISO-8601. Defaults to now (UTC) when marking `paid` without a date. */
|
|
3738
|
+
paid_at?: string;
|
|
3739
|
+
note?: string;
|
|
3740
|
+
}
|
|
3741
|
+
interface StatementPdfParams {
|
|
3742
|
+
/** ISO currency the PDF totals are converted to. Default USD. */
|
|
3743
|
+
currency?: string;
|
|
3744
|
+
/** Append a per-transaction table. Off by default. */
|
|
3745
|
+
include_transactions?: boolean;
|
|
3746
|
+
}
|
|
3747
|
+
/** One manual statement adjustment. Positive charges the shop, negative credits them. */
|
|
3748
|
+
interface StatementAdjustment {
|
|
3749
|
+
id: string;
|
|
3750
|
+
label: string;
|
|
3751
|
+
/** Signed USD minor units. */
|
|
3752
|
+
amount_usd: number;
|
|
3753
|
+
created_at: string;
|
|
3754
|
+
}
|
|
3755
|
+
interface StatementAdjustmentListResponse {
|
|
3756
|
+
adjustments: StatementAdjustment[];
|
|
3757
|
+
}
|
|
3758
|
+
interface StatementAdjustmentCreateRequest {
|
|
3759
|
+
label: string;
|
|
3760
|
+
/** Signed USD minor units. Positive charges the shop; negative credits them. */
|
|
3761
|
+
amount_usd: number;
|
|
3762
|
+
}
|
|
3763
|
+
interface SettlementLineListParams {
|
|
3764
|
+
profile_id: string;
|
|
3765
|
+
/** Calendar year (UTC) of the period to list. */
|
|
3766
|
+
year: number;
|
|
3767
|
+
/** Calendar month 1..=12 (UTC). */
|
|
3768
|
+
month: number;
|
|
3769
|
+
/** Environment switch — see {@link SettlementStatementListParams.test_mode}. */
|
|
3770
|
+
test_mode: boolean;
|
|
3771
|
+
limit?: number;
|
|
3772
|
+
offset?: number;
|
|
3773
|
+
}
|
|
3774
|
+
/** One settled payment attempt. Amounts are native minor units of `currency`. */
|
|
3775
|
+
interface SettlementLine {
|
|
3776
|
+
payment_id: string;
|
|
3777
|
+
attempt_id: string;
|
|
3778
|
+
connector?: string | null;
|
|
3779
|
+
connector_ownership: ConnectorOwnership;
|
|
3780
|
+
payment_method?: string | null;
|
|
3781
|
+
payment_method_type?: string | null;
|
|
3782
|
+
currency: string;
|
|
3783
|
+
gross_amount: number;
|
|
3784
|
+
platform_fee_amount: number;
|
|
3785
|
+
merchant_fee_amount: number;
|
|
3786
|
+
net_to_shop: number;
|
|
3787
|
+
merchant_fee_source: string;
|
|
3788
|
+
/** Absent on shop-owner reads — server-side redaction, never re-derive. */
|
|
3789
|
+
platform_fee_source?: string | null;
|
|
3790
|
+
merchant_ledger_outcome: string;
|
|
3791
|
+
test_mode: boolean;
|
|
3792
|
+
backfilled: boolean;
|
|
3793
|
+
transaction_at: string;
|
|
3794
|
+
}
|
|
3795
|
+
interface SettlementLineListResponse {
|
|
3796
|
+
lines: SettlementLine[];
|
|
3797
|
+
total_count: number;
|
|
3798
|
+
}
|
|
3799
|
+
interface ShopFeeConfigParams {
|
|
3800
|
+
profile_id: string;
|
|
3801
|
+
}
|
|
3802
|
+
/** One fee schedule that applies to a shop. */
|
|
3803
|
+
interface ShopFeeConfigEntry {
|
|
3804
|
+
schedule_id: string;
|
|
3805
|
+
connector?: string | null;
|
|
3806
|
+
profile_specific: boolean;
|
|
3807
|
+
fee_type: string;
|
|
3808
|
+
percentage_fee?: number | null;
|
|
3809
|
+
flat_fee_amount?: number | null;
|
|
3810
|
+
flat_fee_currency?: string | null;
|
|
3811
|
+
min_fee_amount?: number | null;
|
|
3812
|
+
max_fee_amount?: number | null;
|
|
3813
|
+
}
|
|
3814
|
+
interface ShopFeeConfigResponse {
|
|
3815
|
+
profile_id: string;
|
|
3816
|
+
schedules: ShopFeeConfigEntry[];
|
|
3817
|
+
}
|
|
3818
|
+
interface SettlementBackfillRequest {
|
|
3819
|
+
/** Restrict to one shop; omitted = all shops of the merchant. */
|
|
3820
|
+
profile_id?: string;
|
|
3821
|
+
/** ISO-8601 inclusive start (UTC). Omitted = beginning of time. */
|
|
3822
|
+
from?: string;
|
|
3823
|
+
/** ISO-8601 exclusive end (UTC). Omitted = now. */
|
|
3824
|
+
to?: string;
|
|
3825
|
+
}
|
|
3826
|
+
interface SettlementBackfillResponse {
|
|
3827
|
+
enqueued: boolean;
|
|
3828
|
+
job_id: string;
|
|
3829
|
+
}
|
|
3830
|
+
interface ShopVisibilityUpdateRequest {
|
|
3831
|
+
profile_id: string;
|
|
3832
|
+
visible_to_shop: boolean;
|
|
3833
|
+
}
|
|
3834
|
+
interface ShopVisibilityResponse {
|
|
3835
|
+
profile_id: string;
|
|
3836
|
+
visible_to_shop: boolean;
|
|
3837
|
+
}
|
|
3838
|
+
/** Operations that can carry limit rules. Only refunds today. */
|
|
3839
|
+
type LimitedOperation = 'refund';
|
|
3840
|
+
/** Rule target: the merchant default, one role, or one user. */
|
|
3841
|
+
type OperationLimitScope = 'merchant' | 'role' | 'user';
|
|
3842
|
+
/**
|
|
3843
|
+
* What happens when an operation would exceed its limit. v1 ships `block`
|
|
3844
|
+
* only; `require_approval` (four-eyes) arrives with backend#342 phase 2.
|
|
3845
|
+
*/
|
|
3846
|
+
type OperationLimitOnExceeded = 'block';
|
|
3847
|
+
/** How the usage window is anchored. Rolling is the default. */
|
|
3848
|
+
type OperationLimitWindowMode = 'rolling' | 'calendar';
|
|
3849
|
+
/**
|
|
3850
|
+
* One persisted operation-limit rule. Enforcement resolves the most
|
|
3851
|
+
* specific rule: user > role > merchant. Amounts are minor units in
|
|
3852
|
+
* `currency`.
|
|
3853
|
+
*/
|
|
3854
|
+
interface OperationLimitRule {
|
|
3855
|
+
id: string;
|
|
3856
|
+
merchant_id: string;
|
|
3857
|
+
operation: LimitedOperation;
|
|
3858
|
+
scope: OperationLimitScope;
|
|
3859
|
+
scope_id?: string | null;
|
|
3860
|
+
max_amount_per_operation?: number | null;
|
|
3861
|
+
max_total_amount_per_window?: number | null;
|
|
3862
|
+
max_count_per_window?: number | null;
|
|
3863
|
+
max_payment_age_days?: number | null;
|
|
3864
|
+
window_hours: number;
|
|
3865
|
+
/** ISO currency code of the amount fields. */
|
|
3866
|
+
currency: string;
|
|
3867
|
+
on_exceeded: OperationLimitOnExceeded;
|
|
3868
|
+
created_at: string;
|
|
3869
|
+
modified_at: string;
|
|
3870
|
+
}
|
|
3871
|
+
/**
|
|
3872
|
+
* Body for `PUT /operation-limits/rules` — a full-replace upsert for one
|
|
3873
|
+
* target. Absent limit fields mean "this rule does not constrain that
|
|
3874
|
+
* dimension"; a request with no limit at all is rejected (delete the rule
|
|
3875
|
+
* instead). Amounts are minor units in `currency`.
|
|
3876
|
+
*/
|
|
3877
|
+
interface UpsertOperationLimitRuleRequest {
|
|
3878
|
+
operation: LimitedOperation;
|
|
3879
|
+
scope: OperationLimitScope;
|
|
3880
|
+
/** Required for `role`/`user` scopes; must be absent for `merchant`. */
|
|
3881
|
+
scope_id?: string;
|
|
3882
|
+
max_amount_per_operation?: number;
|
|
3883
|
+
max_total_amount_per_window?: number;
|
|
3884
|
+
max_count_per_window?: number;
|
|
3885
|
+
max_payment_age_days?: number;
|
|
3886
|
+
/** Window length in hours (rolling mode). Defaults to 24; 1–720. */
|
|
3887
|
+
window_hours?: number;
|
|
3888
|
+
/** Currency of the amount fields. Defaults to USD. */
|
|
3889
|
+
currency?: Currency;
|
|
3890
|
+
}
|
|
3891
|
+
interface OperationLimitRuleListParams {
|
|
3892
|
+
/** Without `operation`, every rule of the caller's merchant is returned. */
|
|
3893
|
+
operation?: LimitedOperation;
|
|
3894
|
+
}
|
|
3895
|
+
interface OperationLimitRuleDeleteResponse {
|
|
3896
|
+
id: string;
|
|
3897
|
+
deleted: boolean;
|
|
3898
|
+
}
|
|
3899
|
+
/**
|
|
3900
|
+
* Merchant-level enforcement settings. Both fields have safe defaults, so
|
|
3901
|
+
* an untouched merchant behaves as: rolling window, admins not exempt.
|
|
3902
|
+
*/
|
|
3903
|
+
interface OperationLimitSettings {
|
|
3904
|
+
window_mode: OperationLimitWindowMode;
|
|
3905
|
+
/** Whether merchant/organization admins bypass limit rules. */
|
|
3906
|
+
admins_exempt: boolean;
|
|
3907
|
+
}
|
|
3908
|
+
/** Body for `PUT /operation-limits/settings`. Only provided fields change. */
|
|
3909
|
+
interface UpdateOperationLimitSettingsRequest {
|
|
3910
|
+
window_mode?: OperationLimitWindowMode;
|
|
3911
|
+
admins_exempt?: boolean;
|
|
3912
|
+
}
|
|
3913
|
+
/** Half-open amount range filter; minor units. `null` bounds are open. */
|
|
3914
|
+
interface AmountFilter {
|
|
3915
|
+
start_amount?: number | null;
|
|
3916
|
+
end_amount?: number | null;
|
|
3917
|
+
}
|
|
3918
|
+
/** Sort order for filtered payment lists. */
|
|
3919
|
+
interface PaymentListOrder {
|
|
3920
|
+
/** Column to sort on, e.g. `"created"` or `"amount"`. */
|
|
3921
|
+
on: string;
|
|
3922
|
+
by: 'asc' | 'desc';
|
|
3923
|
+
}
|
|
3924
|
+
/**
|
|
3925
|
+
* Body for `POST /payments/list` and `POST /payments/profile/list`.
|
|
3926
|
+
* `start_time` / `end_time` are top-level (the backend flattens the time
|
|
3927
|
+
* range), not nested. `test_mode`: `true` = test only, `false` = live only,
|
|
3928
|
+
* omitted = both.
|
|
3929
|
+
*/
|
|
3930
|
+
interface PaymentListFilterConstraints {
|
|
3931
|
+
payment_id?: string | null;
|
|
3932
|
+
profile_id?: string | null;
|
|
3933
|
+
/** Filters to the business profiles assigned to this project. */
|
|
3934
|
+
project_id?: string | null;
|
|
3935
|
+
customer_id?: string | null;
|
|
3936
|
+
customer_email?: string | null;
|
|
3937
|
+
/** Default 10, max 20 (server-enforced defaults; dashboards send their own). */
|
|
3938
|
+
limit?: number;
|
|
3939
|
+
offset?: number | null;
|
|
3940
|
+
amount_filter?: AmountFilter | null;
|
|
3941
|
+
connector?: string[] | null;
|
|
3942
|
+
currency?: Currency[] | null;
|
|
3943
|
+
status?: IntentStatus[] | null;
|
|
3944
|
+
payment_method?: PaymentMethod[] | null;
|
|
3945
|
+
payment_method_type?: string[] | null;
|
|
3946
|
+
authentication_type?: AuthenticationType[] | null;
|
|
3947
|
+
merchant_connector_id?: string[] | null;
|
|
3948
|
+
card_network?: string[] | null;
|
|
3949
|
+
merchant_order_reference_id?: string | null;
|
|
3950
|
+
card_discovery?: string[] | null;
|
|
3951
|
+
/** ISO-8601 range start (flattened, top-level on the wire). */
|
|
3952
|
+
start_time?: string | null;
|
|
3953
|
+
/** ISO-8601 range end. */
|
|
3954
|
+
end_time?: string | null;
|
|
3955
|
+
/** `true` = test only, `false` = live only, omitted = both environments. */
|
|
3956
|
+
test_mode?: boolean | null;
|
|
3957
|
+
/** Omitted = backend default (`created`, descending). */
|
|
3958
|
+
order?: PaymentListOrder | null;
|
|
3959
|
+
}
|
|
3960
|
+
/** Response of the filtered payment list endpoints (`count` = page size). */
|
|
3961
|
+
interface PaymentListFilteredResponse {
|
|
3962
|
+
count: number;
|
|
3963
|
+
total_count: number;
|
|
3964
|
+
data: PaymentResponse[];
|
|
3965
|
+
}
|
|
3966
|
+
/** Response of `DELETE /payments/{payment_id}` (soft delete). */
|
|
3967
|
+
interface PaymentsDeleteResponse {
|
|
3968
|
+
payment_id: string;
|
|
3969
|
+
merchant_id: string;
|
|
3970
|
+
/** Always `true` on success — the endpoint errors otherwise. */
|
|
3971
|
+
deleted: boolean;
|
|
3972
|
+
}
|
|
3973
|
+
/**
|
|
3974
|
+
* The effective deletable-status set for the calling merchant — lets a
|
|
3975
|
+
* dashboard show the delete action only where allowed.
|
|
3976
|
+
*/
|
|
3977
|
+
interface PaymentsDeletePolicyResponse {
|
|
3978
|
+
statuses: IntentStatus[];
|
|
3979
|
+
}
|
|
3980
|
+
/**
|
|
3981
|
+
* One client/device observation captured while the buyer interacted with a
|
|
3982
|
+
* payment: a checkout open, a confirm, a redirect leg or buyer-reported
|
|
3983
|
+
* client signals.
|
|
3984
|
+
*/
|
|
3985
|
+
interface PaymentClientContextEntry {
|
|
3986
|
+
/** Capture point, e.g. `checkout_open`, `confirm`, `redirect_return`, `client_signals`. */
|
|
3987
|
+
source: string;
|
|
3988
|
+
device_id?: string | null;
|
|
3989
|
+
/** Partitioned (CHIPS) twin of `device_id`, scoped to the embedding site. */
|
|
3990
|
+
partitioned_device_id?: string | null;
|
|
3991
|
+
ip_address?: string | null;
|
|
3992
|
+
ip_country?: string | null;
|
|
3993
|
+
user_agent?: string | null;
|
|
3994
|
+
accept_language?: string | null;
|
|
3995
|
+
/**
|
|
3996
|
+
* Best-effort hardware-model guess derived server-side. Display/analytics
|
|
3997
|
+
* only; never make decisions on it.
|
|
3998
|
+
*/
|
|
3999
|
+
device_model?: string | null;
|
|
4000
|
+
/** Capture-point-specific extras (client hints, screen size, referrer …). */
|
|
4001
|
+
extra?: Record<string, unknown> | null;
|
|
4002
|
+
created_at: string;
|
|
4003
|
+
}
|
|
4004
|
+
interface PaymentClientContextListResponse {
|
|
4005
|
+
payment_id: string;
|
|
4006
|
+
count: number;
|
|
4007
|
+
/** All captured observations, oldest first. */
|
|
4008
|
+
data: PaymentClientContextEntry[];
|
|
4009
|
+
}
|
|
4010
|
+
/**
|
|
4011
|
+
* One Paysepro rail the buyer can pick. `payment_method`,
|
|
4012
|
+
* `payment_method_type` and `payment_method_data` are echoed verbatim on the
|
|
4013
|
+
* confirm call — never derive them client-side from `category`, the mapping
|
|
4014
|
+
* is not 1:1.
|
|
4015
|
+
*/
|
|
4016
|
+
interface PayseproMethod {
|
|
4017
|
+
/** Paysepro vendor code (wire name `type`), passed back verbatim. */
|
|
4018
|
+
type: string;
|
|
4019
|
+
display_name: string;
|
|
4020
|
+
/**
|
|
4021
|
+
* One of: card_redirect | wallet | bank_transfer | bank_redirect |
|
|
4022
|
+
* voucher | gift_card | reward | cash. Groups tiles into sections.
|
|
4023
|
+
*/
|
|
4024
|
+
category: string;
|
|
4025
|
+
payment_method: string;
|
|
4026
|
+
payment_method_type: string;
|
|
4027
|
+
/** Pre-built `payment_method_data` body to echo on confirm (merge `billing` in). */
|
|
4028
|
+
payment_method_data: Record<string, unknown>;
|
|
4029
|
+
pmin?: number;
|
|
4030
|
+
pmax?: number;
|
|
4031
|
+
/**
|
|
4032
|
+
* Country to forward for country-pinned vendors. Absent for universal
|
|
4033
|
+
* rails, where the buyer's billing country is the right value.
|
|
4034
|
+
*/
|
|
4035
|
+
pinned_country?: string;
|
|
4036
|
+
}
|
|
4037
|
+
interface PayseproMethodsResponse {
|
|
4038
|
+
country: string;
|
|
4039
|
+
currency: string;
|
|
4040
|
+
methods: PayseproMethod[];
|
|
4041
|
+
}
|
|
4042
|
+
/** One e-Payouts rail. Same contract as {@link PayseproMethod}. */
|
|
4043
|
+
interface EpayoutsMethod {
|
|
4044
|
+
/** e-Payouts vendor code (wire name `type`), passed back verbatim. */
|
|
4045
|
+
type: string;
|
|
4046
|
+
display_name: string;
|
|
4047
|
+
category: string;
|
|
4048
|
+
payment_method: string;
|
|
4049
|
+
payment_method_type: string;
|
|
4050
|
+
payment_method_data: Record<string, unknown>;
|
|
4051
|
+
pmin?: number;
|
|
4052
|
+
pmax?: number;
|
|
4053
|
+
pinned_country?: string;
|
|
4054
|
+
/** Sanitised inline SVG for the tile icon, when the merchant set one. */
|
|
4055
|
+
icon_svg?: string;
|
|
4056
|
+
}
|
|
4057
|
+
interface EpayoutsMethodsResponse {
|
|
4058
|
+
country: string;
|
|
4059
|
+
currency: string;
|
|
4060
|
+
methods: EpayoutsMethod[];
|
|
4061
|
+
/**
|
|
4062
|
+
* Lowercase ISO 3166-1 alpha-2 codes of every country the catalog can
|
|
4063
|
+
* mint some method for — drives the pane's country picker.
|
|
4064
|
+
*/
|
|
4065
|
+
supported_countries: string[];
|
|
4066
|
+
}
|
|
4067
|
+
/** The closed set of buyer-side checkout events. */
|
|
4068
|
+
type CheckoutEventKind$1 = 'native_pane_selected' | 'native_pane_tab_opened' | 'native_pane_tab_blocked' | 'native_pane_abandoned' | 'native_pane_returned';
|
|
4069
|
+
interface RecordCheckoutEventRequest {
|
|
4070
|
+
event: CheckoutEventKind$1;
|
|
4071
|
+
/** Native-pane catalog key the event is about (`apple_pay`, `klarna`, …). */
|
|
4072
|
+
method: string;
|
|
4073
|
+
}
|
|
4074
|
+
interface RecordCheckoutEventResponse {
|
|
4075
|
+
/**
|
|
4076
|
+
* `false` when the event was deduplicated or the per-payment cap was
|
|
4077
|
+
* reached. Informational — checkouts do not branch on it.
|
|
4078
|
+
*/
|
|
4079
|
+
recorded: boolean;
|
|
4080
|
+
}
|
|
4081
|
+
/** What a checkout page needs to stand up a VGS Collect form. */
|
|
4082
|
+
interface VaultCollectSessionResponse {
|
|
4083
|
+
/** VGS tenant id (`tnt...`), first argument to `VGSCollect.create`. */
|
|
4084
|
+
vault_id: string;
|
|
4085
|
+
/** `sandbox` or `live` — second argument to `VGSCollect.create`. */
|
|
4086
|
+
environment: string;
|
|
4087
|
+
/** Inbound route the Collect form posts through, when one is configured. */
|
|
4088
|
+
route_id?: string | null;
|
|
4089
|
+
/** Write-only bearer token for `form.createAliases({ access_token })`. */
|
|
4090
|
+
access_token: string;
|
|
4091
|
+
/** Remaining lifetime in seconds. */
|
|
4092
|
+
expires_in: number;
|
|
4093
|
+
}
|
|
4094
|
+
interface VaultPaymentMethodRequest {
|
|
4095
|
+
/** The card-number alias from `createAliases` (must be card-shaped). */
|
|
4096
|
+
card_number_alias: string;
|
|
4097
|
+
/** Expiry in the clear by necessity — VGS never hands raw values back. */
|
|
4098
|
+
card_exp_month: string;
|
|
4099
|
+
card_exp_year: string;
|
|
4100
|
+
card_holder_name?: string;
|
|
4101
|
+
nick_name?: string;
|
|
4102
|
+
card_network?: string;
|
|
4103
|
+
}
|
|
4104
|
+
interface VaultPaymentMethodResponse {
|
|
4105
|
+
/** Absent for a guest checkout, which stores no payment method. */
|
|
4106
|
+
payment_method_id?: string;
|
|
4107
|
+
/** Last four of the format-preserving alias — the real card's last four. */
|
|
4108
|
+
last4: string;
|
|
4109
|
+
card_network?: string | null;
|
|
4110
|
+
/**
|
|
4111
|
+
* One-shot spendable token: put on the confirm call as `payment_token`
|
|
4112
|
+
* alongside `payment_method: "card"`.
|
|
4113
|
+
*/
|
|
4114
|
+
payment_token: string;
|
|
4115
|
+
}
|
|
4116
|
+
/** Narrow payload of `POST /shops/{merchant_id}/{shop_id}/checkout-branding`. */
|
|
4117
|
+
interface CheckoutBrandingUpdate {
|
|
4118
|
+
/** Applied as a whole-object replace of `payment_link_config`. */
|
|
4119
|
+
payment_link_config?: BusinessPaymentLinkConfig | null;
|
|
4120
|
+
}
|
|
4121
|
+
/** A VGS vault environment. */
|
|
4122
|
+
type VaultEnvironment = 'sandbox' | 'live';
|
|
4123
|
+
/** What a VGS route is for: inbound card capture or outbound reveal. */
|
|
4124
|
+
type VaultRoutePurpose = 'collect' | 'reveal';
|
|
4125
|
+
type VaultRouteChangeKind = 'create' | 'update' | 'unchanged';
|
|
4126
|
+
interface VaultRouteFieldChange {
|
|
4127
|
+
path: string;
|
|
4128
|
+
from?: string | null;
|
|
4129
|
+
to?: string | null;
|
|
4130
|
+
}
|
|
4131
|
+
type VaultRouteWarningCode = 'templated_connector_base_url' | 'applier_reported';
|
|
4132
|
+
/** A non-fatal finding from a vault-route preview or apply. */
|
|
4133
|
+
interface VaultRouteWarning {
|
|
4134
|
+
code: VaultRouteWarningCode;
|
|
4135
|
+
connector?: string | null;
|
|
4136
|
+
detail?: string | null;
|
|
4137
|
+
}
|
|
4138
|
+
interface VaultRouteChange {
|
|
4139
|
+
route_id: string;
|
|
4140
|
+
purpose: VaultRoutePurpose;
|
|
4141
|
+
change: VaultRouteChangeKind;
|
|
4142
|
+
field_changes: VaultRouteFieldChange[];
|
|
4143
|
+
}
|
|
4144
|
+
type VaultCheckId = 'collect_credentials_valid' | 'collect_write_only' | 'management_scopes' | 'vault_reachable' | 'environment_coherent' | 'reveal_route_covers_processors' | 'collect_route_exists' | 'ca_certificate_configured';
|
|
4145
|
+
type VaultCheckStatus = 'pass' | 'fail' | 'unknown';
|
|
4146
|
+
interface VaultCheck {
|
|
4147
|
+
id: VaultCheckId;
|
|
4148
|
+
status: VaultCheckStatus;
|
|
4149
|
+
/** Always present on the wire (nullable, never omitted). */
|
|
4150
|
+
detail: string | null;
|
|
4151
|
+
}
|
|
4152
|
+
interface VaultVerifyRequest {
|
|
4153
|
+
profile_id: string;
|
|
4154
|
+
}
|
|
4155
|
+
/** Result of `POST .../vault/verify` — configuration checks for a vault MCA. */
|
|
4156
|
+
interface VaultVerificationResponse {
|
|
4157
|
+
passed: boolean;
|
|
4158
|
+
checks: VaultCheck[];
|
|
4159
|
+
/** Vault egress IPs the merchant's processors may need to allowlist. */
|
|
4160
|
+
egress_ips_to_allowlist: string[];
|
|
4161
|
+
}
|
|
4162
|
+
interface VaultRoutesPreviewRequest {
|
|
4163
|
+
profile_id: string;
|
|
4164
|
+
/** `sandbox` or `live`; omitted = derived from the credentials. */
|
|
4165
|
+
environment?: VaultEnvironment;
|
|
4166
|
+
}
|
|
4167
|
+
/**
|
|
4168
|
+
* Fingerprint of the vault's current routes. `null` is a real value meaning
|
|
4169
|
+
* "no routes exist" (the wire is an untagged enum), and must be sent back
|
|
4170
|
+
* as `null` on apply rather than omitted.
|
|
4171
|
+
*/
|
|
4172
|
+
type VaultRoutesFingerprint = string | null;
|
|
4173
|
+
interface VaultRoutesPreviewResponse {
|
|
4174
|
+
vault_id: string;
|
|
4175
|
+
environment: VaultEnvironment;
|
|
4176
|
+
/** Opaque token covering the desired route document; echo on apply. */
|
|
4177
|
+
desired_fingerprint: string;
|
|
4178
|
+
desired_upstream_hosts: string[];
|
|
4179
|
+
/** Opaque token covering what exists now; echo on apply. See {@link VaultRoutesFingerprint}. */
|
|
4180
|
+
current_fingerprint: VaultRoutesFingerprint;
|
|
4181
|
+
changes: VaultRouteChange[];
|
|
4182
|
+
warnings: VaultRouteWarning[];
|
|
4183
|
+
}
|
|
4184
|
+
interface VaultRoutesApplyRequest {
|
|
4185
|
+
profile_id: string;
|
|
4186
|
+
environment?: VaultEnvironment;
|
|
4187
|
+
/**
|
|
4188
|
+
* From the preview, byte for byte. `null` means the preview found no
|
|
4189
|
+
* routes and is a real value — an absent key is refused by the router.
|
|
4190
|
+
*/
|
|
4191
|
+
expected_current_fingerprint: VaultRoutesFingerprint;
|
|
4192
|
+
/** From the same preview, byte for byte. */
|
|
4193
|
+
expected_desired_fingerprint: string;
|
|
4194
|
+
}
|
|
4195
|
+
interface VaultRouteIds {
|
|
4196
|
+
collect: string;
|
|
4197
|
+
reveal: string;
|
|
4198
|
+
}
|
|
4199
|
+
interface VaultRouteApplyVerification {
|
|
4200
|
+
established: string[];
|
|
4201
|
+
not_established: string[];
|
|
4202
|
+
routes_appeared: string[];
|
|
4203
|
+
}
|
|
4204
|
+
interface VaultRoutesApplyResponse {
|
|
4205
|
+
applied: boolean;
|
|
4206
|
+
route_ids: VaultRouteIds;
|
|
4207
|
+
collect_route_id_stored: boolean;
|
|
4208
|
+
warnings: VaultRouteWarning[];
|
|
4209
|
+
verification?: VaultRouteApplyVerification | null;
|
|
4210
|
+
}
|
|
4211
|
+
/**
|
|
4212
|
+
* Body of `PATCH /user/metadata` and `PATCH /user/merchant/metadata` — an
|
|
4213
|
+
* RFC 7396 merge patch over the metadata bucket. An object merges key by
|
|
4214
|
+
* key (a `null` value removes that key); a root-level `null` clears the
|
|
4215
|
+
* whole bucket. Anything else is rejected with a 400.
|
|
4216
|
+
*/
|
|
4217
|
+
interface UpdateMetadataRequest {
|
|
4218
|
+
patch: Record<string, unknown> | null;
|
|
4219
|
+
}
|
|
4220
|
+
/** How a catalog entry's country coverage is interpreted. */
|
|
4221
|
+
type EpayoutsLocality = 'country_locked' | 'regional' | 'universal';
|
|
4222
|
+
/** Which processing rail a catalog entry mints codes for. */
|
|
4223
|
+
type EpayoutsRail = {
|
|
4224
|
+
kind: 'local_bank_redirect';
|
|
4225
|
+
} | {
|
|
4226
|
+
kind: 'credit_card_redirect';
|
|
4227
|
+
} | {
|
|
4228
|
+
kind: 'bank_redirect';
|
|
4229
|
+
pmt: string;
|
|
4230
|
+
data_variant: string;
|
|
4231
|
+
};
|
|
4232
|
+
interface EpayoutsCatalogEntry {
|
|
4233
|
+
vendor_code: string;
|
|
4234
|
+
family: string;
|
|
4235
|
+
display_name?: string | null;
|
|
4236
|
+
category?: string | null;
|
|
4237
|
+
/** Sanitised inline SVG for the tile icon, when set. */
|
|
4238
|
+
icon_svg?: string | null;
|
|
4239
|
+
/** ISO 3166-1 alpha-2 codes (lowercase) the entry covers. */
|
|
4240
|
+
coverage: string[];
|
|
4241
|
+
pmin?: number | null;
|
|
4242
|
+
pmax?: number | null;
|
|
4243
|
+
enabled: boolean;
|
|
4244
|
+
locality: EpayoutsLocality;
|
|
4245
|
+
rail: EpayoutsRail;
|
|
4246
|
+
}
|
|
4247
|
+
interface EpayoutsCatalogResponse {
|
|
4248
|
+
entries: EpayoutsCatalogEntry[];
|
|
4249
|
+
/** Set by a sync sweep: how many countries were probed / answered. */
|
|
4250
|
+
countries_probed?: number | null;
|
|
4251
|
+
countries_ok?: number | null;
|
|
4252
|
+
}
|
|
3536
4253
|
|
|
3537
4254
|
/** Create and manage API keys for a merchant account. */
|
|
3538
4255
|
declare class ApiKeys {
|
|
@@ -3793,6 +4510,27 @@ declare class Connectors {
|
|
|
3793
4510
|
create(accountId: string, params: ConnectorCreateRequest): Promise<ConnectorResponse>;
|
|
3794
4511
|
retrieve(accountId: string, connectorId: string): Promise<ConnectorResponse>;
|
|
3795
4512
|
list(accountId: string): Promise<ConnectorResponse[]>;
|
|
4513
|
+
/**
|
|
4514
|
+
* The profile-scoped connector list. The merchant-wide `list()` is
|
|
4515
|
+
* merchant-gated and 403s for a profile-entity (shop user) JWT; this
|
|
4516
|
+
* variant is scoped server-side to the caller's own profile.
|
|
4517
|
+
*
|
|
4518
|
+
* `GET /account/{accountId}/profile/connectors`
|
|
4519
|
+
*/
|
|
4520
|
+
listByProfile(accountId: string): Promise<ConnectorResponse[]>;
|
|
4521
|
+
/**
|
|
4522
|
+
* The built-in e-Payouts reference catalog — the "Restore defaults" source.
|
|
4523
|
+
* `GET /account/{accountId}/connectors/epayouts/catalog/defaults`
|
|
4524
|
+
*/
|
|
4525
|
+
getEpayoutsCatalogDefaults(accountId: string): Promise<EpayoutsCatalogResponse>;
|
|
4526
|
+
/**
|
|
4527
|
+
* Sweep the merchant's own e-Payouts module and return the rails it
|
|
4528
|
+
* actually has enabled. Server-side this makes many upstream calls, so it
|
|
4529
|
+
* can take several seconds — show progress.
|
|
4530
|
+
*
|
|
4531
|
+
* `POST /account/{accountId}/connectors/{connectorId}/epayouts/catalog/sync`
|
|
4532
|
+
*/
|
|
4533
|
+
syncEpayoutsCatalog(accountId: string, connectorId: string): Promise<EpayoutsCatalogResponse>;
|
|
3796
4534
|
update(accountId: string, connectorId: string, params: ConnectorUpdateRequest): Promise<ConnectorResponse>;
|
|
3797
4535
|
delete(accountId: string, connectorId: string): Promise<ConnectorResponse>;
|
|
3798
4536
|
/**
|
|
@@ -3805,6 +4543,37 @@ declare class Connectors {
|
|
|
3805
4543
|
* the target shop.
|
|
3806
4544
|
*/
|
|
3807
4545
|
clone(accountId: string, connectorId: string, params: ConnectorCloneRequest): Promise<ConnectorResponse>;
|
|
4546
|
+
/**
|
|
4547
|
+
* Run the configuration checks for a vault (VGS) connector account:
|
|
4548
|
+
* credential validity, write-only Collect scope, reachability, environment
|
|
4549
|
+
* coherence, route coverage. Read-only but not cheap — it decrypts the
|
|
4550
|
+
* vault's management credential and talks to VGS.
|
|
4551
|
+
*
|
|
4552
|
+
* `POST /account/{accountId}/connectors/{connectorId}/vault/verify`
|
|
4553
|
+
*/
|
|
4554
|
+
verifyVault(accountId: string, connectorId: string, params: VaultVerifyRequest): Promise<VaultVerificationResponse>;
|
|
4555
|
+
/**
|
|
4556
|
+
* Compute the route document the vault SHOULD have and diff it against
|
|
4557
|
+
* what exists, without writing anything. The returned fingerprints must be
|
|
4558
|
+
* echoed byte for byte on {@link Connectors.applyVaultRoutes}.
|
|
4559
|
+
*
|
|
4560
|
+
* A router without these endpoints answers 404 — render that as "this
|
|
4561
|
+
* build cannot configure routes", never as "there is nothing to change".
|
|
4562
|
+
*
|
|
4563
|
+
* `POST /account/{accountId}/connectors/{connectorId}/vault/routes/preview`
|
|
4564
|
+
*/
|
|
4565
|
+
previewVaultRoutes(accountId: string, connectorId: string, params: VaultRoutesPreviewRequest): Promise<VaultRoutesPreviewResponse>;
|
|
4566
|
+
/**
|
|
4567
|
+
* Write the routes the merchant just previewed. Both fingerprints come
|
|
4568
|
+
* from the preview and are opaque: `expected_current_fingerprint` says the
|
|
4569
|
+
* vault has not moved (`null` = "the preview found no routes" and is sent
|
|
4570
|
+
* as `null`, never omitted), `expected_desired_fingerprint` says the
|
|
4571
|
+
* document is still the one on screen. A 409 (`DE_04`) means the vault
|
|
4572
|
+
* changed since the preview — nothing was written; preview again.
|
|
4573
|
+
*
|
|
4574
|
+
* `POST /account/{accountId}/connectors/{connectorId}/vault/routes/apply`
|
|
4575
|
+
*/
|
|
4576
|
+
applyVaultRoutes(accountId: string, connectorId: string, params: VaultRoutesApplyRequest): Promise<VaultRoutesApplyResponse>;
|
|
3808
4577
|
/** Verify connector credentials. `POST /account/connectors/verify` */
|
|
3809
4578
|
verify(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3810
4579
|
/**
|
|
@@ -4514,6 +5283,29 @@ declare class Payments {
|
|
|
4514
5283
|
* ```
|
|
4515
5284
|
*/
|
|
4516
5285
|
list(params?: PaymentListParams, options?: RequestExtras): Promise<PaymentListResponse>;
|
|
5286
|
+
/**
|
|
5287
|
+
* The status timeline of client/device observations captured while the
|
|
5288
|
+
* buyer interacted with the payment (checkout opens, confirms, redirect
|
|
5289
|
+
* legs, reported client signals), oldest first.
|
|
5290
|
+
*
|
|
5291
|
+
* `GET /payments/{paymentId}/client-context`
|
|
5292
|
+
*/
|
|
5293
|
+
listClientContext(paymentId: string, options?: RequestExtras): Promise<PaymentClientContextListResponse>;
|
|
5294
|
+
/**
|
|
5295
|
+
* Soft-delete a payment. Only payments whose status is in the merchant's
|
|
5296
|
+
* delete policy (see {@link Payments.getDeletePolicy}) can be deleted;
|
|
5297
|
+
* anything else fails with a precondition error.
|
|
5298
|
+
*
|
|
5299
|
+
* `DELETE /payments/{paymentId}`
|
|
5300
|
+
*/
|
|
5301
|
+
delete(paymentId: string, options?: RequestExtras): Promise<PaymentsDeleteResponse>;
|
|
5302
|
+
/**
|
|
5303
|
+
* The effective deletable-status set for the calling merchant — lets a
|
|
5304
|
+
* dashboard show the delete action only where it is allowed.
|
|
5305
|
+
*
|
|
5306
|
+
* `GET /payments/delete-policy`
|
|
5307
|
+
*/
|
|
5308
|
+
getDeletePolicy(options?: RequestExtras): Promise<PaymentsDeletePolicyResponse>;
|
|
4517
5309
|
/** Generate session tokens. `POST /payments/session-tokens` */
|
|
4518
5310
|
sessionTokens(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
4519
5311
|
/** Retrieve payment with gateway credentials. `POST /payments/sync` */
|
|
@@ -4538,8 +5330,24 @@ declare class Payments {
|
|
|
4538
5330
|
listAllShops(params?: PaymentListParams): Promise<PaymentListResponse>;
|
|
4539
5331
|
/** List payments by filter (POST body). `POST /payments/list` */
|
|
4540
5332
|
listByFilter(params: Record<string, unknown>): Promise<PaymentListResponse>;
|
|
5333
|
+
/**
|
|
5334
|
+
* List payments by filter, scoped to the caller's profile (the shop-user
|
|
5335
|
+
* twin of `listByFilter`). The backend narrows to the profile from the
|
|
5336
|
+
* auth context, so `profile_id` / `project_id` must not be sent.
|
|
5337
|
+
*
|
|
5338
|
+
* Not to be confused with {@link Payments.listByProfile}, which is the GET
|
|
5339
|
+
* cursor variant and rejects this body.
|
|
5340
|
+
*
|
|
5341
|
+
* `POST /payments/profile/list`
|
|
5342
|
+
*/
|
|
5343
|
+
listByProfileFilter(params: PaymentListFilterConstraints, options?: RequestExtras): Promise<PaymentListFilteredResponse>;
|
|
4541
5344
|
/** Get payment filter options. `GET /payments/filter` */
|
|
4542
5345
|
getFilters(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
5346
|
+
/**
|
|
5347
|
+
* Get payment filter options, scoped to the caller's profile.
|
|
5348
|
+
* `GET /payments/profile/filter`
|
|
5349
|
+
*/
|
|
5350
|
+
getFiltersByProfile(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
4543
5351
|
/** Get payment aggregates. `GET /payments/aggregate` */
|
|
4544
5352
|
aggregate(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
4545
5353
|
/** Get payment aggregates (profile-scoped). `GET /payments/profile/aggregate` */
|
|
@@ -4653,6 +5461,14 @@ declare class Profiles {
|
|
|
4653
5461
|
create(accountId: string, params: ProfileCreateRequest): Promise<ProfileResponse>;
|
|
4654
5462
|
retrieve(accountId: string, profileId: string): Promise<ProfileResponse>;
|
|
4655
5463
|
list(accountId: string): Promise<ProfileResponse[]>;
|
|
5464
|
+
/**
|
|
5465
|
+
* List the business profiles the caller can see at profile scope — the
|
|
5466
|
+
* `ProfileAccountRead` twin of `list()` (which needs merchant-level read).
|
|
5467
|
+
* A shop-scoped user gets exactly their own shop back.
|
|
5468
|
+
*
|
|
5469
|
+
* `GET /account/{accountId}/profile`
|
|
5470
|
+
*/
|
|
5471
|
+
listByProfile(accountId: string): Promise<ProfileResponse[]>;
|
|
4656
5472
|
update(accountId: string, profileId: string, params: ProfileUpdateRequest): Promise<ProfileResponse>;
|
|
4657
5473
|
delete(accountId: string, profileId: string): Promise<ProfileResponse>;
|
|
4658
5474
|
/** Toggle extended card info for a profile. `POST /account/{accountId}/business-profile/{profileId}/toggle-extended-card-info` */
|
|
@@ -5146,7 +5962,7 @@ declare class Shops {
|
|
|
5146
5962
|
/**
|
|
5147
5963
|
* Upload a logo file for a shop. The file is stored in Delopay's configured
|
|
5148
5964
|
* object store and a public HTTPS URL is returned. This method does NOT write
|
|
5149
|
-
* the URL into the shop's `payment_link_config.
|
|
5965
|
+
* the URL into the shop's `payment_link_config.logo` — call
|
|
5150
5966
|
* `shops.update` afterwards with the returned `logo_url` to persist the change.
|
|
5151
5967
|
*
|
|
5152
5968
|
* Accepts PNG, JPEG, WebP or SVG. The file must be ≤ 1 MiB.
|
|
@@ -5160,11 +5976,28 @@ declare class Shops {
|
|
|
5160
5976
|
* ```typescript
|
|
5161
5977
|
* const { logo_url } = await delopay.shops.uploadLogo('merch_1', 'pro_1', file);
|
|
5162
5978
|
* await delopay.shops.update('merch_1', 'pro_1', {
|
|
5163
|
-
* payment_link_config: {
|
|
5979
|
+
* payment_link_config: { logo: logo_url },
|
|
5164
5980
|
* });
|
|
5165
5981
|
* ```
|
|
5166
5982
|
*/
|
|
5167
5983
|
uploadLogo(merchantId: string, shopId: string, file: Blob): Promise<ProfileLogoUploadResponse>;
|
|
5984
|
+
/**
|
|
5985
|
+
* Update only the checkout appearance (the `payment_link_config` blob:
|
|
5986
|
+
* theme, logo, colours, seller name, SDK layout/rules, DeloPay-branding
|
|
5987
|
+
* toggle) of a shop. Applied as a whole-object replace of
|
|
5988
|
+
* `payment_link_config`, mirroring the shop-update semantics.
|
|
5989
|
+
*
|
|
5990
|
+
* Gated on the dedicated `CheckoutBranding` permission, so "may restyle
|
|
5991
|
+
* the checkout" can be granted without full account/shop write.
|
|
5992
|
+
*
|
|
5993
|
+
* `POST /shops/{merchantId}/{shopId}/checkout-branding`
|
|
5994
|
+
*
|
|
5995
|
+
* @param merchantId - The merchant account ID.
|
|
5996
|
+
* @param shopId - The shop (business profile) ID to restyle.
|
|
5997
|
+
* @param params - The new `payment_link_config` blob (full replacement).
|
|
5998
|
+
* @returns The updated business profile.
|
|
5999
|
+
*/
|
|
6000
|
+
updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<ProfileResponse>;
|
|
5168
6001
|
}
|
|
5169
6002
|
|
|
5170
6003
|
declare class StripeConnect {
|
|
@@ -5231,6 +6064,22 @@ declare class Users {
|
|
|
5231
6064
|
revokeSession(sessionId: string): Promise<UserSessionRevokeResponse>;
|
|
5232
6065
|
getDetails(): Promise<UserResponse>;
|
|
5233
6066
|
update(params: UpdateUserDetailsRequest): Promise<UserResponse>;
|
|
6067
|
+
/**
|
|
6068
|
+
* RFC 7396 merge-patch the caller's own user-scoped metadata bucket.
|
|
6069
|
+
* Returns the full user details, so callers can refresh their context
|
|
6070
|
+
* without a second fetch.
|
|
6071
|
+
*
|
|
6072
|
+
* `PATCH /user/metadata`
|
|
6073
|
+
*/
|
|
6074
|
+
updateMetadata(params: UpdateMetadataRequest): Promise<UserResponse>;
|
|
6075
|
+
/**
|
|
6076
|
+
* RFC 7396 merge-patch the merchant-scoped metadata bucket shared by
|
|
6077
|
+
* every dashboard user of the merchant. Same response contract as
|
|
6078
|
+
* {@link Users.updateMetadata}.
|
|
6079
|
+
*
|
|
6080
|
+
* `PATCH /user/merchant/metadata`
|
|
6081
|
+
*/
|
|
6082
|
+
updateMerchantMetadata(params: UpdateMetadataRequest): Promise<UserResponse>;
|
|
5234
6083
|
/**
|
|
5235
6084
|
* Permanently delete the caller's account. Requires a fresh password
|
|
5236
6085
|
* (and a current 6-digit TOTP code if the user has TOTP enrolled). On
|
|
@@ -5629,6 +6478,192 @@ declare class Subscriptions {
|
|
|
5629
6478
|
resume(subscriptionId: string, params?: ResumeSubscriptionRequest, options?: RequestExtras): Promise<ResumeSubscriptionResponse>;
|
|
5630
6479
|
/** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
|
|
5631
6480
|
cancel(subscriptionId: string, params?: CancelSubscriptionRequest, options?: RequestExtras): Promise<CancelSubscriptionResponse>;
|
|
6481
|
+
/**
|
|
6482
|
+
* Resolve which of the given payments were raised by a subscription.
|
|
6483
|
+
* `POST /subscriptions/payments/lookup`
|
|
6484
|
+
*
|
|
6485
|
+
* The linkage exists in one direction only — an invoice points at the payment
|
|
6486
|
+
* it settled, and nothing is stamped on the payment — so this is the only way
|
|
6487
|
+
* to tell a subscription charge from a one-off one when you are holding a
|
|
6488
|
+
* page of payments. In particular, do not use `off_session` or the presence
|
|
6489
|
+
* of a mandate: an ordinary saved-card charge sets those identically.
|
|
6490
|
+
*
|
|
6491
|
+
* Ids that belong to no subscription are **absent** from `links` rather than
|
|
6492
|
+
* returned as an error, so match on presence:
|
|
6493
|
+
*
|
|
6494
|
+
* ```ts
|
|
6495
|
+
* const { links } = await subscriptions.lookupPayments(
|
|
6496
|
+
* { payment_ids: page.map((p) => p.payment_id) },
|
|
6497
|
+
* { headers: { 'X-Profile-Id': profileId } },
|
|
6498
|
+
* );
|
|
6499
|
+
* const bySubscription = new Map(links.map((l) => [l.payment_id, l]));
|
|
6500
|
+
* ```
|
|
6501
|
+
*
|
|
6502
|
+
* Profile-scoped like every other subscription route, and that matters more
|
|
6503
|
+
* here than elsewhere: a `payment_id` is merchant-supplied and only unique
|
|
6504
|
+
* within a merchant, so the shop is part of the question, not an
|
|
6505
|
+
* optimisation. Pass the profile that owns **the payments** — for a list
|
|
6506
|
+
* spanning several shops, group the ids by shop and call once per group.
|
|
6507
|
+
*
|
|
6508
|
+
* At most 200 ids per call.
|
|
6509
|
+
*/
|
|
6510
|
+
lookupPayments(params: SubscriptionPaymentLookupRequest, options?: RequestExtras): Promise<SubscriptionPaymentLookupResponse>;
|
|
6511
|
+
}
|
|
6512
|
+
|
|
6513
|
+
/**
|
|
6514
|
+
* Hosted-shop settlement: monthly statements, the live current-period
|
|
6515
|
+
* rollup, per-line detail, fee schedules and backfills.
|
|
6516
|
+
*
|
|
6517
|
+
* Every read takes an explicit `test_mode` — test and live figures must
|
|
6518
|
+
* never blend, so the environment lives in the signature rather than in a
|
|
6519
|
+
* default. `false` is transmitted, not dropped.
|
|
6520
|
+
*
|
|
6521
|
+
* Shop-owner responses are redacted server-side: absent platform-fee fields
|
|
6522
|
+
* are a permission boundary, not a gap — never re-derive them client-side.
|
|
6523
|
+
*/
|
|
6524
|
+
declare class Settlement {
|
|
6525
|
+
private readonly request;
|
|
6526
|
+
constructor(request: RequestFn);
|
|
6527
|
+
/**
|
|
6528
|
+
* Per-shop settlement rollup for the host merchant: unpaid totals and the
|
|
6529
|
+
* running current period, one row per shop.
|
|
6530
|
+
*
|
|
6531
|
+
* `GET /settlement/overview`
|
|
6532
|
+
*/
|
|
6533
|
+
overview(params: SettlementOverviewParams, options?: RequestExtras): Promise<SettlementOverviewResponse>;
|
|
6534
|
+
/**
|
|
6535
|
+
* Live rollup of the current (not yet statemented) period.
|
|
6536
|
+
*
|
|
6537
|
+
* `GET /settlement/current`
|
|
6538
|
+
*/
|
|
6539
|
+
current(params: SettlementCurrentParams, options?: RequestExtras): Promise<SettlementCurrentResponse>;
|
|
6540
|
+
/**
|
|
6541
|
+
* List generated settlement statements, newest first.
|
|
6542
|
+
*
|
|
6543
|
+
* `GET /settlement/statements`
|
|
6544
|
+
*/
|
|
6545
|
+
listStatements(params: SettlementStatementListParams, options?: RequestExtras): Promise<SettlementStatementListResponse>;
|
|
6546
|
+
/**
|
|
6547
|
+
* One statement with its per-connector/currency breakdown.
|
|
6548
|
+
*
|
|
6549
|
+
* `GET /settlement/statements/{statementId}`
|
|
6550
|
+
*/
|
|
6551
|
+
retrieveStatement(statementId: string, options?: RequestExtras): Promise<FeeStatementDetail>;
|
|
6552
|
+
/**
|
|
6553
|
+
* Generate (or regenerate) the statement for one shop and calendar month.
|
|
6554
|
+
*
|
|
6555
|
+
* `POST /settlement/statements/generate`
|
|
6556
|
+
*/
|
|
6557
|
+
generateStatement(params: StatementGenerateRequest, options?: RequestExtras): Promise<FeeStatementDetail>;
|
|
6558
|
+
/**
|
|
6559
|
+
* Record payout progress on a statement (`unpaid` / `partial` / `paid`).
|
|
6560
|
+
*
|
|
6561
|
+
* `POST /settlement/statements/{statementId}/payout`
|
|
6562
|
+
*/
|
|
6563
|
+
updateStatementPayout(statementId: string, params: StatementPayoutUpdateRequest, options?: RequestExtras): Promise<FeeStatementDetail>;
|
|
6564
|
+
/**
|
|
6565
|
+
* Export a statement as PDF. Returns the raw PDF bytes as a `Blob`, with
|
|
6566
|
+
* the same auth, retries and error handling as every other call — persist
|
|
6567
|
+
* or object-URL it caller-side.
|
|
6568
|
+
*
|
|
6569
|
+
* `GET /settlement/statements/{statementId}/pdf`
|
|
6570
|
+
*
|
|
6571
|
+
* @example
|
|
6572
|
+
* ```typescript
|
|
6573
|
+
* const pdf = await delopay.settlement.downloadStatementPdf('stmt_1', {
|
|
6574
|
+
* currency: 'EUR',
|
|
6575
|
+
* include_transactions: true,
|
|
6576
|
+
* });
|
|
6577
|
+
* const url = URL.createObjectURL(pdf);
|
|
6578
|
+
* ```
|
|
6579
|
+
*/
|
|
6580
|
+
downloadStatementPdf(statementId: string, params?: StatementPdfParams, options?: RequestExtras): Promise<Blob>;
|
|
6581
|
+
/**
|
|
6582
|
+
* The individual settled attempts of one shop's calendar month.
|
|
6583
|
+
*
|
|
6584
|
+
* `GET /settlement/lines`
|
|
6585
|
+
*/
|
|
6586
|
+
listLines(params: SettlementLineListParams, options?: RequestExtras): Promise<SettlementLineListResponse>;
|
|
6587
|
+
/**
|
|
6588
|
+
* The fee schedules that currently apply to a shop.
|
|
6589
|
+
*
|
|
6590
|
+
* `GET /settlement/fee-config`
|
|
6591
|
+
*/
|
|
6592
|
+
feeConfig(params: ShopFeeConfigParams, options?: RequestExtras): Promise<ShopFeeConfigResponse>;
|
|
6593
|
+
/**
|
|
6594
|
+
* Enqueue a settlement-line backfill over historical attempts. Attempts
|
|
6595
|
+
* already covered by a line are always skipped.
|
|
6596
|
+
*
|
|
6597
|
+
* `POST /settlement/backfill`
|
|
6598
|
+
*/
|
|
6599
|
+
backfill(params?: SettlementBackfillRequest, options?: RequestExtras): Promise<SettlementBackfillResponse>;
|
|
6600
|
+
/**
|
|
6601
|
+
* Toggle whether a shop's owner can see their own settlement figures.
|
|
6602
|
+
*
|
|
6603
|
+
* `POST /settlement/shops/visibility`
|
|
6604
|
+
*/
|
|
6605
|
+
setShopVisibility(params: ShopVisibilityUpdateRequest, options?: RequestExtras): Promise<ShopVisibilityResponse>;
|
|
6606
|
+
/**
|
|
6607
|
+
* Manual adjustments recorded on a statement.
|
|
6608
|
+
*
|
|
6609
|
+
* `GET /settlement/statements/{statementId}/adjustments`
|
|
6610
|
+
*/
|
|
6611
|
+
listStatementAdjustments(statementId: string, options?: RequestExtras): Promise<StatementAdjustmentListResponse>;
|
|
6612
|
+
/**
|
|
6613
|
+
* Add a manual adjustment to a statement. Positive `amount_usd` charges
|
|
6614
|
+
* the shop (reducing their payout); negative credits them.
|
|
6615
|
+
*
|
|
6616
|
+
* `POST /settlement/statements/{statementId}/adjustments`
|
|
6617
|
+
*/
|
|
6618
|
+
createStatementAdjustment(statementId: string, params: StatementAdjustmentCreateRequest, options?: RequestExtras): Promise<StatementAdjustment>;
|
|
6619
|
+
/**
|
|
6620
|
+
* Remove a manual adjustment from a statement.
|
|
6621
|
+
*
|
|
6622
|
+
* `DELETE /settlement/statements/{statementId}/adjustments/{adjustmentId}`
|
|
6623
|
+
*/
|
|
6624
|
+
deleteStatementAdjustment(statementId: string, adjustmentId: string, options?: RequestExtras): Promise<void>;
|
|
6625
|
+
}
|
|
6626
|
+
|
|
6627
|
+
/**
|
|
6628
|
+
* Per-operation spending limits (refunds today): rules scoped to the
|
|
6629
|
+
* merchant, a role or a user, plus the merchant-level enforcement settings.
|
|
6630
|
+
* Enforcement resolves the most specific rule: user > role > merchant.
|
|
6631
|
+
*/
|
|
6632
|
+
declare class OperationLimits {
|
|
6633
|
+
private readonly request;
|
|
6634
|
+
constructor(request: RequestFn);
|
|
6635
|
+
/**
|
|
6636
|
+
* List the merchant's limit rules, optionally for one operation.
|
|
6637
|
+
*
|
|
6638
|
+
* `GET /operation-limits/rules`
|
|
6639
|
+
*/
|
|
6640
|
+
listRules(params?: OperationLimitRuleListParams, options?: RequestExtras): Promise<OperationLimitRule[]>;
|
|
6641
|
+
/**
|
|
6642
|
+
* Create or replace the limit rule for one target. Full-replace upsert:
|
|
6643
|
+
* absent limit fields clear that dimension.
|
|
6644
|
+
*
|
|
6645
|
+
* `PUT /operation-limits/rules`
|
|
6646
|
+
*/
|
|
6647
|
+
upsertRule(params: UpsertOperationLimitRuleRequest, options?: RequestExtras): Promise<OperationLimitRule>;
|
|
6648
|
+
/**
|
|
6649
|
+
* Delete a limit rule.
|
|
6650
|
+
*
|
|
6651
|
+
* `DELETE /operation-limits/rules/{ruleId}`
|
|
6652
|
+
*/
|
|
6653
|
+
deleteRule(ruleId: string, options?: RequestExtras): Promise<OperationLimitRuleDeleteResponse>;
|
|
6654
|
+
/**
|
|
6655
|
+
* The merchant-level enforcement settings. An untouched merchant gets the
|
|
6656
|
+
* defaults: rolling window, admins not exempt.
|
|
6657
|
+
*
|
|
6658
|
+
* `GET /operation-limits/settings`
|
|
6659
|
+
*/
|
|
6660
|
+
retrieveSettings(options?: RequestExtras): Promise<OperationLimitSettings>;
|
|
6661
|
+
/**
|
|
6662
|
+
* Update the enforcement settings. Only provided fields change.
|
|
6663
|
+
*
|
|
6664
|
+
* `PUT /operation-limits/settings`
|
|
6665
|
+
*/
|
|
6666
|
+
updateSettings(params: UpdateOperationLimitSettingsRequest, options?: RequestExtras): Promise<OperationLimitSettings>;
|
|
5632
6667
|
}
|
|
5633
6668
|
|
|
5634
6669
|
/**
|
|
@@ -5683,6 +6718,19 @@ interface RequestOptions {
|
|
|
5683
6718
|
* with a `DelopayError` carrying code `'ABORTED'`. Combined with the per-request timeout.
|
|
5684
6719
|
*/
|
|
5685
6720
|
signal?: AbortSignal;
|
|
6721
|
+
/**
|
|
6722
|
+
* How to decode a 2xx response body. `'json'` (the default) parses JSON;
|
|
6723
|
+
* `'blob'` / `'arraybuffer'` return the raw bytes for binary endpoints
|
|
6724
|
+
* such as PDF exports. Error responses are always decoded as JSON and
|
|
6725
|
+
* thrown as `DelopayError` regardless of this setting.
|
|
6726
|
+
*/
|
|
6727
|
+
responseType?: 'json' | 'blob' | 'arraybuffer';
|
|
6728
|
+
/**
|
|
6729
|
+
* Pass `keepalive: true` to let the request outlive its page — e.g.
|
|
6730
|
+
* telemetry sent while the document is navigating away. Browsers cap
|
|
6731
|
+
* keepalive request bodies at ~64 KiB and reject larger ones.
|
|
6732
|
+
*/
|
|
6733
|
+
keepalive?: boolean;
|
|
5686
6734
|
}
|
|
5687
6735
|
type RequestFn = <T>(method: string, path: string, options?: RequestOptions) => Promise<T>;
|
|
5688
6736
|
/**
|
|
@@ -5745,6 +6793,8 @@ declare class Delopay {
|
|
|
5745
6793
|
readonly relay: Relay;
|
|
5746
6794
|
readonly stripeConnect: StripeConnect;
|
|
5747
6795
|
readonly threeDsRules: ThreeDsRules;
|
|
6796
|
+
readonly settlement: Settlement;
|
|
6797
|
+
readonly operationLimits: OperationLimits;
|
|
5748
6798
|
readonly subscriptions: Subscriptions;
|
|
5749
6799
|
readonly files: Files;
|
|
5750
6800
|
readonly export: Export;
|
|
@@ -6371,6 +7421,166 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
|
|
|
6371
7421
|
declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
|
|
6372
7422
|
declare function shadowFor(style: SurfaceStyle): string;
|
|
6373
7423
|
|
|
7424
|
+
/**
|
|
7425
|
+
* A publishable (browser-safe) API key. The template type rejects secret
|
|
7426
|
+
* keys (`prd_…` / `snd_…`) at compile time, so a checkout cannot be handed
|
|
7427
|
+
* a credential that would reach secret-key routes.
|
|
7428
|
+
*/
|
|
7429
|
+
type PublishableKey = `pk_${string}`;
|
|
7430
|
+
/** Configuration for a {@link CheckoutSession}. */
|
|
7431
|
+
interface CheckoutSessionOptions {
|
|
7432
|
+
/** The merchant the payment belongs to. */
|
|
7433
|
+
merchantId: string;
|
|
7434
|
+
/** The payment this session is about. */
|
|
7435
|
+
paymentId: string;
|
|
7436
|
+
/**
|
|
7437
|
+
* The merchant's publishable key (`pk_prd_…` / `pk_snd_…`), from the
|
|
7438
|
+
* checkout payload's `pub_key`. Required for the `/payments/*` and
|
|
7439
|
+
* `/payment-methods` calls.
|
|
7440
|
+
*/
|
|
7441
|
+
publishableKey?: PublishableKey;
|
|
7442
|
+
/**
|
|
7443
|
+
* The payment's client secret, from the checkout payload. Required for
|
|
7444
|
+
* every `/payment-link/*` call, and rides along on the payment calls.
|
|
7445
|
+
*/
|
|
7446
|
+
clientSecret?: string;
|
|
7447
|
+
/** Override the API base URL (e.g. `/api` behind a same-origin proxy). */
|
|
7448
|
+
baseUrl?: string;
|
|
7449
|
+
/** Use the sandbox environment. Ignored when `baseUrl` is set. */
|
|
7450
|
+
sandbox?: boolean;
|
|
7451
|
+
/** Per-request timeout in milliseconds. */
|
|
7452
|
+
timeout?: number;
|
|
7453
|
+
/** Maximum automatic retries for retryable requests. */
|
|
7454
|
+
maxRetries?: number;
|
|
7455
|
+
debug?: boolean;
|
|
7456
|
+
logger?: DelopayLogger;
|
|
7457
|
+
}
|
|
7458
|
+
/**
|
|
7459
|
+
* Buyer-side client for a single hosted-checkout payment.
|
|
7460
|
+
*
|
|
7461
|
+
* Binds the two browser-safe credentials once — the merchant's publishable
|
|
7462
|
+
* key and the payment's client secret — and sends each request with exactly
|
|
7463
|
+
* the credential its route expects:
|
|
7464
|
+
*
|
|
7465
|
+
* - `/payment-link/*` side-channel routes authenticate with
|
|
7466
|
+
* `Authorization: Bearer <client_secret>`.
|
|
7467
|
+
* - `/payments/*` and `/payment-methods` authenticate with the publishable
|
|
7468
|
+
* key in the `api-key` header, with the client secret as query parameter
|
|
7469
|
+
* or body field.
|
|
7470
|
+
*
|
|
7471
|
+
* Neither credential can reach a secret-key route: the publishable key is
|
|
7472
|
+
* typed to the `pk_` prefix and the client secret only ever leaves as a
|
|
7473
|
+
* bearer token / parameter, never as an `api-key`.
|
|
7474
|
+
*
|
|
7475
|
+
* @example
|
|
7476
|
+
* ```typescript
|
|
7477
|
+
* const session = new CheckoutSession({
|
|
7478
|
+
* merchantId: checkout.merchant_id,
|
|
7479
|
+
* paymentId: checkout.payment_id,
|
|
7480
|
+
* publishableKey: checkout.pub_key,
|
|
7481
|
+
* clientSecret: checkout.client_secret,
|
|
7482
|
+
* });
|
|
7483
|
+
* const catalog = await session.payseproMethods('de');
|
|
7484
|
+
* ```
|
|
7485
|
+
*/
|
|
7486
|
+
declare class CheckoutSession {
|
|
7487
|
+
private readonly client;
|
|
7488
|
+
private readonly merchantId;
|
|
7489
|
+
private readonly paymentId;
|
|
7490
|
+
private readonly publishableKey?;
|
|
7491
|
+
private readonly clientSecret?;
|
|
7492
|
+
constructor(options: CheckoutSessionOptions);
|
|
7493
|
+
private get linkBase();
|
|
7494
|
+
/** Headers for the client-secret bearer routes (`/payment-link/*`). */
|
|
7495
|
+
private bearerHeaders;
|
|
7496
|
+
/** Headers for the publishable-key routes (`/payments/*`, `/payment-methods`). */
|
|
7497
|
+
private pkHeaders;
|
|
7498
|
+
private requireClientSecret;
|
|
7499
|
+
/**
|
|
7500
|
+
* The Paysepro rail catalog for the buyer's country.
|
|
7501
|
+
*
|
|
7502
|
+
* `GET /payment-link/{merchantId}/{paymentId}/paysepro/methods`
|
|
7503
|
+
*
|
|
7504
|
+
* @param country - Lowercase ISO 3166-1 alpha-2 country code.
|
|
7505
|
+
*/
|
|
7506
|
+
payseproMethods(country: string, options?: RequestExtras): Promise<PayseproMethodsResponse>;
|
|
7507
|
+
/**
|
|
7508
|
+
* The e-Payouts rail catalog for the buyer's country, plus the set of
|
|
7509
|
+
* countries that have at least one vendor.
|
|
7510
|
+
*
|
|
7511
|
+
* `GET /payment-link/{merchantId}/{paymentId}/epayouts/methods`
|
|
7512
|
+
*
|
|
7513
|
+
* @param country - Lowercase ISO 3166-1 alpha-2 country code.
|
|
7514
|
+
*/
|
|
7515
|
+
epayoutsMethods(country: string, options?: RequestExtras): Promise<EpayoutsMethodsResponse>;
|
|
7516
|
+
/**
|
|
7517
|
+
* Record a buyer-side checkout event on the payment's status timeline.
|
|
7518
|
+
*
|
|
7519
|
+
* Telemetry semantics, built in so callers can genuinely fire-and-forget:
|
|
7520
|
+
* the request is sent with `keepalive: true` (it survives the document
|
|
7521
|
+
* navigating away, e.g. right before a `window.open`), and transport or
|
|
7522
|
+
* server failures resolve to `undefined` instead of rejecting — telemetry
|
|
7523
|
+
* must never break a checkout or surface an unhandled rejection. Do not
|
|
7524
|
+
* `await` this in a click handler that must stay synchronous.
|
|
7525
|
+
*
|
|
7526
|
+
* A missing client secret still throws `MISSING_CREDENTIAL`: that is a
|
|
7527
|
+
* wiring bug, not a telemetry failure.
|
|
7528
|
+
*
|
|
7529
|
+
* `POST /payment-link/{merchantId}/{paymentId}/checkout-events`
|
|
7530
|
+
*/
|
|
7531
|
+
recordEvent(params: RecordCheckoutEventRequest, options?: RequestExtras): Promise<RecordCheckoutEventResponse | undefined>;
|
|
7532
|
+
/**
|
|
7533
|
+
* A short-lived VGS Collect session for browser-side card capture.
|
|
7534
|
+
*
|
|
7535
|
+
* A 404 — or a 400 carrying the "shop has no vault" code — means the shop
|
|
7536
|
+
* has no vault configured; other errors must NOT be treated that way (a
|
|
7537
|
+
* refused vault falling back to an unprotected card pane is exactly the
|
|
7538
|
+
* bug this endpoint's error contract exists to prevent).
|
|
7539
|
+
*
|
|
7540
|
+
* `GET /payment-link/{merchantId}/{paymentId}/vault/collect-session`
|
|
7541
|
+
*/
|
|
7542
|
+
vaultCollectSession(options?: RequestExtras): Promise<VaultCollectSessionResponse>;
|
|
7543
|
+
/**
|
|
7544
|
+
* Register the aliased card as a payment method and mint the one-shot
|
|
7545
|
+
* `payment_token` the confirm call spends.
|
|
7546
|
+
*
|
|
7547
|
+
* `POST /payment-link/{merchantId}/{paymentId}/vault/payment-method`
|
|
7548
|
+
*/
|
|
7549
|
+
registerVaultPaymentMethod(params: VaultPaymentMethodRequest, options?: RequestExtras): Promise<VaultPaymentMethodResponse>;
|
|
7550
|
+
/**
|
|
7551
|
+
* The payment's current state — status polling for redirect/popup rails.
|
|
7552
|
+
*
|
|
7553
|
+
* `GET /payments/{paymentId}` (publishable key + client secret)
|
|
7554
|
+
*/
|
|
7555
|
+
retrievePayment(options?: RequestExtras): Promise<PaymentResponse>;
|
|
7556
|
+
/**
|
|
7557
|
+
* Update the payment before confirmation (e.g. persist custom-field
|
|
7558
|
+
* answers as `metadata` on rails that never hit `/confirm`). The client
|
|
7559
|
+
* secret is attached automatically.
|
|
7560
|
+
*
|
|
7561
|
+
* `POST /payments/{paymentId}` (publishable key)
|
|
7562
|
+
*/
|
|
7563
|
+
updatePayment(params: PaymentUpdateRequest, options?: RequestExtras): Promise<PaymentResponse>;
|
|
7564
|
+
/**
|
|
7565
|
+
* Confirm the payment. The client secret is attached automatically; pass
|
|
7566
|
+
* an `Idempotency-Key` header via `options` to make retries safe.
|
|
7567
|
+
*
|
|
7568
|
+
* `POST /payments/{paymentId}/confirm` (publishable key)
|
|
7569
|
+
*/
|
|
7570
|
+
confirmPayment(params: PaymentConfirmRequest, options?: RequestExtras): Promise<PaymentResponse>;
|
|
7571
|
+
/**
|
|
7572
|
+
* Payment methods available for this payment.
|
|
7573
|
+
*
|
|
7574
|
+
* `GET /payment-methods` (publishable key + client secret)
|
|
7575
|
+
*
|
|
7576
|
+
* @param params - Optional filters; `country` is the highest-precedence
|
|
7577
|
+
* geo hint, ahead of billing address and IP geolocation.
|
|
7578
|
+
*/
|
|
7579
|
+
listPaymentMethods(params?: {
|
|
7580
|
+
country?: string;
|
|
7581
|
+
}, options?: RequestExtras): Promise<PaymentMethodListResponse>;
|
|
7582
|
+
}
|
|
7583
|
+
|
|
6374
7584
|
/**
|
|
6375
7585
|
* How the focused external checkout charges a paned method. Decided
|
|
6376
7586
|
* server-side; the browser never picks.
|
|
@@ -6600,4 +7810,4 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
|
|
|
6600
7810
|
declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
|
|
6601
7811
|
type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
|
|
6602
7812
|
|
|
6603
|
-
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutCustomField, type CheckoutEventKind, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|
|
7813
|
+
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineListParams, type SettlementLineListResponse, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|