@delopay/sdk 0.102.0 → 0.104.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-43FRIBNT.js → chunk-S22IPUCK.js} +248 -5
- package/dist/chunk-S22IPUCK.js.map +1 -0
- package/dist/index.cjs +248 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +899 -27
- package/dist/index.d.ts +899 -27
- package/dist/index.js +3 -1
- package/dist/internal.cjs +248 -4
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +23 -2
- package/dist/internal.d.ts +23 -2
- package/dist/internal.js +3 -1
- package/dist/internal.js.map +1 -1
- package/package.json +17 -18
- package/dist/chunk-43FRIBNT.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1550,6 +1550,20 @@ interface BillingProfileResponse {
|
|
|
1550
1550
|
* exempt from automatic AND manual suspension until the flag is cleared.
|
|
1551
1551
|
*/
|
|
1552
1552
|
is_trusted: boolean;
|
|
1553
|
+
/**
|
|
1554
|
+
* When the trusted shield stops being honoured. Absent means it never
|
|
1555
|
+
* expires, which is what every profile did before expiry existed.
|
|
1556
|
+
*/
|
|
1557
|
+
trusted_until?: string | null;
|
|
1558
|
+
/**
|
|
1559
|
+
* Whether the trusted shield applies **right now** — `is_trusted` and not
|
|
1560
|
+
* past `trusted_until`. Derived server-side and read-only.
|
|
1561
|
+
*
|
|
1562
|
+
* Read this rather than `is_trusted` when deciding whether trust is in
|
|
1563
|
+
* force: `is_trusted` is the raw stored flag and says nothing about expiry,
|
|
1564
|
+
* so gating on it alone treats an expired shield as still active.
|
|
1565
|
+
*/
|
|
1566
|
+
trusted_effective: boolean;
|
|
1553
1567
|
/**
|
|
1554
1568
|
* What caused the current suspension: `auto_recharge` or `admin`. Absent
|
|
1555
1569
|
* when the merchant is not suspended. An `admin` suspension is sticky — a
|
|
@@ -2043,6 +2057,90 @@ interface RoutingConfigUpdateRequest {
|
|
|
2043
2057
|
/** Replacement rule. Validated against the shop exactly as at create. */
|
|
2044
2058
|
algorithm?: StaticRoutingAlgorithm | Record<string, unknown> | null;
|
|
2045
2059
|
}
|
|
2060
|
+
/** What kind of rule a routing configuration holds. */
|
|
2061
|
+
type RoutingAlgorithmKind = 'single' | 'priority' | 'volume_split' | 'advanced' | 'dynamic' | 'three_ds_decision_rule';
|
|
2062
|
+
/**
|
|
2063
|
+
* One content window of a routing configuration — the rule as it stood between
|
|
2064
|
+
* `valid_from` and `valid_until`.
|
|
2065
|
+
*
|
|
2066
|
+
* A config's rule can be edited in place, so the rule that decided a past
|
|
2067
|
+
* payment is only recoverable because every earlier version is kept.
|
|
2068
|
+
*/
|
|
2069
|
+
interface RoutingConfigVersion {
|
|
2070
|
+
/** 1-based position in the configuration's timeline, oldest first. */
|
|
2071
|
+
version: number;
|
|
2072
|
+
/** Name the configuration had during this window. */
|
|
2073
|
+
name: string;
|
|
2074
|
+
/** Description it had during this window. */
|
|
2075
|
+
description: string;
|
|
2076
|
+
kind: RoutingAlgorithmKind;
|
|
2077
|
+
/** The rule itself, exactly as it was during this window. */
|
|
2078
|
+
algorithm: StaticRoutingAlgorithm | Record<string, unknown>;
|
|
2079
|
+
/** When this content took effect. Seconds since epoch — not milliseconds. */
|
|
2080
|
+
valid_from: number;
|
|
2081
|
+
/** When it was replaced, or absent while it is still the live rule. */
|
|
2082
|
+
valid_until?: number | null;
|
|
2083
|
+
}
|
|
2084
|
+
/** Query for `GET /routing/{id}/history`. */
|
|
2085
|
+
interface RoutingHistoryParams {
|
|
2086
|
+
/**
|
|
2087
|
+
* Maximum entries to return, **counting the live one**. `0` is treated as `1`.
|
|
2088
|
+
*/
|
|
2089
|
+
limit?: number | null;
|
|
2090
|
+
/** Entries to skip, counting from the oldest. Advance it by `limit`. */
|
|
2091
|
+
offset?: number | null;
|
|
2092
|
+
}
|
|
2093
|
+
/**
|
|
2094
|
+
* One page of a routing configuration's timeline, oldest first.
|
|
2095
|
+
*
|
|
2096
|
+
* Paging runs over the whole timeline with the live window as its last element,
|
|
2097
|
+
* so `versions` never holds more than `limit` entries and the live window — the
|
|
2098
|
+
* only one without a `valid_until` — appears on exactly one page and not on the
|
|
2099
|
+
* pages before or after it. A page past the end of the timeline is empty. A
|
|
2100
|
+
* configuration nobody has edited returns a single entry, the live one.
|
|
2101
|
+
*/
|
|
2102
|
+
interface RoutingConfigHistoryResponse {
|
|
2103
|
+
id: string;
|
|
2104
|
+
profile_id: string;
|
|
2105
|
+
versions: RoutingConfigVersion[];
|
|
2106
|
+
/**
|
|
2107
|
+
* How long the whole timeline is: every closed window plus the live one.
|
|
2108
|
+
*
|
|
2109
|
+
* Lets you compute the last page directly rather than paging until a response
|
|
2110
|
+
* comes back empty.
|
|
2111
|
+
*/
|
|
2112
|
+
total_count: number;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* A lifetime cap on one connector account: it may take at most `limit`
|
|
2116
|
+
* successful payments for this shop, ever.
|
|
2117
|
+
*
|
|
2118
|
+
* `1` is the acquirer-onboarding case — a new account takes the single live
|
|
2119
|
+
* transaction its review needs, then routing stops selecting it and traffic
|
|
2120
|
+
* returns to the account that was there before. This is a one-time gate, **not**
|
|
2121
|
+
* a recurring budget: nothing resets it.
|
|
2122
|
+
*/
|
|
2123
|
+
interface RoutingConnectorCap {
|
|
2124
|
+
/**
|
|
2125
|
+
* The connector *account*, not the acquirer. A shop with two Stripe accounts
|
|
2126
|
+
* has two of these, and a cap on one is not spent by the other.
|
|
2127
|
+
*/
|
|
2128
|
+
merchant_connector_id: string;
|
|
2129
|
+
/** Successful payments this account may take for this shop, ever. `0` means never route here. */
|
|
2130
|
+
limit: number;
|
|
2131
|
+
/** How many it has taken. Present on reads only; ignored in a write. */
|
|
2132
|
+
used?: number | null;
|
|
2133
|
+
}
|
|
2134
|
+
/** A shop's connector caps. */
|
|
2135
|
+
interface RoutingConnectorCaps {
|
|
2136
|
+
/** The shop. Ignored in a request body — the path names the shop. */
|
|
2137
|
+
profile_id?: string | null;
|
|
2138
|
+
/**
|
|
2139
|
+
* Every capped connector account. This list *is* the complete set: sending an
|
|
2140
|
+
* empty one removes every cap, which is how onboarding finishes.
|
|
2141
|
+
*/
|
|
2142
|
+
caps: RoutingConnectorCap[];
|
|
2143
|
+
}
|
|
2046
2144
|
/** Body for `POST /routing/{id}/activate`. */
|
|
2047
2145
|
interface RoutingActivatePayload {
|
|
2048
2146
|
transaction_type?: TransactionType | null;
|
|
@@ -2966,10 +3064,14 @@ interface ListUsersInLineageParams {
|
|
|
2966
3064
|
*/
|
|
2967
3065
|
profile_id?: string;
|
|
2968
3066
|
}
|
|
3067
|
+
/** The scope level a role or resource belongs to. */
|
|
3068
|
+
type EntityType = 'tenant' | 'organization' | 'merchant' | 'profile';
|
|
2969
3069
|
/** A role a member holds, as returned by `GET /user/employees/list`. */
|
|
2970
3070
|
interface MinimalRoleInfo {
|
|
2971
3071
|
role_id: string;
|
|
2972
3072
|
role_name: string;
|
|
3073
|
+
/** The scope the role is defined at. */
|
|
3074
|
+
entity_type: EntityType;
|
|
2973
3075
|
}
|
|
2974
3076
|
/** One member of the current lineage. `GET /user/employees/list` */
|
|
2975
3077
|
interface UserInLineage {
|
|
@@ -3111,7 +3213,17 @@ interface ConnectorUpdateRequest {
|
|
|
3111
3213
|
metadata?: Record<string, unknown> | null;
|
|
3112
3214
|
test_mode?: boolean | null;
|
|
3113
3215
|
disabled?: boolean | null;
|
|
3216
|
+
/**
|
|
3217
|
+
* Whole-value replacement, not a patch. Send it only when an operator typed
|
|
3218
|
+
* a new secret; omitting it leaves the stored one alone, which is the only
|
|
3219
|
+
* safe default now that `retrieve` returns `null` here.
|
|
3220
|
+
*/
|
|
3114
3221
|
connector_webhook_details?: Record<string, unknown> | null;
|
|
3222
|
+
/** Whole-value replacement — same rule as `connector_webhook_details`. */
|
|
3223
|
+
connector_wallets_details?: Record<string, unknown> | null;
|
|
3224
|
+
/** Whole-value replacement — same rule as `connector_webhook_details`. */
|
|
3225
|
+
pm_auth_config?: Record<string, unknown> | null;
|
|
3226
|
+
/** Whole-value replacement — same rule as `connector_webhook_details`. */
|
|
3115
3227
|
additional_merchant_data?: Record<string, unknown> | null;
|
|
3116
3228
|
}
|
|
3117
3229
|
interface ConnectorCloneRequest {
|
|
@@ -3140,7 +3252,19 @@ interface ConnectorResponse {
|
|
|
3140
3252
|
metadata?: Record<string, unknown> | null;
|
|
3141
3253
|
test_mode?: boolean | null;
|
|
3142
3254
|
disabled?: boolean | null;
|
|
3255
|
+
/**
|
|
3256
|
+
* Credential-bearing, and **`null` on `retrieve()`** whatever is stored —
|
|
3257
|
+
* see that method. `create`, `update` and `clone` return a live value:
|
|
3258
|
+
* clone's is the copied secret, which the caller never sent. Do not log
|
|
3259
|
+
* these four.
|
|
3260
|
+
*/
|
|
3143
3261
|
connector_webhook_details?: Record<string, unknown> | null;
|
|
3262
|
+
/** Credential-bearing — same handling as `connector_webhook_details`. */
|
|
3263
|
+
connector_wallets_details?: Record<string, unknown> | null;
|
|
3264
|
+
/** Credential-bearing — same handling as `connector_webhook_details`. */
|
|
3265
|
+
pm_auth_config?: Record<string, unknown> | null;
|
|
3266
|
+
/** Credential-bearing — same handling as `connector_webhook_details`. */
|
|
3267
|
+
additional_merchant_data?: Record<string, unknown> | null;
|
|
3144
3268
|
created_at?: string | null;
|
|
3145
3269
|
}
|
|
3146
3270
|
interface ConnectorListResponse {
|
|
@@ -3287,6 +3411,10 @@ interface AuthenticationResponse {
|
|
|
3287
3411
|
authentication_connector?: string | null;
|
|
3288
3412
|
force_3ds_challenge?: boolean | null;
|
|
3289
3413
|
return_url?: string | null;
|
|
3414
|
+
/** Connector error code, when the authentication call itself failed. */
|
|
3415
|
+
error_code?: string | null;
|
|
3416
|
+
/** Connector error message, when the authentication call itself failed. */
|
|
3417
|
+
error_message?: string | null;
|
|
3290
3418
|
[key: string]: unknown;
|
|
3291
3419
|
}
|
|
3292
3420
|
interface StripeConnectAccountRequest {
|
|
@@ -4557,8 +4685,24 @@ interface DrillPayment {
|
|
|
4557
4685
|
status: string;
|
|
4558
4686
|
amount_minor?: number | null;
|
|
4559
4687
|
currency?: string | null;
|
|
4560
|
-
/**
|
|
4688
|
+
/**
|
|
4689
|
+
* When the buyer was **observed** — the timestamp of the canonical
|
|
4690
|
+
* client-context row, not of the payment. This is the value the window
|
|
4691
|
+
* filters on, so it always falls inside the requested range.
|
|
4692
|
+
*
|
|
4693
|
+
* Named `created_at` since the endpoint shipped, and kept for
|
|
4694
|
+
* compatibility. Read `payment_created_at` for the payment's own age: the
|
|
4695
|
+
* two can be days apart on a long-lived payment link, and reading this one
|
|
4696
|
+
* as the payment's creation time is what makes a drill list look like it is
|
|
4697
|
+
* ignoring its own window. RFC 3339 UTC.
|
|
4698
|
+
*/
|
|
4561
4699
|
created_at: string;
|
|
4700
|
+
/**
|
|
4701
|
+
* When the **payment** was created, RFC 3339 UTC. Unlike `created_at` this
|
|
4702
|
+
* need not fall inside the requested window: a payment created weeks ago
|
|
4703
|
+
* can be observed today.
|
|
4704
|
+
*/
|
|
4705
|
+
payment_created_at: string;
|
|
4562
4706
|
/** IP-claimed country of the canonical observation. */
|
|
4563
4707
|
country?: string | null;
|
|
4564
4708
|
/** IP-resolved city, when GeoLite2 had one. */
|
|
@@ -4803,6 +4947,22 @@ interface SettlementLineWithProcessorCost extends SettlementLineBase {
|
|
|
4803
4947
|
processor_cost_source: 'reported' | 'estimated';
|
|
4804
4948
|
processor_cost_amount: number;
|
|
4805
4949
|
processor_cost_currency: string;
|
|
4950
|
+
/**
|
|
4951
|
+
* Decimal places `processor_cost_amount` is expressed in:
|
|
4952
|
+
* `processor_cost_amount / 10 ** processor_cost_exponent` units of
|
|
4953
|
+
* `processor_cost_currency`.
|
|
4954
|
+
*
|
|
4955
|
+
* Required alongside the amount, not optional, because the figure does not
|
|
4956
|
+
* decode without it and the currency does not imply it — a rail can report
|
|
4957
|
+
* in an asset whose precision is not a property of its ticker (TRX is 10^6,
|
|
4958
|
+
* and the same ticker on another network can differ). Reading a crypto
|
|
4959
|
+
* rail's 10^8 figure through a card rail's 10^2 overstates it by a
|
|
4960
|
+
* millionfold, so the type refuses to hand over an amount without it.
|
|
4961
|
+
*
|
|
4962
|
+
* The server derives all four cost fields from one source and redacts them
|
|
4963
|
+
* as one, so an amount never arrives without its exponent.
|
|
4964
|
+
*/
|
|
4965
|
+
processor_cost_exponent: number;
|
|
4806
4966
|
}
|
|
4807
4967
|
/**
|
|
4808
4968
|
* A line with no processor-cost figure — which is not a zero.
|
|
@@ -4818,6 +4978,7 @@ interface SettlementLineWithoutProcessorCost extends SettlementLineBase {
|
|
|
4818
4978
|
processor_cost_source?: 'unavailable' | null;
|
|
4819
4979
|
processor_cost_amount?: never;
|
|
4820
4980
|
processor_cost_currency?: never;
|
|
4981
|
+
processor_cost_exponent?: never;
|
|
4821
4982
|
}
|
|
4822
4983
|
/**
|
|
4823
4984
|
* One settled payment attempt. Amounts are native minor units of `currency`.
|
|
@@ -4832,6 +4993,205 @@ interface SettlementLineListResponse {
|
|
|
4832
4993
|
lines: SettlementLine[];
|
|
4833
4994
|
total_count: number;
|
|
4834
4995
|
}
|
|
4996
|
+
/**
|
|
4997
|
+
* How much weight {@link SettlementCostResponse.margin_usd} can carry.
|
|
4998
|
+
*
|
|
4999
|
+
* Three states, not a boolean, because gaps pull in two directions. Missing
|
|
5000
|
+
* cost pushes the margin up; a missing *revenue* bucket — a transaction
|
|
5001
|
+
* currency with no USD rate, dropped from gross, hosting fees and the
|
|
5002
|
+
* platform fee together — pushes it down, and by an amount that may be larger
|
|
5003
|
+
* or smaller than the cost missing with it.
|
|
5004
|
+
*
|
|
5005
|
+
* - `exact` — nothing is missing on either side.
|
|
5006
|
+
* - `upper_bound` — cost-side gaps understate cost and so overstate what is
|
|
5007
|
+
* left. The real figure is `margin_usd` **or lower**; never present it as
|
|
5008
|
+
* exact.
|
|
5009
|
+
* - `unknown` — no direction can be established, so no number is published.
|
|
5010
|
+
* {@link SettlementCostResponse.margin_usd} is absent. Render the reason,
|
|
5011
|
+
* never a zero.
|
|
5012
|
+
*/
|
|
5013
|
+
type MarginQuality = 'exact' | 'upper_bound' | 'unknown';
|
|
5014
|
+
/**
|
|
5015
|
+
* What every figure in a cost rollup rests on.
|
|
5016
|
+
*
|
|
5017
|
+
* - `reported` — observations from the rails.
|
|
5018
|
+
* - `estimated` — configured contract rates. Never present these as observed.
|
|
5019
|
+
* - `mixed` — both. Say so wherever the total might be reconciled against a
|
|
5020
|
+
* processor invoice.
|
|
5021
|
+
* - `none` — nothing priced the period at all.
|
|
5022
|
+
*/
|
|
5023
|
+
type ProcessorCostBasis = 'reported' | 'estimated' | 'mixed' | 'none';
|
|
5024
|
+
/**
|
|
5025
|
+
* One bucket of processor cost, keyed by connector, ownership, cost currency
|
|
5026
|
+
* and cost exponent together.
|
|
5027
|
+
*
|
|
5028
|
+
* The currency is the **rail's**, not the transaction's — a EUR payment on a
|
|
5029
|
+
* rail that settles in USD reports a USD cost — which is why this breakdown
|
|
5030
|
+
* is separate from the settlement buckets rather than a column on them.
|
|
5031
|
+
*
|
|
5032
|
+
* Never sum `cost_amount` across buckets: two buckets can carry different
|
|
5033
|
+
* currencies and different exponents. `cost_usd` is the only cross-bucket
|
|
5034
|
+
* comparable figure, and it is absent when no rate covered the currency.
|
|
5035
|
+
*/
|
|
5036
|
+
interface ProcessorCostBucket {
|
|
5037
|
+
connector?: string | null;
|
|
5038
|
+
ownership: ConnectorOwnership;
|
|
5039
|
+
/**
|
|
5040
|
+
* Currency the rail reported its cut in. Absent on the bucket holding the
|
|
5041
|
+
* lines that carry no figure.
|
|
5042
|
+
*/
|
|
5043
|
+
cost_currency?: string | null;
|
|
5044
|
+
/**
|
|
5045
|
+
* Decimal places `cost_amount` is expressed in: `cost_amount / 10 **
|
|
5046
|
+
* cost_exponent` units of `cost_currency`. Reported beside the figure
|
|
5047
|
+
* because it cannot be derived from the ticker.
|
|
5048
|
+
*/
|
|
5049
|
+
cost_exponent?: number | null;
|
|
5050
|
+
/**
|
|
5051
|
+
* Summed cost in `cost_currency` at `cost_exponent`. Absent — never zero —
|
|
5052
|
+
* when no line in the bucket carries a figure.
|
|
5053
|
+
*/
|
|
5054
|
+
cost_amount?: number | null;
|
|
5055
|
+
/**
|
|
5056
|
+
* `cost_amount` in USD minor units, or absent when no reporting rate
|
|
5057
|
+
* covered `cost_currency`; crypto tickers routinely have none. Absent means
|
|
5058
|
+
* unconverted, not free.
|
|
5059
|
+
*/
|
|
5060
|
+
cost_usd?: number | null;
|
|
5061
|
+
line_count: number;
|
|
5062
|
+
reported_count: number;
|
|
5063
|
+
estimated_count: number;
|
|
5064
|
+
/** The rail was asked and reports no cost — an answer, not a zero. */
|
|
5065
|
+
unavailable_count: number;
|
|
5066
|
+
/** Lines that pre-date cost recording, so nothing ever asked. */
|
|
5067
|
+
unrecorded_count: number;
|
|
5068
|
+
}
|
|
5069
|
+
/**
|
|
5070
|
+
* The period a cost rollup covers: one explicit UTC calendar month, or the
|
|
5071
|
+
* running month.
|
|
5072
|
+
*
|
|
5073
|
+
* A union rather than two optional fields, because half a period is not a
|
|
5074
|
+
* period — the server answers `400 InvalidRequestData` ("year and month must
|
|
5075
|
+
* be given together") rather than guessing the other half, so the shape that
|
|
5076
|
+
* would earn that error does not typecheck.
|
|
5077
|
+
*/
|
|
5078
|
+
type SettlementCostPeriod = {
|
|
5079
|
+
/** UTC calendar year to report. */
|
|
5080
|
+
year: number;
|
|
5081
|
+
/** UTC calendar month, 1..=12. */
|
|
5082
|
+
month: number;
|
|
5083
|
+
} | {
|
|
5084
|
+
/** Omit both for the running month so far. */
|
|
5085
|
+
year?: never;
|
|
5086
|
+
month?: never;
|
|
5087
|
+
};
|
|
5088
|
+
/** Query for the period cost-and-margin rollup. */
|
|
5089
|
+
type SettlementCostParams = {
|
|
5090
|
+
/** Restrict to one shop. Omitted spans every shop of the merchant. */
|
|
5091
|
+
profile_id?: string;
|
|
5092
|
+
/**
|
|
5093
|
+
* Environment switch — test and live figures never blend. Omitted = live.
|
|
5094
|
+
*/
|
|
5095
|
+
test_mode?: boolean;
|
|
5096
|
+
} & SettlementCostPeriod;
|
|
5097
|
+
/**
|
|
5098
|
+
* What a period's payments cost, and what was left over.
|
|
5099
|
+
*
|
|
5100
|
+
* # Who this is for
|
|
5101
|
+
*
|
|
5102
|
+
* The merchant account holder — the host. **Never a shop owner**: gross minus
|
|
5103
|
+
* what the rail charged is the host's cost base, and publishing it to a third
|
|
5104
|
+
* party hands over the margin `platform_fee_amount` is redacted to protect.
|
|
5105
|
+
* The endpoint refuses a profile-scoped caller with a 403 rather than
|
|
5106
|
+
* returning a redacted shell, so a shop-owner caller should never be offered
|
|
5107
|
+
* this surface at all rather than shown one that fails.
|
|
5108
|
+
*
|
|
5109
|
+
* # The processor cost is not a subtrahend
|
|
5110
|
+
*
|
|
5111
|
+
* The rail deducts before the money reaches anyone here. Nothing in this
|
|
5112
|
+
* response moves `net_to_shop`, and no statement figure changes because of
|
|
5113
|
+
* it. This is margin reporting laid over settlement, not part of it.
|
|
5114
|
+
*
|
|
5115
|
+
* All `*_usd` figures are USD minor units (cents).
|
|
5116
|
+
*/
|
|
5117
|
+
interface SettlementCostResponse {
|
|
5118
|
+
/** ISO-8601 inclusive start of the reported period (UTC). */
|
|
5119
|
+
period_start: string;
|
|
5120
|
+
/** ISO-8601 exclusive end of the reported period (UTC). */
|
|
5121
|
+
period_end: string;
|
|
5122
|
+
test_mode: boolean;
|
|
5123
|
+
/** Succeeded volume in the period, USD minor. */
|
|
5124
|
+
gross_usd: number;
|
|
5125
|
+
/** What DeloPay charged the merchant for these attempts, USD minor. */
|
|
5126
|
+
platform_fee_usd: number;
|
|
5127
|
+
/**
|
|
5128
|
+
* What the merchant charged its shop owners (hosting fees), USD minor.
|
|
5129
|
+
* Zero for a merchant that hosts nobody.
|
|
5130
|
+
*/
|
|
5131
|
+
merchant_fee_usd: number;
|
|
5132
|
+
/** What the rails took on these payments, USD minor. */
|
|
5133
|
+
processor_cost_usd: number;
|
|
5134
|
+
/** The share of `processor_cost_usd` borne on host-owned connectors. */
|
|
5135
|
+
host_processor_cost_usd: number;
|
|
5136
|
+
/** Total cost in the period, USD minor. */
|
|
5137
|
+
total_cost_usd: number;
|
|
5138
|
+
/**
|
|
5139
|
+
* What was left over, USD minor — **absent when it cannot be established**.
|
|
5140
|
+
*
|
|
5141
|
+
* Genuinely optional: the field is omitted from the wire, not sent as 0 and
|
|
5142
|
+
* not sent as null, whenever {@link margin_quality} is `'unknown'`. Treat
|
|
5143
|
+
* its absence as a state to render, never as a zero — a 0 here would claim
|
|
5144
|
+
* the period broke even, which is a different statement from *nobody knows*.
|
|
5145
|
+
*
|
|
5146
|
+
* When {@link margin_quality} is `'upper_bound'` the number is real but is
|
|
5147
|
+
* a ceiling: the true figure is this or lower.
|
|
5148
|
+
*/
|
|
5149
|
+
margin_usd?: number;
|
|
5150
|
+
/** How much weight {@link margin_usd} carries. */
|
|
5151
|
+
margin_quality: MarginQuality;
|
|
5152
|
+
/**
|
|
5153
|
+
* Attempts the rail definitely charged for that carry no settlement line —
|
|
5154
|
+
* cost that is definitely missing. This is what drives
|
|
5155
|
+
* {@link margin_quality} to `'unknown'`.
|
|
5156
|
+
*
|
|
5157
|
+
* Distinct from {@link unlined_unresolved_attempt_count}, and not to be
|
|
5158
|
+
* added to it: one is missing money, the other is mostly ordinary
|
|
5159
|
+
* abandonment. Read both against {@link line_count} — "37 unaccounted out of
|
|
5160
|
+
* 4102" is a different statement from "37 out of 40".
|
|
5161
|
+
*/
|
|
5162
|
+
unlined_captured_attempt_count: number;
|
|
5163
|
+
/**
|
|
5164
|
+
* Attempts whose outcome never resolved — mostly ordinary abandonment and
|
|
5165
|
+
* payments still settling. Qualifies the figure rather than withholding it.
|
|
5166
|
+
*/
|
|
5167
|
+
unlined_unresolved_attempt_count: number;
|
|
5168
|
+
/** True exactly when both unlined counts are zero. */
|
|
5169
|
+
coverage_complete: boolean;
|
|
5170
|
+
/** Whether the totals rest on observations, configured rates, or both. */
|
|
5171
|
+
cost_basis: ProcessorCostBasis;
|
|
5172
|
+
/** Settlement lines in the period. */
|
|
5173
|
+
line_count: number;
|
|
5174
|
+
/** Lines carrying a cost figure of any kind. */
|
|
5175
|
+
priced_line_count: number;
|
|
5176
|
+
/** Lines whose cost the rail itself reported. */
|
|
5177
|
+
reported_line_count: number;
|
|
5178
|
+
/** Lines whose cost came from a configured rate. */
|
|
5179
|
+
estimated_line_count: number;
|
|
5180
|
+
/** Lines where the rail was asked and reports nothing. */
|
|
5181
|
+
unavailable_line_count: number;
|
|
5182
|
+
/** Lines that pre-date cost recording, so nothing ever asked. */
|
|
5183
|
+
unrecorded_line_count: number;
|
|
5184
|
+
/** Some line in the period carries no cost figure. */
|
|
5185
|
+
processor_cost_incomplete: boolean;
|
|
5186
|
+
/** Some cost currency had no USD rate, so its cost is not in the total. */
|
|
5187
|
+
processor_cost_fx_incomplete: boolean;
|
|
5188
|
+
/** Some revenue currency had no USD rate, so its bucket is not in gross. */
|
|
5189
|
+
fx_incomplete: boolean;
|
|
5190
|
+
/** Some platform-fee figure could not be resolved. */
|
|
5191
|
+
platform_fee_incomplete: boolean;
|
|
5192
|
+
/** Per-connector cost breakdown. */
|
|
5193
|
+
breakdown: ProcessorCostBucket[];
|
|
5194
|
+
}
|
|
4835
5195
|
interface ShopFeeConfigParams {
|
|
4836
5196
|
profile_id: string;
|
|
4837
5197
|
}
|
|
@@ -4871,15 +5231,38 @@ interface ShopVisibilityResponse {
|
|
|
4871
5231
|
profile_id: string;
|
|
4872
5232
|
visible_to_shop: boolean;
|
|
4873
5233
|
}
|
|
4874
|
-
/**
|
|
4875
|
-
|
|
5234
|
+
/**
|
|
5235
|
+
* Operations that can carry limit rules.
|
|
5236
|
+
*
|
|
5237
|
+
* Which *dimensions* a rule may then set is per-operation, and the server
|
|
5238
|
+
* rejects an upsert that names one the operation cannot honour rather than
|
|
5239
|
+
* saving a rule that renders as configured and enforces nothing:
|
|
5240
|
+
*
|
|
5241
|
+
* - `refund` — every dimension.
|
|
5242
|
+
* - `settlement_adjustment` — amount dimensions only. There is no payment
|
|
5243
|
+
* behind an adjustment, so `max_payment_age_days` means nothing, and an
|
|
5244
|
+
* adjustment is hard-deleted with no tombstone, so a count read back from
|
|
5245
|
+
* live rows counts positions standing rather than adds performed.
|
|
5246
|
+
* - `settlement_payout` — `max_amount_per_operation` only. Recording a payout
|
|
5247
|
+
* mutates one statement row, so the row cannot say how many times anyone
|
|
5248
|
+
* acted, and its date is caller-supplied — neither window is enforceable.
|
|
5249
|
+
*/
|
|
5250
|
+
type LimitedOperation = 'refund' | 'settlement_adjustment' | 'settlement_payout';
|
|
4876
5251
|
/** Rule target: the merchant default, one role, or one user. */
|
|
4877
5252
|
type OperationLimitScope = 'merchant' | 'role' | 'user';
|
|
4878
5253
|
/**
|
|
4879
|
-
* What happens when an operation would exceed its limit.
|
|
4880
|
-
*
|
|
5254
|
+
* What happens when an operation would exceed its limit.
|
|
5255
|
+
*
|
|
5256
|
+
* `block` refuses it outright (`DE_01`). `require_approval` parks it as a
|
|
5257
|
+
* request a second person decides on: the call fails with HTTP 409 `DE_06`
|
|
5258
|
+
* carrying `PendingApprovalErrorDetails`, and the operation executes only
|
|
5259
|
+
* once somebody approves it. Nothing was created either way — the difference
|
|
5260
|
+
* is that `require_approval` names a request that can still succeed.
|
|
5261
|
+
*
|
|
5262
|
+
* `require_approval` is accepted on refund rules alone; the settlement
|
|
5263
|
+
* members of `UpsertOperationLimitRuleRequest` take `block` only.
|
|
4881
5264
|
*/
|
|
4882
|
-
type OperationLimitOnExceeded = 'block';
|
|
5265
|
+
type OperationLimitOnExceeded = 'block' | 'require_approval';
|
|
4883
5266
|
/** How the usage window is anchored. Rolling is the default. */
|
|
4884
5267
|
type OperationLimitWindowMode = 'rolling' | 'calendar';
|
|
4885
5268
|
/**
|
|
@@ -4908,26 +5291,83 @@ interface OperationLimitRule {
|
|
|
4908
5291
|
created_at: string;
|
|
4909
5292
|
modified_at: string;
|
|
4910
5293
|
}
|
|
4911
|
-
/**
|
|
4912
|
-
|
|
4913
|
-
* target. Absent limit fields mean "this rule does not constrain that
|
|
4914
|
-
* dimension"; a request with no limit at all is rejected (delete the rule
|
|
4915
|
-
* instead). Amounts are minor units in `currency`.
|
|
4916
|
-
*/
|
|
4917
|
-
interface UpsertOperationLimitRuleRequest {
|
|
4918
|
-
operation: LimitedOperation;
|
|
5294
|
+
/** What every limit rule names, whatever it constrains. */
|
|
5295
|
+
interface UpsertOperationLimitRuleBase {
|
|
4919
5296
|
scope: OperationLimitScope;
|
|
4920
5297
|
/** Required for `role`/`user` scopes; must be absent for `merchant`. */
|
|
4921
5298
|
scope_id?: string;
|
|
4922
|
-
max_amount_per_operation?: number;
|
|
4923
|
-
max_total_amount_per_window?: number;
|
|
4924
|
-
max_count_per_window?: number;
|
|
4925
|
-
max_payment_age_days?: number;
|
|
4926
5299
|
/** Window length in hours (rolling mode). Defaults to 24; 1–720. */
|
|
4927
5300
|
window_hours?: number;
|
|
4928
5301
|
/** Currency of the amount fields. Defaults to USD. */
|
|
4929
5302
|
currency?: Currency;
|
|
4930
5303
|
}
|
|
5304
|
+
/**
|
|
5305
|
+
* A refund rule — the only operation that takes every dimension, and the only
|
|
5306
|
+
* one that can be sent for approval.
|
|
5307
|
+
*/
|
|
5308
|
+
interface UpsertRefundLimitRuleRequest extends UpsertOperationLimitRuleBase {
|
|
5309
|
+
operation: 'refund';
|
|
5310
|
+
max_amount_per_operation?: number;
|
|
5311
|
+
max_total_amount_per_window?: number;
|
|
5312
|
+
max_count_per_window?: number;
|
|
5313
|
+
/** How old the payment being refunded may be. */
|
|
5314
|
+
max_payment_age_days?: number;
|
|
5315
|
+
/**
|
|
5316
|
+
* What an over-limit refund does. Defaults to `block`, so a rule written by
|
|
5317
|
+
* a client that predates four-eyes keeps refusing rather than silently
|
|
5318
|
+
* becoming approvable.
|
|
5319
|
+
*/
|
|
5320
|
+
on_exceeded?: OperationLimitOnExceeded;
|
|
5321
|
+
}
|
|
5322
|
+
/**
|
|
5323
|
+
* A settlement-adjustment rule: amount dimensions only.
|
|
5324
|
+
*
|
|
5325
|
+
* There is no payment behind an adjustment, so an age limit means nothing,
|
|
5326
|
+
* and an adjustment is hard-deleted with no tombstone, so a count read back
|
|
5327
|
+
* from live rows counts positions standing rather than adds performed. The
|
|
5328
|
+
* server refuses either field rather than saving a rule nothing enforces.
|
|
5329
|
+
*/
|
|
5330
|
+
interface UpsertSettlementAdjustmentLimitRuleRequest extends UpsertOperationLimitRuleBase {
|
|
5331
|
+
operation: 'settlement_adjustment';
|
|
5332
|
+
max_amount_per_operation?: number;
|
|
5333
|
+
max_total_amount_per_window?: number;
|
|
5334
|
+
max_count_per_window?: never;
|
|
5335
|
+
max_payment_age_days?: never;
|
|
5336
|
+
/**
|
|
5337
|
+
* `block` only. Approval needs an executor that can run the operation once
|
|
5338
|
+
* somebody says yes, and only refunds have one — the server refuses
|
|
5339
|
+
* `require_approval` here rather than storing it and quietly blocking.
|
|
5340
|
+
*/
|
|
5341
|
+
on_exceeded?: 'block';
|
|
5342
|
+
}
|
|
5343
|
+
/**
|
|
5344
|
+
* A payout-recording rule: a per-operation ceiling and nothing else.
|
|
5345
|
+
*
|
|
5346
|
+
* Recording a payout mutates one statement row, so the row cannot say how
|
|
5347
|
+
* many times anyone acted, and its window would rest on a caller-supplied
|
|
5348
|
+
* business date. Neither window is enforceable, so neither is accepted.
|
|
5349
|
+
*/
|
|
5350
|
+
interface UpsertSettlementPayoutLimitRuleRequest extends UpsertOperationLimitRuleBase {
|
|
5351
|
+
operation: 'settlement_payout';
|
|
5352
|
+
max_amount_per_operation?: number;
|
|
5353
|
+
max_total_amount_per_window?: never;
|
|
5354
|
+
max_count_per_window?: never;
|
|
5355
|
+
max_payment_age_days?: never;
|
|
5356
|
+
/** `block` only — see `UpsertSettlementAdjustmentLimitRuleRequest`. */
|
|
5357
|
+
on_exceeded?: 'block';
|
|
5358
|
+
}
|
|
5359
|
+
/**
|
|
5360
|
+
* Body for `PUT /operation-limits/rules` — a full-replace upsert for one
|
|
5361
|
+
* target. Absent limit fields mean "this rule does not constrain that
|
|
5362
|
+
* dimension"; a request with no limit at all is rejected (delete the rule
|
|
5363
|
+
* instead). Amounts are minor units in `currency`.
|
|
5364
|
+
*
|
|
5365
|
+
* Which dimensions a rule may set depends on the operation, and the union
|
|
5366
|
+
* says so: the server rejects a rule naming one its operation cannot honour,
|
|
5367
|
+
* because a rule that saves, lists and renders while no hook can read it is
|
|
5368
|
+
* worse than a refused one.
|
|
5369
|
+
*/
|
|
5370
|
+
type UpsertOperationLimitRuleRequest = UpsertRefundLimitRuleRequest | UpsertSettlementAdjustmentLimitRuleRequest | UpsertSettlementPayoutLimitRuleRequest;
|
|
4931
5371
|
interface OperationLimitRuleListParams {
|
|
4932
5372
|
/** Without `operation`, every rule of the caller's merchant is returned. */
|
|
4933
5373
|
operation?: LimitedOperation;
|
|
@@ -4950,6 +5390,105 @@ interface UpdateOperationLimitSettingsRequest {
|
|
|
4950
5390
|
window_mode?: OperationLimitWindowMode;
|
|
4951
5391
|
admins_exempt?: boolean;
|
|
4952
5392
|
}
|
|
5393
|
+
/**
|
|
5394
|
+
* Lifecycle of an over-limit request.
|
|
5395
|
+
*
|
|
5396
|
+
* There is no `executed` state: approving and executing are two facts, so an
|
|
5397
|
+
* approved request that failed to execute stays `approved` and carries
|
|
5398
|
+
* `execution_error`. Read `executed_at` and `result_entity_id` to tell an
|
|
5399
|
+
* approval that ran from one that has not.
|
|
5400
|
+
*/
|
|
5401
|
+
type PendingOperationStatus = 'pending' | 'approved' | 'rejected' | 'expired';
|
|
5402
|
+
/** Which limit the operation ran into, and by how much. */
|
|
5403
|
+
interface PendingOperationLimitContext {
|
|
5404
|
+
/** The dimension that tripped, e.g. `max_amount_per_operation`. */
|
|
5405
|
+
limit_type: string;
|
|
5406
|
+
/** The configured ceiling, in minor units of `currency` where it is an amount. */
|
|
5407
|
+
limit?: number | null;
|
|
5408
|
+
/** What the operation asked for, on the same scale as `limit`. */
|
|
5409
|
+
attempted?: number | null;
|
|
5410
|
+
/** For `max_payment_age_days`: how old the payment being refunded is. */
|
|
5411
|
+
attempted_age_seconds?: number | null;
|
|
5412
|
+
currency?: string | null;
|
|
5413
|
+
}
|
|
5414
|
+
/** What the request is about, in the words of the operation that parked it. */
|
|
5415
|
+
interface PendingOperationSummary {
|
|
5416
|
+
payment_id: string;
|
|
5417
|
+
/** Minor units of `currency`. */
|
|
5418
|
+
amount?: number | null;
|
|
5419
|
+
currency?: string | null;
|
|
5420
|
+
reason?: string | null;
|
|
5421
|
+
}
|
|
5422
|
+
/** One over-limit request in the approvals inbox. */
|
|
5423
|
+
interface PendingOperation {
|
|
5424
|
+
id: string;
|
|
5425
|
+
merchant_id: string;
|
|
5426
|
+
profile_id?: string | null;
|
|
5427
|
+
operation: LimitedOperation;
|
|
5428
|
+
status: PendingOperationStatus;
|
|
5429
|
+
summary?: PendingOperationSummary | null;
|
|
5430
|
+
idempotency_key?: string | null;
|
|
5431
|
+
/** The rule that diverted it, when it is still around. */
|
|
5432
|
+
rule_id?: string | null;
|
|
5433
|
+
limit_context?: PendingOperationLimitContext | null;
|
|
5434
|
+
/** The user who asked. The server refuses to let them decide their own request. */
|
|
5435
|
+
requested_by: string;
|
|
5436
|
+
requested_by_role_id?: string | null;
|
|
5437
|
+
request_reason?: string | null;
|
|
5438
|
+
decided_by?: string | null;
|
|
5439
|
+
decided_by_role_id?: string | null;
|
|
5440
|
+
decision_note?: string | null;
|
|
5441
|
+
/** RFC 3339 UTC; absent while `pending`. */
|
|
5442
|
+
decided_at?: string | null;
|
|
5443
|
+
/** RFC 3339 UTC. Past this, the request expires and can no longer be approved. */
|
|
5444
|
+
expires_at: string;
|
|
5445
|
+
/** RFC 3339 UTC. Set when the approved operation actually ran. */
|
|
5446
|
+
executed_at?: string | null;
|
|
5447
|
+
/** The id the executed operation produced — a refund id, for a refund. */
|
|
5448
|
+
result_entity_id?: string | null;
|
|
5449
|
+
/** Why an approved operation failed to execute. `approved` with this set is a real state. */
|
|
5450
|
+
execution_error?: string | null;
|
|
5451
|
+
created_at: string;
|
|
5452
|
+
}
|
|
5453
|
+
interface PendingOperationListParams {
|
|
5454
|
+
/**
|
|
5455
|
+
* Which operation's requests to list. **Defaults to `refund`** — the list
|
|
5456
|
+
* is one operation at a time, not all of them, so a view that covers more
|
|
5457
|
+
* than refunds must ask per operation.
|
|
5458
|
+
*/
|
|
5459
|
+
operation?: LimitedOperation;
|
|
5460
|
+
/**
|
|
5461
|
+
* **Defaults to `pending`.** Omitting this filters to what is still
|
|
5462
|
+
* awaiting a decision, not to everything: approved, rejected and expired
|
|
5463
|
+
* requests are reachable only by asking for that status explicitly.
|
|
5464
|
+
*/
|
|
5465
|
+
status?: PendingOperationStatus;
|
|
5466
|
+
/** Defaults to 100, clamped to 1–500. */
|
|
5467
|
+
limit?: number;
|
|
5468
|
+
}
|
|
5469
|
+
interface PendingOperationListResponse {
|
|
5470
|
+
requests: PendingOperation[];
|
|
5471
|
+
}
|
|
5472
|
+
/** Body for approve/reject. The note is recorded on the request. */
|
|
5473
|
+
interface DecidePendingOperationRequest {
|
|
5474
|
+
note?: string;
|
|
5475
|
+
}
|
|
5476
|
+
/**
|
|
5477
|
+
* `DelopayError.data` on the 409 `DE_06` a refund gets when a
|
|
5478
|
+
* `require_approval` rule parks it. Refunds are the only operation that can
|
|
5479
|
+
* be parked, so this is the only call that raises `DE_06`.
|
|
5480
|
+
*
|
|
5481
|
+
* A non-2xx deliberately: nothing was created, so a 2xx envelope would be
|
|
5482
|
+
* decoded as a refund that does not exist. Distinct from `DE_01`, which says
|
|
5483
|
+
* the operation will not happen at all — this one names a request a second
|
|
5484
|
+
* person can still approve, and until when.
|
|
5485
|
+
*/
|
|
5486
|
+
interface PendingApprovalErrorDetails {
|
|
5487
|
+
pending_operation_id: string;
|
|
5488
|
+
/** RFC 3339 UTC. */
|
|
5489
|
+
expires_at: string;
|
|
5490
|
+
limit_context?: PendingOperationLimitContext | null;
|
|
5491
|
+
}
|
|
4953
5492
|
/** Half-open amount range filter; minor units. `null` bounds are open. */
|
|
4954
5493
|
interface AmountFilter {
|
|
4955
5494
|
start_amount?: number | null;
|
|
@@ -5295,6 +5834,112 @@ interface EpayoutsCatalogResponse {
|
|
|
5295
5834
|
countries_probed?: number | null;
|
|
5296
5835
|
countries_ok?: number | null;
|
|
5297
5836
|
}
|
|
5837
|
+
/**
|
|
5838
|
+
* One connector's stored risk index for a shop.
|
|
5839
|
+
*
|
|
5840
|
+
* Read-only snapshots — neither endpoint scores anything on demand, so
|
|
5841
|
+
* `computed_at` is the age of the answer and can be older than the request.
|
|
5842
|
+
*/
|
|
5843
|
+
interface ConnectorRisk {
|
|
5844
|
+
connector: string;
|
|
5845
|
+
/** Coarse bucket the index falls in, e.g. `low` / `elevated` / `high`. */
|
|
5846
|
+
band: string;
|
|
5847
|
+
/** The index itself, when the snapshot carries one. */
|
|
5848
|
+
index?: number | null;
|
|
5849
|
+
/** Direction against the previous snapshot, when there is one to compare. */
|
|
5850
|
+
trend?: string | null;
|
|
5851
|
+
/** Which scoring model produced it. Bands are not comparable across versions. */
|
|
5852
|
+
model_version: number;
|
|
5853
|
+
/** RFC 3339 UTC — when the snapshot was computed, not when it was read. */
|
|
5854
|
+
computed_at: string;
|
|
5855
|
+
/**
|
|
5856
|
+
* Per-signal contributions behind the index.
|
|
5857
|
+
*
|
|
5858
|
+
* Any JSON value: the backend passes the stored blob through verbatim and
|
|
5859
|
+
* its shape is the scoring model's business, so it is versioned by
|
|
5860
|
+
* `model_version` rather than by this type — an object today, an array in
|
|
5861
|
+
* the backend's own fixture. Narrow it against the model you support;
|
|
5862
|
+
* do not assume it is keyed.
|
|
5863
|
+
*/
|
|
5864
|
+
components: unknown;
|
|
5865
|
+
}
|
|
5866
|
+
/** One shop's stored risk, per connector. */
|
|
5867
|
+
interface ShopRisk {
|
|
5868
|
+
shop_id: string;
|
|
5869
|
+
/** Newest `computed_at` across `connectors`; absent when the shop has none. */
|
|
5870
|
+
computed_at?: string | null;
|
|
5871
|
+
connectors: ConnectorRisk[];
|
|
5872
|
+
}
|
|
5873
|
+
/**
|
|
5874
|
+
* The merchant-wide roll-up.
|
|
5875
|
+
*
|
|
5876
|
+
* A shop-scoped caller — a JWT with a profile-scoped role, or an API key
|
|
5877
|
+
* pinned to one shop — gets its own shop and no sibling's, from this endpoint
|
|
5878
|
+
* as much as from the per-shop one.
|
|
5879
|
+
*/
|
|
5880
|
+
interface MerchantRisk {
|
|
5881
|
+
merchant_id: string;
|
|
5882
|
+
/** Worst band across every shop; absent when nothing has been scored. */
|
|
5883
|
+
worst_band?: string | null;
|
|
5884
|
+
shops: ShopRisk[];
|
|
5885
|
+
}
|
|
5886
|
+
/** How far along a connector's integration is. */
|
|
5887
|
+
type ConnectorIntegrationStatus = 'live' | 'sandbox' | 'beta' | 'alpha';
|
|
5888
|
+
/** What kind of processor a connector is. */
|
|
5889
|
+
type DelopayConnectorCategory = 'payment_gateway' | 'alternative_payment_method' | 'bank_acquirer' | 'payout_processor' | 'authentication_provider' | 'fraud_and_risk_management_provider' | 'tax_calculation_provider' | 'revenue_growth_management_platform' | 'vault_provider';
|
|
5890
|
+
/** Whether one feature is available on a connector's payment method. */
|
|
5891
|
+
type FeatureStatus = 'supported' | 'not_supported';
|
|
5892
|
+
/** Card-only additions to a supported payment method. */
|
|
5893
|
+
interface CardSpecificFeatures {
|
|
5894
|
+
three_ds: FeatureStatus;
|
|
5895
|
+
no_three_ds: FeatureStatus;
|
|
5896
|
+
/** Card network names, as the connector reports them. */
|
|
5897
|
+
supported_card_networks: string[];
|
|
5898
|
+
}
|
|
5899
|
+
/** One payment method type a connector supports, and what it supports on it. */
|
|
5900
|
+
interface SupportedPaymentMethod extends Partial<CardSpecificFeatures> {
|
|
5901
|
+
payment_method: PaymentMethod;
|
|
5902
|
+
payment_method_type: PaymentMethodType;
|
|
5903
|
+
payment_method_type_display_name: string;
|
|
5904
|
+
mandates: FeatureStatus;
|
|
5905
|
+
refunds: FeatureStatus;
|
|
5906
|
+
supported_capture_methods: CaptureMethod[];
|
|
5907
|
+
/** ISO 3166-1 alpha-3 codes. */
|
|
5908
|
+
supported_countries?: string[] | null;
|
|
5909
|
+
supported_currencies?: Currency[] | null;
|
|
5910
|
+
}
|
|
5911
|
+
/** One connector's entry in the feature matrix. */
|
|
5912
|
+
interface ConnectorFeatureMatrixEntry {
|
|
5913
|
+
name: string;
|
|
5914
|
+
display_name: string;
|
|
5915
|
+
description: string;
|
|
5916
|
+
base_url?: string | null;
|
|
5917
|
+
category: DelopayConnectorCategory;
|
|
5918
|
+
integration_status: ConnectorIntegrationStatus;
|
|
5919
|
+
supported_payment_methods?: SupportedPaymentMethod[] | null;
|
|
5920
|
+
supported_webhook_flows?: EventClass[] | null;
|
|
5921
|
+
/**
|
|
5922
|
+
* Whether the connector rejects an incoming webhook it cannot verify,
|
|
5923
|
+
* rather than processing it unverified.
|
|
5924
|
+
*
|
|
5925
|
+
* A statement about failure, not about setup. `true` means an event that
|
|
5926
|
+
* does not verify is dropped at the door; `false` means a failed
|
|
5927
|
+
* verification is not by itself a reason to discard the event.
|
|
5928
|
+
*
|
|
5929
|
+
* It does **not** say the merchant must supply a credential, and must not
|
|
5930
|
+
* be read that way: some connectors verify a signature against a value
|
|
5931
|
+
* stored on the connector account, others check the request's source IP and
|
|
5932
|
+
* fall back to the vendor's documented egress address — fail-closed either
|
|
5933
|
+
* way, with nothing to enter. Read it as "an unverified event will not be
|
|
5934
|
+
* acted on". Which field, if any, the setup flow must then collect is a
|
|
5935
|
+
* separate question the connector's own config answers.
|
|
5936
|
+
*/
|
|
5937
|
+
webhook_source_verification_mandatory: boolean;
|
|
5938
|
+
}
|
|
5939
|
+
interface FeatureMatrixResponse {
|
|
5940
|
+
connector_count: number;
|
|
5941
|
+
connectors: ConnectorFeatureMatrixEntry[];
|
|
5942
|
+
}
|
|
5298
5943
|
|
|
5299
5944
|
/** Create and manage API keys for a merchant account. */
|
|
5300
5945
|
declare class ApiKeys {
|
|
@@ -5553,7 +6198,32 @@ declare class Connectors {
|
|
|
5553
6198
|
private readonly request;
|
|
5554
6199
|
constructor(request: RequestFn);
|
|
5555
6200
|
create(accountId: string, params: ConnectorCreateRequest): Promise<ConnectorResponse>;
|
|
6201
|
+
/**
|
|
6202
|
+
* One connector account.
|
|
6203
|
+
*
|
|
6204
|
+
* The credential-bearing fields come back `null` here, whatever is stored:
|
|
6205
|
+
* `connector_webhook_details`, `connector_wallets_details`,
|
|
6206
|
+
* `pm_auth_config` and `additional_merchant_data`. They are dropped rather
|
|
6207
|
+
* than masked, because an editor that prefills from this response and
|
|
6208
|
+
* PATCHes the field back would otherwise save a mask over a live signing
|
|
6209
|
+
* secret. Send those fields only when the operator has typed a new value,
|
|
6210
|
+
* and omit them entirely otherwise — an omitted field leaves the stored one
|
|
6211
|
+
* alone.
|
|
6212
|
+
*
|
|
6213
|
+
* This is the retrieve path alone. `create` and `update` echo back what the
|
|
6214
|
+
* caller sent, and `clone` returns the *copied* secrets — see that method.
|
|
6215
|
+
*
|
|
6216
|
+
* `GET /account/{accountId}/connectors/{connectorId}`
|
|
6217
|
+
*/
|
|
5556
6218
|
retrieve(accountId: string, connectorId: string): Promise<ConnectorResponse>;
|
|
6219
|
+
/**
|
|
6220
|
+
* The merchant's connector accounts.
|
|
6221
|
+
*
|
|
6222
|
+
* Never wider than the caller: an API key pinned to one shop lists that
|
|
6223
|
+
* shop's connectors only, not every sibling shop's.
|
|
6224
|
+
*
|
|
6225
|
+
* `GET /account/{accountId}/connectors`
|
|
6226
|
+
*/
|
|
5557
6227
|
list(accountId: string): Promise<ConnectorResponse[]>;
|
|
5558
6228
|
/**
|
|
5559
6229
|
* The profile-scoped connector list. The merchant-wide `list()` is
|
|
@@ -5577,15 +6247,30 @@ declare class Connectors {
|
|
|
5577
6247
|
*/
|
|
5578
6248
|
syncEpayoutsCatalog(accountId: string, connectorId: string): Promise<EpayoutsCatalogResponse>;
|
|
5579
6249
|
update(accountId: string, connectorId: string, params: ConnectorUpdateRequest): Promise<ConnectorResponse>;
|
|
6250
|
+
/**
|
|
6251
|
+
* Remove a connector account.
|
|
6252
|
+
*
|
|
6253
|
+
* A shop-scoped role may remove a connector of its own shop — the shop is
|
|
6254
|
+
* re-checked server-side — so creating processors and removing them are the
|
|
6255
|
+
* same rung of access rather than two.
|
|
6256
|
+
*
|
|
6257
|
+
* `DELETE /account/{accountId}/connectors/{connectorId}`
|
|
6258
|
+
*/
|
|
5580
6259
|
delete(accountId: string, connectorId: string): Promise<ConnectorResponse>;
|
|
5581
6260
|
/**
|
|
5582
6261
|
* Clone a connector into another shop (business profile) of the same
|
|
5583
6262
|
* merchant. `POST /account/{accountId}/connectors/{connectorId}/clone`
|
|
5584
6263
|
*
|
|
5585
6264
|
* Credentials are copied server-side, re-encrypted under the same merchant
|
|
5586
|
-
* key
|
|
5587
|
-
*
|
|
5588
|
-
* the
|
|
6265
|
+
* key, so the caller never has to *supply* them — `retrieve` returns `null`
|
|
6266
|
+
* for the credential fields, which is what makes a client-side copy
|
|
6267
|
+
* impossible in the first place.
|
|
6268
|
+
*
|
|
6269
|
+
* The response, however, is the unredacted connector: `connector_account_details`
|
|
6270
|
+
* is masked, but `connector_webhook_details`, `connector_wallets_details`,
|
|
6271
|
+
* `pm_auth_config` and `additional_merchant_data` come back with the copied
|
|
6272
|
+
* secrets in them — values this caller never sent. Do not log or echo the
|
|
6273
|
+
* response; read `merchant_connector_id` and discard the rest.
|
|
5589
6274
|
*/
|
|
5590
6275
|
clone(accountId: string, connectorId: string, params: ConnectorCloneRequest): Promise<ConnectorResponse>;
|
|
5591
6276
|
/**
|
|
@@ -5857,6 +6542,11 @@ declare class Disputes {
|
|
|
5857
6542
|
* Ephemeral keys grant a mobile or browser client temporary access to a
|
|
5858
6543
|
* specific customer's data (e.g. to display saved payment methods) without
|
|
5859
6544
|
* exposing your secret API key.
|
|
6545
|
+
*
|
|
6546
|
+
* The key is confined to the customer it was minted for, and that is
|
|
6547
|
+
* enforced on every customer and payment-method route: a request for another
|
|
6548
|
+
* customer — or for a payment method belonging to one — is refused rather
|
|
6549
|
+
* than served. Mint one key per customer; do not reuse a key across them.
|
|
5860
6550
|
*/
|
|
5861
6551
|
declare class EphemeralKeys {
|
|
5862
6552
|
private readonly request;
|
|
@@ -6215,6 +6905,13 @@ declare class Payments {
|
|
|
6215
6905
|
* test_mode: process.env.NODE_ENV !== 'production',
|
|
6216
6906
|
* });
|
|
6217
6907
|
* ```
|
|
6908
|
+
*
|
|
6909
|
+
* A payment that pins one connector through `routing` (the `single` form)
|
|
6910
|
+
* is now checked against `test_mode` here rather than at confirm: if that
|
|
6911
|
+
* connector has no credentials for the environment asked for, create fails
|
|
6912
|
+
* instead of handing back a payment whose checkout the buyer cannot
|
|
6913
|
+
* complete. `priority` and `volume_split` name several accounts and are
|
|
6914
|
+
* still resolved at confirm.
|
|
6218
6915
|
*/
|
|
6219
6916
|
create(params: PaymentCreateRequest, options?: RequestExtras): Promise<PaymentResponse>;
|
|
6220
6917
|
/**
|
|
@@ -6610,6 +7307,14 @@ declare class Refunds {
|
|
|
6610
7307
|
/**
|
|
6611
7308
|
* Create a refund for a payment.
|
|
6612
7309
|
*
|
|
7310
|
+
* Dashboard-initiated refunds are subject to the caller's operation-limit
|
|
7311
|
+
* rule, resolved against the role the request authenticated with. An
|
|
7312
|
+
* over-limit refund either fails with `DE_01` (the rule blocks) or with
|
|
7313
|
+
* HTTP 409 `DE_06` — the rule requires approval, and `DelopayError.data`
|
|
7314
|
+
* carries `PendingApprovalErrorDetails`. No refund exists in either case;
|
|
7315
|
+
* `DE_06` names one that a second approver can still let through, via
|
|
7316
|
+
* `operationLimits.approve()`.
|
|
7317
|
+
*
|
|
6613
7318
|
* @param params - Refund parameters, including the required `payment_id` and optional amount.
|
|
6614
7319
|
* @returns The created refund.
|
|
6615
7320
|
*
|
|
@@ -6782,6 +7487,45 @@ declare class Routing {
|
|
|
6782
7487
|
* @returns The updated routing configuration including the algorithm body.
|
|
6783
7488
|
*/
|
|
6784
7489
|
update(algorithmId: string, params: RoutingConfigUpdateRequest): Promise<MerchantRoutingAlgorithm>;
|
|
7490
|
+
/**
|
|
7491
|
+
* Every content window a routing configuration has had, oldest first.
|
|
7492
|
+
*
|
|
7493
|
+
* A configuration's rule can be edited in place, so this is what makes "which
|
|
7494
|
+
* rule decided this payment" answerable after the fact. Each entry is the rule
|
|
7495
|
+
* as it stood between `valid_from` and `valid_until`; the windows of one
|
|
7496
|
+
* config abut exactly, with no gap.
|
|
7497
|
+
*
|
|
7498
|
+
* Paging covers the whole timeline including the live window, so a page never
|
|
7499
|
+
* holds more than `limit` entries and the live one — the only entry without a
|
|
7500
|
+
* `valid_until` — comes back on exactly one page. Advance `offset` by `limit`;
|
|
7501
|
+
* a page past the end is empty, and `total_count` says where that end is
|
|
7502
|
+
* without probing for it.
|
|
7503
|
+
*
|
|
7504
|
+
* `GET /routing/{algorithmId}/history`
|
|
7505
|
+
*
|
|
7506
|
+
* @param algorithmId - The routing algorithm to read the history of.
|
|
7507
|
+
* @param params - Optional paging.
|
|
7508
|
+
*/
|
|
7509
|
+
history(algorithmId: string, params?: RoutingHistoryParams): Promise<RoutingConfigHistoryResponse>;
|
|
7510
|
+
/**
|
|
7511
|
+
* A shop's lifetime per-connector payment caps, each with how much of it is
|
|
7512
|
+
* already spent.
|
|
7513
|
+
*
|
|
7514
|
+
* `GET /routing/connector-caps/{profileId}`
|
|
7515
|
+
*/
|
|
7516
|
+
connectorCaps(profileId: string): Promise<RoutingConnectorCaps>;
|
|
7517
|
+
/**
|
|
7518
|
+
* Replace a shop's per-connector payment caps.
|
|
7519
|
+
*
|
|
7520
|
+
* Whole-set replacement, not a patch: the list sent becomes the complete set
|
|
7521
|
+
* of capped connectors, and an empty list clears them all — which is how
|
|
7522
|
+
* acquirer onboarding finishes, the new account ceasing to be a special case.
|
|
7523
|
+
*
|
|
7524
|
+
* Every account named must belong to this shop; one that does not is refused.
|
|
7525
|
+
*
|
|
7526
|
+
* `PUT /routing/connector-caps/{profileId}`
|
|
7527
|
+
*/
|
|
7528
|
+
setConnectorCaps(profileId: string, params: RoutingConnectorCaps): Promise<RoutingConnectorCaps>;
|
|
6785
7529
|
/**
|
|
6786
7530
|
* List all routing algorithms for the current merchant.
|
|
6787
7531
|
*
|
|
@@ -7493,7 +8237,15 @@ declare class Users {
|
|
|
7493
8237
|
getAuthUrl(): Promise<Record<string, unknown>>;
|
|
7494
8238
|
/** Select auth method. `POST /user/auth/select` */
|
|
7495
8239
|
selectAuth(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
7496
|
-
/**
|
|
8240
|
+
/**
|
|
8241
|
+
* List users in lineage.
|
|
8242
|
+
*
|
|
8243
|
+
* Needs the Users *view* grant now — the response carries colleagues' email
|
|
8244
|
+
* addresses, so a role without it is refused rather than handed a roster.
|
|
8245
|
+
* A shop-scoped role keeps reading its own shop's members.
|
|
8246
|
+
*
|
|
8247
|
+
* `GET /user/employees/list`
|
|
8248
|
+
*/
|
|
7497
8249
|
listUsersInLineage(params?: ListUsersInLineageParams): Promise<UserInLineage[]>;
|
|
7498
8250
|
/** Resend invite. `POST /user/resend-invite` */
|
|
7499
8251
|
resendInvite(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
@@ -7666,18 +8418,22 @@ declare class Export {
|
|
|
7666
8418
|
transactions(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
7667
8419
|
}
|
|
7668
8420
|
|
|
8421
|
+
/**
|
|
8422
|
+
* What each connector can do: payment methods, capture methods, webhook
|
|
8423
|
+
* flows, and whether an unverified webhook is acted on.
|
|
8424
|
+
*/
|
|
7669
8425
|
declare class FeatureMatrix {
|
|
7670
8426
|
private readonly request;
|
|
7671
8427
|
constructor(request: RequestFn);
|
|
7672
8428
|
/** Retrieve the feature matrix. `GET /feature-matrix` */
|
|
7673
|
-
retrieve(): Promise<
|
|
8429
|
+
retrieve(): Promise<FeatureMatrixResponse>;
|
|
7674
8430
|
/**
|
|
7675
8431
|
* Retrieve the feature matrix scoped to a merchant. Beta connectors
|
|
7676
8432
|
* are filtered against the merchant's allowlist so the dashboard only
|
|
7677
8433
|
* surfaces connectors the merchant can actually attach.
|
|
7678
8434
|
* `GET /feature-matrix/{merchantId}`
|
|
7679
8435
|
*/
|
|
7680
|
-
retrieveForMerchant(merchantId: string): Promise<
|
|
8436
|
+
retrieveForMerchant(merchantId: string): Promise<FeatureMatrixResponse>;
|
|
7681
8437
|
}
|
|
7682
8438
|
|
|
7683
8439
|
declare class Files {
|
|
@@ -7896,6 +8652,36 @@ declare class Settlement {
|
|
|
7896
8652
|
* `GET /settlement/current`
|
|
7897
8653
|
*/
|
|
7898
8654
|
current(params: SettlementCurrentParams, options?: RequestExtras): Promise<SettlementCurrentResponse>;
|
|
8655
|
+
/**
|
|
8656
|
+
* What a period's payments cost, and what was left over: gross, the
|
|
8657
|
+
* platform fee, hosting fees, what the rails took, and the margin, with a
|
|
8658
|
+
* per-connector breakdown.
|
|
8659
|
+
*
|
|
8660
|
+
* Send `year` and `month` together to report one UTC calendar month, or
|
|
8661
|
+
* neither for the running month so far.
|
|
8662
|
+
*
|
|
8663
|
+
* **Host-only.** The response is the host's cost base, which a shop owner
|
|
8664
|
+
* must never see, so a profile-scoped caller is refused with a 403 rather
|
|
8665
|
+
* than given a redacted shell. Gate the surface on the caller's scope
|
|
8666
|
+
* instead of calling it and handling the failure.
|
|
8667
|
+
*
|
|
8668
|
+
* Two things not to flatten when rendering the result:
|
|
8669
|
+
* `margin_usd` is absent — not zero — whenever `margin_quality` is
|
|
8670
|
+
* `'unknown'`, and `unlined_captured_attempt_count` (cost definitely
|
|
8671
|
+
* missing) means something different from `unlined_unresolved_attempt_count`
|
|
8672
|
+
* (mostly ordinary abandonment).
|
|
8673
|
+
*
|
|
8674
|
+
* `GET /settlement/cost`
|
|
8675
|
+
*
|
|
8676
|
+
* @example
|
|
8677
|
+
* ```typescript
|
|
8678
|
+
* const cost = await delopay.settlement.cost({ test_mode: false, year: 2026, month: 7 });
|
|
8679
|
+
* if (cost.margin_quality === 'unknown') {
|
|
8680
|
+
* // cost.margin_usd is absent — say so, do not render 0.00
|
|
8681
|
+
* }
|
|
8682
|
+
* ```
|
|
8683
|
+
*/
|
|
8684
|
+
cost(params?: SettlementCostParams, options?: RequestExtras): Promise<SettlementCostResponse>;
|
|
7899
8685
|
/**
|
|
7900
8686
|
* List generated settlement statements, newest first.
|
|
7901
8687
|
*
|
|
@@ -7917,6 +8703,12 @@ declare class Settlement {
|
|
|
7917
8703
|
/**
|
|
7918
8704
|
* Record payout progress on a statement (`unpaid` / `partial` / `paid`).
|
|
7919
8705
|
*
|
|
8706
|
+
* Subject to the caller's `settlement_payout` operation limit, which can
|
|
8707
|
+
* only be a per-operation ceiling: an over-limit call fails with `DE_01`
|
|
8708
|
+
* and nothing is recorded. There is no approval route out of it — four-eyes
|
|
8709
|
+
* needs an executor that can run the operation once somebody says yes, and
|
|
8710
|
+
* only refunds have one, so a settlement rule can only block.
|
|
8711
|
+
*
|
|
7920
8712
|
* `POST /settlement/statements/{statementId}/payout`
|
|
7921
8713
|
*/
|
|
7922
8714
|
updateStatementPayout(statementId: string, params: StatementPayoutUpdateRequest, options?: RequestExtras): Promise<FeeStatementDetail>;
|
|
@@ -7972,6 +8764,11 @@ declare class Settlement {
|
|
|
7972
8764
|
* Add a manual adjustment to a statement. Positive `amount_usd` charges
|
|
7973
8765
|
* the shop (reducing their payout); negative credits them.
|
|
7974
8766
|
*
|
|
8767
|
+
* Subject to the caller's `settlement_adjustment` operation limit (amount
|
|
8768
|
+
* dimensions only): an over-limit call fails with `DE_01` and no adjustment
|
|
8769
|
+
* is added. A settlement rule can only block — approval is refund-only, for
|
|
8770
|
+
* the reason given on `updateStatementPayout()`.
|
|
8771
|
+
*
|
|
7975
8772
|
* `POST /settlement/statements/{statementId}/adjustments`
|
|
7976
8773
|
*/
|
|
7977
8774
|
createStatementAdjustment(statementId: string, params: StatementAdjustmentCreateRequest, options?: RequestExtras): Promise<StatementAdjustment>;
|
|
@@ -7984,9 +8781,20 @@ declare class Settlement {
|
|
|
7984
8781
|
}
|
|
7985
8782
|
|
|
7986
8783
|
/**
|
|
7987
|
-
* Per-operation spending limits
|
|
7988
|
-
*
|
|
8784
|
+
* Per-operation spending limits: rules scoped to the merchant, a role or a
|
|
8785
|
+
* user, the merchant-level enforcement settings, and the approvals inbox.
|
|
7989
8786
|
* Enforcement resolves the most specific rule: user > role > merchant.
|
|
8787
|
+
*
|
|
8788
|
+
* A rule set to `require_approval` does not refuse an over-limit operation —
|
|
8789
|
+
* it parks it. The original call fails with HTTP 409 `DE_06` carrying
|
|
8790
|
+
* `PendingApprovalErrorDetails`, and the operation runs only once a second
|
|
8791
|
+
* person approves the request through this inbox.
|
|
8792
|
+
*
|
|
8793
|
+
* **Refunds only.** Approval needs an executor that can run the operation
|
|
8794
|
+
* after the decision, and only refunds have one; the settlement operations
|
|
8795
|
+
* take `block` alone, which the request type enforces. So every request in
|
|
8796
|
+
* this inbox is a refund, and `DE_06` never comes back from a settlement
|
|
8797
|
+
* call — an over-limit settlement adjustment or payout fails with `DE_01`.
|
|
7990
8798
|
*/
|
|
7991
8799
|
declare class OperationLimits {
|
|
7992
8800
|
private readonly request;
|
|
@@ -8023,6 +8831,69 @@ declare class OperationLimits {
|
|
|
8023
8831
|
* `PUT /operation-limits/settings`
|
|
8024
8832
|
*/
|
|
8025
8833
|
updateSettings(params: UpdateOperationLimitSettingsRequest, options?: RequestExtras): Promise<OperationLimitSettings>;
|
|
8834
|
+
/**
|
|
8835
|
+
* The approvals inbox: over-limit operations waiting on a second person.
|
|
8836
|
+
*
|
|
8837
|
+
* Both filters default rather than widen. With no `status` the list holds
|
|
8838
|
+
* **pending requests only** — approved, rejected and expired ones are
|
|
8839
|
+
* reachable only by asking for that status, so a history view must pass one
|
|
8840
|
+
* per status. With no `operation` it lists **refunds only**; the list is one
|
|
8841
|
+
* operation at a time. `limit` defaults to 100 and is clamped to 1–500.
|
|
8842
|
+
*
|
|
8843
|
+
* Requests past their `expires_at` are expired before the list is read, so
|
|
8844
|
+
* nothing here is shown as actionable when it is not.
|
|
8845
|
+
*
|
|
8846
|
+
* `GET /operation-limits/approvals`
|
|
8847
|
+
*/
|
|
8848
|
+
listApprovals(params?: PendingOperationListParams, options?: RequestExtras): Promise<PendingOperationListResponse>;
|
|
8849
|
+
/**
|
|
8850
|
+
* Approve a parked operation and execute it.
|
|
8851
|
+
*
|
|
8852
|
+
* Refused for the user who requested it, and for an approver whose own
|
|
8853
|
+
* limit would not have covered the operation — the permission is necessary
|
|
8854
|
+
* and not sufficient.
|
|
8855
|
+
*
|
|
8856
|
+
* Approval and execution are two facts. A request that was approved but
|
|
8857
|
+
* whose operation then failed comes back `approved` with `execution_error`
|
|
8858
|
+
* set and no `result_entity_id`; that is a real outcome, not a partial read.
|
|
8859
|
+
*
|
|
8860
|
+
* `POST /operation-limits/approvals/{id}/approve`
|
|
8861
|
+
*/
|
|
8862
|
+
approve(id: string, params?: DecidePendingOperationRequest, options?: RequestExtras): Promise<PendingOperation>;
|
|
8863
|
+
/**
|
|
8864
|
+
* Reject a parked operation. Nothing is executed and the request is closed.
|
|
8865
|
+
*
|
|
8866
|
+
* `POST /operation-limits/approvals/{id}/reject`
|
|
8867
|
+
*/
|
|
8868
|
+
reject(id: string, params?: DecidePendingOperationRequest, options?: RequestExtras): Promise<PendingOperation>;
|
|
8869
|
+
}
|
|
8870
|
+
|
|
8871
|
+
/**
|
|
8872
|
+
* Stored shop risk indexes, per connector.
|
|
8873
|
+
*
|
|
8874
|
+
* Both reads return snapshots and never score on demand, so `computed_at` is
|
|
8875
|
+
* the age of the answer rather than the time of the call.
|
|
8876
|
+
*
|
|
8877
|
+
* The caller's own scope is what bounds the answer, and it is enforced
|
|
8878
|
+
* server-side: a profile-scoped role, or an API key pinned to one shop, gets
|
|
8879
|
+
* that shop from both endpoints and cannot read or enumerate a sibling's.
|
|
8880
|
+
*/
|
|
8881
|
+
declare class Risk {
|
|
8882
|
+
private readonly request;
|
|
8883
|
+
constructor(request: RequestFn);
|
|
8884
|
+
/**
|
|
8885
|
+
* Every shop's stored risk for the caller's merchant, with the worst band
|
|
8886
|
+
* across them.
|
|
8887
|
+
*
|
|
8888
|
+
* `GET /risk`
|
|
8889
|
+
*/
|
|
8890
|
+
retrieve(options?: RequestExtras): Promise<MerchantRisk>;
|
|
8891
|
+
/**
|
|
8892
|
+
* One shop's stored risk index per connector.
|
|
8893
|
+
*
|
|
8894
|
+
* `GET /risk/shops/{profileId}`
|
|
8895
|
+
*/
|
|
8896
|
+
retrieveShop(profileId: string, options?: RequestExtras): Promise<ShopRisk>;
|
|
8026
8897
|
}
|
|
8027
8898
|
|
|
8028
8899
|
/**
|
|
@@ -8154,6 +9025,7 @@ declare class Delopay {
|
|
|
8154
9025
|
readonly threeDsRules: ThreeDsRules;
|
|
8155
9026
|
readonly settlement: Settlement;
|
|
8156
9027
|
readonly operationLimits: OperationLimits;
|
|
9028
|
+
readonly risk: Risk;
|
|
8157
9029
|
readonly subscriptions: Subscriptions;
|
|
8158
9030
|
readonly files: Files;
|
|
8159
9031
|
readonly export: Export;
|
|
@@ -9251,4 +10123,4 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
|
|
|
9251
10123
|
declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
|
|
9252
10124
|
type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
|
|
9253
10125
|
|
|
9254
|
-
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 CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, 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 DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, 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 GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoDrillRequest, type GeoLanguageSlice, 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 ProcessorCostSource, 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 RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingConfigUpdateRequest, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, 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 SubscriptionBillingProcessorResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionInvoiceListParams, type SubscriptionInvoiceListResponse, 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 ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, 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 WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, 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 };
|
|
10126
|
+
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, type CardSpecificFeatures, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorFeatureMatrixEntry, type ConnectorIntegrationStatus, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorRisk, 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 DecidePendingOperationRequest, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, type DelopayConnectorCategory, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, type EncodedBranding, type EntityType, 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 FeatureMatrixResponse, type FeatureStatus, 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 GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoDrillRequest, type GeoLanguageSlice, 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 MarginQuality, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRisk, 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 PendingApprovalErrorDetails, type PendingOperation, type PendingOperationLimitContext, type PendingOperationListParams, type PendingOperationListResponse, type PendingOperationStatus, type PendingOperationSummary, 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 ProcessorCostBasis, type ProcessorCostBucket, type ProcessorCostSource, 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, Risk, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingAlgorithmKind, type RoutingConfigCreateRequest, type RoutingConfigHistoryResponse, type RoutingConfigResponse, type RoutingConfigUpdateRequest, type RoutingConfigVersion, type RoutingConnectorCap, type RoutingConnectorCaps, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RoutingHistoryParams, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCostParams, type SettlementCostPeriod, type SettlementCostResponse, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopRisk, 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 SubscriptionBillingProcessorResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionInvoiceListParams, type SubscriptionInvoiceListResponse, 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 SupportedPaymentMethod, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UpsertRefundLimitRuleRequest, type UpsertSettlementAdjustmentLimitRuleRequest, type UpsertSettlementPayoutLimitRuleRequest, 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 WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, 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 };
|