stripe 14.5.0 → 14.6.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/CHANGELOG.md +12 -0
- package/VERSION +1 -1
- package/cjs/stripe.core.js +1 -1
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/Charges.d.ts +39 -0
- package/types/CustomerCashBalanceTransactions.d.ts +9 -0
- package/types/Events.d.ts +2 -2
- package/types/Issuing/Authorizations.d.ts +30 -5
- package/types/Issuing/Transactions.d.ts +10 -0
- package/types/PaymentIntentsResource.d.ts +306 -0
- package/types/PricesResource.d.ts +1 -1
- package/types/Refunds.d.ts +1 -1
- package/types/SetupAttempts.d.ts +14 -0
- package/types/SetupIntentsResource.d.ts +285 -0
- package/types/Treasury/OutboundPaymentsResource.d.ts +1 -1
- package/types/Treasury/OutboundTransfersResource.d.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 14.6.0 - 2023-11-21
|
|
4
|
+
* [#1961](https://github.com/stripe/stripe-node/pull/1961) Update generated code
|
|
5
|
+
* Add support for `electronic_commerce_indicator` on `Charge.payment_method_details.card.three_d_secure` and `SetupAttempt.payment_method_details.card.three_d_secure`
|
|
6
|
+
* Add support for `exemption_indicator_applied` and `exemption_indicator` on `Charge.payment_method_details.card.three_d_secure`
|
|
7
|
+
* Add support for `transaction_id` on `Charge.payment_method_details.card.three_d_secure`, `Issuing.Authorization.network_data`, `Issuing.Transaction.network_data`, and `SetupAttempt.payment_method_details.card.three_d_secure`
|
|
8
|
+
* Add support for `offline` on `Charge.payment_method_details.card_present`
|
|
9
|
+
* Add support for `system_trace_audit_number` on `Issuing.Authorization.network_data`
|
|
10
|
+
* Add support for `network_risk_score` on `Issuing.Authorization.pending_request` and `Issuing.Authorization.request_history[]`
|
|
11
|
+
* Add support for `requested_at` on `Issuing.Authorization.request_history[]`
|
|
12
|
+
* Add support for `authorization_code` on `Issuing.Transaction.network_data`
|
|
13
|
+
* Add support for `three_d_secure` on `PaymentIntentConfirmParams.payment_method_options.card`, `PaymentIntentCreateParams.payment_method_options.card`, `PaymentIntentUpdateParams.payment_method_options.card`, `SetupIntentConfirmParams.payment_method_options.card`, `SetupIntentCreateParams.payment_method_options.card`, and `SetupIntentUpdateParams.payment_method_options.card`
|
|
14
|
+
|
|
3
15
|
## 14.5.0 - 2023-11-16
|
|
4
16
|
* [#1957](https://github.com/stripe/stripe-node/pull/1957) Update generated code
|
|
5
17
|
* Add support for `bacs_debit_payments` on `AccountCreateParams.settings` and `AccountUpdateParams.settings`
|
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
14.
|
|
1
|
+
14.6.0
|
package/cjs/stripe.core.js
CHANGED
|
@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
|
|
|
34
34
|
];
|
|
35
35
|
const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
|
|
36
36
|
function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
|
|
37
|
-
Stripe.PACKAGE_VERSION = '14.
|
|
37
|
+
Stripe.PACKAGE_VERSION = '14.6.0';
|
|
38
38
|
Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
|
|
39
39
|
Stripe.StripeResource = StripeResource_js_1.StripeResource;
|
|
40
40
|
Stripe.resources = resources;
|
package/esm/stripe.core.js
CHANGED
|
@@ -31,7 +31,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
|
|
|
31
31
|
];
|
|
32
32
|
const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
|
|
33
33
|
export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
|
|
34
|
-
Stripe.PACKAGE_VERSION = '14.
|
|
34
|
+
Stripe.PACKAGE_VERSION = '14.6.0';
|
|
35
35
|
Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
|
|
36
36
|
Stripe.StripeResource = StripeResource;
|
|
37
37
|
Stripe.resources = resources;
|
package/package.json
CHANGED
package/types/Charges.d.ts
CHANGED
|
@@ -899,6 +899,23 @@ declare module 'stripe' {
|
|
|
899
899
|
*/
|
|
900
900
|
authentication_flow: ThreeDSecure.AuthenticationFlow | null;
|
|
901
901
|
|
|
902
|
+
/**
|
|
903
|
+
* The Electronic Commerce Indicator (ECI). A protocol-level field
|
|
904
|
+
* indicating what degree of authentication was performed.
|
|
905
|
+
*/
|
|
906
|
+
electronic_commerce_indicator: ThreeDSecure.ElectronicCommerceIndicator | null;
|
|
907
|
+
|
|
908
|
+
/**
|
|
909
|
+
* The exemption requested via 3DS and accepted by the issuer at authentication time.
|
|
910
|
+
*/
|
|
911
|
+
exemption_indicator: ThreeDSecure.ExemptionIndicator | null;
|
|
912
|
+
|
|
913
|
+
/**
|
|
914
|
+
* Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
|
|
915
|
+
* the outcome of Stripe's internal risk assessment.
|
|
916
|
+
*/
|
|
917
|
+
exemption_indicator_applied?: boolean;
|
|
918
|
+
|
|
902
919
|
/**
|
|
903
920
|
* Indicates the outcome of 3D Secure authentication.
|
|
904
921
|
*/
|
|
@@ -910,6 +927,12 @@ declare module 'stripe' {
|
|
|
910
927
|
*/
|
|
911
928
|
result_reason: ThreeDSecure.ResultReason | null;
|
|
912
929
|
|
|
930
|
+
/**
|
|
931
|
+
* The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
|
|
932
|
+
* (dsTransId) for this payment.
|
|
933
|
+
*/
|
|
934
|
+
transaction_id: string | null;
|
|
935
|
+
|
|
913
936
|
/**
|
|
914
937
|
* The version of 3D Secure that was used.
|
|
915
938
|
*/
|
|
@@ -919,6 +942,10 @@ declare module 'stripe' {
|
|
|
919
942
|
namespace ThreeDSecure {
|
|
920
943
|
type AuthenticationFlow = 'challenge' | 'frictionless';
|
|
921
944
|
|
|
945
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
946
|
+
|
|
947
|
+
type ExemptionIndicator = 'low_risk' | 'none';
|
|
948
|
+
|
|
922
949
|
type Result =
|
|
923
950
|
| 'attempt_acknowledged'
|
|
924
951
|
| 'authenticated'
|
|
@@ -1119,6 +1146,11 @@ declare module 'stripe' {
|
|
|
1119
1146
|
*/
|
|
1120
1147
|
network: string | null;
|
|
1121
1148
|
|
|
1149
|
+
/**
|
|
1150
|
+
* Details about payments collected offline.
|
|
1151
|
+
*/
|
|
1152
|
+
offline: CardPresent.Offline | null;
|
|
1153
|
+
|
|
1122
1154
|
/**
|
|
1123
1155
|
* Defines whether the authorized amount can be over-captured or not
|
|
1124
1156
|
*/
|
|
@@ -1136,6 +1168,13 @@ declare module 'stripe' {
|
|
|
1136
1168
|
}
|
|
1137
1169
|
|
|
1138
1170
|
namespace CardPresent {
|
|
1171
|
+
interface Offline {
|
|
1172
|
+
/**
|
|
1173
|
+
* Time at which the payment was collected while offline
|
|
1174
|
+
*/
|
|
1175
|
+
stored_at: number | null;
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1139
1178
|
type ReadMethod =
|
|
1140
1179
|
| 'contact_emv'
|
|
1141
1180
|
| 'contactless_emv'
|
|
@@ -57,6 +57,8 @@ declare module 'stripe' {
|
|
|
57
57
|
|
|
58
58
|
refunded_from_payment?: CustomerCashBalanceTransaction.RefundedFromPayment;
|
|
59
59
|
|
|
60
|
+
transferred_to_balance?: CustomerCashBalanceTransaction.TransferredToBalance;
|
|
61
|
+
|
|
60
62
|
/**
|
|
61
63
|
* The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.
|
|
62
64
|
*/
|
|
@@ -194,6 +196,13 @@ declare module 'stripe' {
|
|
|
194
196
|
refund: string | Stripe.Refund;
|
|
195
197
|
}
|
|
196
198
|
|
|
199
|
+
interface TransferredToBalance {
|
|
200
|
+
/**
|
|
201
|
+
* The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
|
|
202
|
+
*/
|
|
203
|
+
balance_transaction: string | Stripe.BalanceTransaction;
|
|
204
|
+
}
|
|
205
|
+
|
|
197
206
|
type Type =
|
|
198
207
|
| 'adjusted_for_overdraft'
|
|
199
208
|
| 'applied_to_payment'
|
package/types/Events.d.ts
CHANGED
|
@@ -283,8 +283,8 @@ declare module 'stripe' {
|
|
|
283
283
|
* `Event` objects directly to an endpoint on your server. You can manage
|
|
284
284
|
* webhooks in your
|
|
285
285
|
* [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
|
|
286
|
-
* to [listen for events]
|
|
287
|
-
*
|
|
286
|
+
* to [listen for events](https://stripe.com/docs/webhooks)
|
|
287
|
+
* so that your integration can automatically trigger reactions.
|
|
288
288
|
*
|
|
289
289
|
* When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications
|
|
290
290
|
* that occur in connected accounts. For these events, there's an
|
|
@@ -22,7 +22,7 @@ declare module 'stripe' {
|
|
|
22
22
|
object: 'issuing.authorization';
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* The total amount that was authorized or rejected. This amount is in
|
|
25
|
+
* The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.
|
|
26
26
|
*/
|
|
27
27
|
amount: number;
|
|
28
28
|
|
|
@@ -62,7 +62,7 @@ declare module 'stripe' {
|
|
|
62
62
|
created: number;
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
|
-
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
65
|
+
* The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
66
66
|
*/
|
|
67
67
|
currency: string;
|
|
68
68
|
|
|
@@ -72,12 +72,12 @@ declare module 'stripe' {
|
|
|
72
72
|
livemode: boolean;
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
|
-
* The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
|
75
|
+
* The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.
|
|
76
76
|
*/
|
|
77
77
|
merchant_amount: number;
|
|
78
78
|
|
|
79
79
|
/**
|
|
80
|
-
* The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
80
|
+
* The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
81
81
|
*/
|
|
82
82
|
merchant_currency: string;
|
|
83
83
|
|
|
@@ -208,6 +208,16 @@ declare module 'stripe' {
|
|
|
208
208
|
* Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.
|
|
209
209
|
*/
|
|
210
210
|
acquiring_institution_id: string | null;
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.
|
|
214
|
+
*/
|
|
215
|
+
system_trace_audit_number: string | null;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
|
|
219
|
+
*/
|
|
220
|
+
transaction_id: string | null;
|
|
211
221
|
}
|
|
212
222
|
|
|
213
223
|
interface PendingRequest {
|
|
@@ -240,6 +250,11 @@ declare module 'stripe' {
|
|
|
240
250
|
* The local currency the merchant is requesting to authorize.
|
|
241
251
|
*/
|
|
242
252
|
merchant_currency: string;
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
|
|
256
|
+
*/
|
|
257
|
+
network_risk_score: number | null;
|
|
243
258
|
}
|
|
244
259
|
|
|
245
260
|
namespace PendingRequest {
|
|
@@ -297,15 +312,25 @@ declare module 'stripe' {
|
|
|
297
312
|
*/
|
|
298
313
|
merchant_currency: string;
|
|
299
314
|
|
|
315
|
+
/**
|
|
316
|
+
* The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
|
|
317
|
+
*/
|
|
318
|
+
network_risk_score: number | null;
|
|
319
|
+
|
|
300
320
|
/**
|
|
301
321
|
* When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
|
|
302
322
|
*/
|
|
303
323
|
reason: RequestHistory.Reason;
|
|
304
324
|
|
|
305
325
|
/**
|
|
306
|
-
* If
|
|
326
|
+
* If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.
|
|
307
327
|
*/
|
|
308
328
|
reason_message: string | null;
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.
|
|
332
|
+
*/
|
|
333
|
+
requested_at: number | null;
|
|
309
334
|
}
|
|
310
335
|
|
|
311
336
|
namespace RequestHistory {
|
|
@@ -185,10 +185,20 @@ declare module 'stripe' {
|
|
|
185
185
|
}
|
|
186
186
|
|
|
187
187
|
interface NetworkData {
|
|
188
|
+
/**
|
|
189
|
+
* A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
|
|
190
|
+
*/
|
|
191
|
+
authorization_code: string | null;
|
|
192
|
+
|
|
188
193
|
/**
|
|
189
194
|
* The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
|
|
190
195
|
*/
|
|
191
196
|
processing_date: string | null;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
|
|
200
|
+
*/
|
|
201
|
+
transaction_id: string | null;
|
|
192
202
|
}
|
|
193
203
|
|
|
194
204
|
interface PurchaseDetails {
|
|
@@ -1274,6 +1274,12 @@ declare module 'stripe' {
|
|
|
1274
1274
|
* Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
|
1275
1275
|
*/
|
|
1276
1276
|
statement_descriptor_suffix_kanji?: Stripe.Emptyable<string>;
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* If 3D Secure authentication was performed with a third-party provider,
|
|
1280
|
+
* the authentication details to use for this payment.
|
|
1281
|
+
*/
|
|
1282
|
+
three_d_secure?: Card.ThreeDSecure;
|
|
1277
1283
|
}
|
|
1278
1284
|
|
|
1279
1285
|
namespace Card {
|
|
@@ -1389,6 +1395,102 @@ declare module 'stripe' {
|
|
|
1389
1395
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
1390
1396
|
|
|
1391
1397
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1398
|
+
|
|
1399
|
+
interface ThreeDSecure {
|
|
1400
|
+
/**
|
|
1401
|
+
* The `transStatus` returned from the card Issuer's ACS in the ARes.
|
|
1402
|
+
*/
|
|
1403
|
+
ares_trans_status?: ThreeDSecure.AresTransStatus;
|
|
1404
|
+
|
|
1405
|
+
/**
|
|
1406
|
+
* The cryptogram, also known as the "authentication value" (AAV, CAVV or
|
|
1407
|
+
* AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
|
|
1408
|
+
* (Most 3D Secure providers will return the base64-encoded version, which
|
|
1409
|
+
* is what you should specify here.)
|
|
1410
|
+
*/
|
|
1411
|
+
cryptogram: string;
|
|
1412
|
+
|
|
1413
|
+
/**
|
|
1414
|
+
* The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
|
|
1415
|
+
* provider and indicates what degree of authentication was performed.
|
|
1416
|
+
*/
|
|
1417
|
+
electronic_commerce_indicator?: ThreeDSecure.ElectronicCommerceIndicator;
|
|
1418
|
+
|
|
1419
|
+
/**
|
|
1420
|
+
* The exemption requested via 3DS and accepted by the issuer at authentication time.
|
|
1421
|
+
*/
|
|
1422
|
+
exemption_indicator?: ThreeDSecure.ExemptionIndicator;
|
|
1423
|
+
|
|
1424
|
+
/**
|
|
1425
|
+
* Network specific 3DS fields. Network specific arguments require an
|
|
1426
|
+
* explicit card brand choice. The parameter `payment_method_options.card.network``
|
|
1427
|
+
* must be populated accordingly
|
|
1428
|
+
*/
|
|
1429
|
+
network_options?: ThreeDSecure.NetworkOptions;
|
|
1430
|
+
|
|
1431
|
+
/**
|
|
1432
|
+
* The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
|
|
1433
|
+
* AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
|
|
1434
|
+
*/
|
|
1435
|
+
requestor_challenge_indicator?: string;
|
|
1436
|
+
|
|
1437
|
+
/**
|
|
1438
|
+
* For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
|
|
1439
|
+
* Transaction ID (dsTransID).
|
|
1440
|
+
*/
|
|
1441
|
+
transaction_id: string;
|
|
1442
|
+
|
|
1443
|
+
/**
|
|
1444
|
+
* The version of 3D Secure that was performed.
|
|
1445
|
+
*/
|
|
1446
|
+
version: ThreeDSecure.Version;
|
|
1447
|
+
}
|
|
1448
|
+
|
|
1449
|
+
namespace ThreeDSecure {
|
|
1450
|
+
type AresTransStatus = 'A' | 'C' | 'I' | 'N' | 'R' | 'U' | 'Y';
|
|
1451
|
+
|
|
1452
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
1453
|
+
|
|
1454
|
+
type ExemptionIndicator = 'low_risk' | 'none';
|
|
1455
|
+
|
|
1456
|
+
interface NetworkOptions {
|
|
1457
|
+
/**
|
|
1458
|
+
* Cartes Bancaires-specific 3DS fields.
|
|
1459
|
+
*/
|
|
1460
|
+
cartes_bancaires?: NetworkOptions.CartesBancaires;
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
namespace NetworkOptions {
|
|
1464
|
+
interface CartesBancaires {
|
|
1465
|
+
/**
|
|
1466
|
+
* The cryptogram calculation algorithm used by the card Issuer's ACS
|
|
1467
|
+
* to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
|
|
1468
|
+
* messageExtension: CB-AVALGO
|
|
1469
|
+
*/
|
|
1470
|
+
cb_avalgo: CartesBancaires.CbAvalgo;
|
|
1471
|
+
|
|
1472
|
+
/**
|
|
1473
|
+
* The exemption indicator returned from Cartes Bancaires in the ARes.
|
|
1474
|
+
* message extension: CB-EXEMPTION; string (4 characters)
|
|
1475
|
+
* This is a 3 byte bitmap (low significant byte first and most significant
|
|
1476
|
+
* bit first) that has been Base64 encoded
|
|
1477
|
+
*/
|
|
1478
|
+
cb_exemption?: string;
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
* The risk score returned from Cartes Bancaires in the ARes.
|
|
1482
|
+
* message extension: CB-SCORE; numeric value 0-99
|
|
1483
|
+
*/
|
|
1484
|
+
cb_score?: number;
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
namespace CartesBancaires {
|
|
1488
|
+
type CbAvalgo = '0' | '1' | '2' | '3' | '4' | 'A';
|
|
1489
|
+
}
|
|
1490
|
+
}
|
|
1491
|
+
|
|
1492
|
+
type Version = '1.0.2' | '2.1.0' | '2.2.0';
|
|
1493
|
+
}
|
|
1392
1494
|
}
|
|
1393
1495
|
|
|
1394
1496
|
interface CardPresent {
|
|
@@ -3272,6 +3374,12 @@ declare module 'stripe' {
|
|
|
3272
3374
|
* Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
|
3273
3375
|
*/
|
|
3274
3376
|
statement_descriptor_suffix_kanji?: Stripe.Emptyable<string>;
|
|
3377
|
+
|
|
3378
|
+
/**
|
|
3379
|
+
* If 3D Secure authentication was performed with a third-party provider,
|
|
3380
|
+
* the authentication details to use for this payment.
|
|
3381
|
+
*/
|
|
3382
|
+
three_d_secure?: Card.ThreeDSecure;
|
|
3275
3383
|
}
|
|
3276
3384
|
|
|
3277
3385
|
namespace Card {
|
|
@@ -3387,6 +3495,102 @@ declare module 'stripe' {
|
|
|
3387
3495
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
3388
3496
|
|
|
3389
3497
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
3498
|
+
|
|
3499
|
+
interface ThreeDSecure {
|
|
3500
|
+
/**
|
|
3501
|
+
* The `transStatus` returned from the card Issuer's ACS in the ARes.
|
|
3502
|
+
*/
|
|
3503
|
+
ares_trans_status?: ThreeDSecure.AresTransStatus;
|
|
3504
|
+
|
|
3505
|
+
/**
|
|
3506
|
+
* The cryptogram, also known as the "authentication value" (AAV, CAVV or
|
|
3507
|
+
* AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
|
|
3508
|
+
* (Most 3D Secure providers will return the base64-encoded version, which
|
|
3509
|
+
* is what you should specify here.)
|
|
3510
|
+
*/
|
|
3511
|
+
cryptogram: string;
|
|
3512
|
+
|
|
3513
|
+
/**
|
|
3514
|
+
* The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
|
|
3515
|
+
* provider and indicates what degree of authentication was performed.
|
|
3516
|
+
*/
|
|
3517
|
+
electronic_commerce_indicator?: ThreeDSecure.ElectronicCommerceIndicator;
|
|
3518
|
+
|
|
3519
|
+
/**
|
|
3520
|
+
* The exemption requested via 3DS and accepted by the issuer at authentication time.
|
|
3521
|
+
*/
|
|
3522
|
+
exemption_indicator?: ThreeDSecure.ExemptionIndicator;
|
|
3523
|
+
|
|
3524
|
+
/**
|
|
3525
|
+
* Network specific 3DS fields. Network specific arguments require an
|
|
3526
|
+
* explicit card brand choice. The parameter `payment_method_options.card.network``
|
|
3527
|
+
* must be populated accordingly
|
|
3528
|
+
*/
|
|
3529
|
+
network_options?: ThreeDSecure.NetworkOptions;
|
|
3530
|
+
|
|
3531
|
+
/**
|
|
3532
|
+
* The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
|
|
3533
|
+
* AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
|
|
3534
|
+
*/
|
|
3535
|
+
requestor_challenge_indicator?: string;
|
|
3536
|
+
|
|
3537
|
+
/**
|
|
3538
|
+
* For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
|
|
3539
|
+
* Transaction ID (dsTransID).
|
|
3540
|
+
*/
|
|
3541
|
+
transaction_id: string;
|
|
3542
|
+
|
|
3543
|
+
/**
|
|
3544
|
+
* The version of 3D Secure that was performed.
|
|
3545
|
+
*/
|
|
3546
|
+
version: ThreeDSecure.Version;
|
|
3547
|
+
}
|
|
3548
|
+
|
|
3549
|
+
namespace ThreeDSecure {
|
|
3550
|
+
type AresTransStatus = 'A' | 'C' | 'I' | 'N' | 'R' | 'U' | 'Y';
|
|
3551
|
+
|
|
3552
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
3553
|
+
|
|
3554
|
+
type ExemptionIndicator = 'low_risk' | 'none';
|
|
3555
|
+
|
|
3556
|
+
interface NetworkOptions {
|
|
3557
|
+
/**
|
|
3558
|
+
* Cartes Bancaires-specific 3DS fields.
|
|
3559
|
+
*/
|
|
3560
|
+
cartes_bancaires?: NetworkOptions.CartesBancaires;
|
|
3561
|
+
}
|
|
3562
|
+
|
|
3563
|
+
namespace NetworkOptions {
|
|
3564
|
+
interface CartesBancaires {
|
|
3565
|
+
/**
|
|
3566
|
+
* The cryptogram calculation algorithm used by the card Issuer's ACS
|
|
3567
|
+
* to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
|
|
3568
|
+
* messageExtension: CB-AVALGO
|
|
3569
|
+
*/
|
|
3570
|
+
cb_avalgo: CartesBancaires.CbAvalgo;
|
|
3571
|
+
|
|
3572
|
+
/**
|
|
3573
|
+
* The exemption indicator returned from Cartes Bancaires in the ARes.
|
|
3574
|
+
* message extension: CB-EXEMPTION; string (4 characters)
|
|
3575
|
+
* This is a 3 byte bitmap (low significant byte first and most significant
|
|
3576
|
+
* bit first) that has been Base64 encoded
|
|
3577
|
+
*/
|
|
3578
|
+
cb_exemption?: string;
|
|
3579
|
+
|
|
3580
|
+
/**
|
|
3581
|
+
* The risk score returned from Cartes Bancaires in the ARes.
|
|
3582
|
+
* message extension: CB-SCORE; numeric value 0-99
|
|
3583
|
+
*/
|
|
3584
|
+
cb_score?: number;
|
|
3585
|
+
}
|
|
3586
|
+
|
|
3587
|
+
namespace CartesBancaires {
|
|
3588
|
+
type CbAvalgo = '0' | '1' | '2' | '3' | '4' | 'A';
|
|
3589
|
+
}
|
|
3590
|
+
}
|
|
3591
|
+
|
|
3592
|
+
type Version = '1.0.2' | '2.1.0' | '2.2.0';
|
|
3593
|
+
}
|
|
3390
3594
|
}
|
|
3391
3595
|
|
|
3392
3596
|
interface CardPresent {
|
|
@@ -5408,6 +5612,12 @@ declare module 'stripe' {
|
|
|
5408
5612
|
* Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
|
5409
5613
|
*/
|
|
5410
5614
|
statement_descriptor_suffix_kanji?: Stripe.Emptyable<string>;
|
|
5615
|
+
|
|
5616
|
+
/**
|
|
5617
|
+
* If 3D Secure authentication was performed with a third-party provider,
|
|
5618
|
+
* the authentication details to use for this payment.
|
|
5619
|
+
*/
|
|
5620
|
+
three_d_secure?: Card.ThreeDSecure;
|
|
5411
5621
|
}
|
|
5412
5622
|
|
|
5413
5623
|
namespace Card {
|
|
@@ -5523,6 +5733,102 @@ declare module 'stripe' {
|
|
|
5523
5733
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
5524
5734
|
|
|
5525
5735
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
5736
|
+
|
|
5737
|
+
interface ThreeDSecure {
|
|
5738
|
+
/**
|
|
5739
|
+
* The `transStatus` returned from the card Issuer's ACS in the ARes.
|
|
5740
|
+
*/
|
|
5741
|
+
ares_trans_status?: ThreeDSecure.AresTransStatus;
|
|
5742
|
+
|
|
5743
|
+
/**
|
|
5744
|
+
* The cryptogram, also known as the "authentication value" (AAV, CAVV or
|
|
5745
|
+
* AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
|
|
5746
|
+
* (Most 3D Secure providers will return the base64-encoded version, which
|
|
5747
|
+
* is what you should specify here.)
|
|
5748
|
+
*/
|
|
5749
|
+
cryptogram: string;
|
|
5750
|
+
|
|
5751
|
+
/**
|
|
5752
|
+
* The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
|
|
5753
|
+
* provider and indicates what degree of authentication was performed.
|
|
5754
|
+
*/
|
|
5755
|
+
electronic_commerce_indicator?: ThreeDSecure.ElectronicCommerceIndicator;
|
|
5756
|
+
|
|
5757
|
+
/**
|
|
5758
|
+
* The exemption requested via 3DS and accepted by the issuer at authentication time.
|
|
5759
|
+
*/
|
|
5760
|
+
exemption_indicator?: ThreeDSecure.ExemptionIndicator;
|
|
5761
|
+
|
|
5762
|
+
/**
|
|
5763
|
+
* Network specific 3DS fields. Network specific arguments require an
|
|
5764
|
+
* explicit card brand choice. The parameter `payment_method_options.card.network``
|
|
5765
|
+
* must be populated accordingly
|
|
5766
|
+
*/
|
|
5767
|
+
network_options?: ThreeDSecure.NetworkOptions;
|
|
5768
|
+
|
|
5769
|
+
/**
|
|
5770
|
+
* The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
|
|
5771
|
+
* AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
|
|
5772
|
+
*/
|
|
5773
|
+
requestor_challenge_indicator?: string;
|
|
5774
|
+
|
|
5775
|
+
/**
|
|
5776
|
+
* For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
|
|
5777
|
+
* Transaction ID (dsTransID).
|
|
5778
|
+
*/
|
|
5779
|
+
transaction_id: string;
|
|
5780
|
+
|
|
5781
|
+
/**
|
|
5782
|
+
* The version of 3D Secure that was performed.
|
|
5783
|
+
*/
|
|
5784
|
+
version: ThreeDSecure.Version;
|
|
5785
|
+
}
|
|
5786
|
+
|
|
5787
|
+
namespace ThreeDSecure {
|
|
5788
|
+
type AresTransStatus = 'A' | 'C' | 'I' | 'N' | 'R' | 'U' | 'Y';
|
|
5789
|
+
|
|
5790
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
5791
|
+
|
|
5792
|
+
type ExemptionIndicator = 'low_risk' | 'none';
|
|
5793
|
+
|
|
5794
|
+
interface NetworkOptions {
|
|
5795
|
+
/**
|
|
5796
|
+
* Cartes Bancaires-specific 3DS fields.
|
|
5797
|
+
*/
|
|
5798
|
+
cartes_bancaires?: NetworkOptions.CartesBancaires;
|
|
5799
|
+
}
|
|
5800
|
+
|
|
5801
|
+
namespace NetworkOptions {
|
|
5802
|
+
interface CartesBancaires {
|
|
5803
|
+
/**
|
|
5804
|
+
* The cryptogram calculation algorithm used by the card Issuer's ACS
|
|
5805
|
+
* to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
|
|
5806
|
+
* messageExtension: CB-AVALGO
|
|
5807
|
+
*/
|
|
5808
|
+
cb_avalgo: CartesBancaires.CbAvalgo;
|
|
5809
|
+
|
|
5810
|
+
/**
|
|
5811
|
+
* The exemption indicator returned from Cartes Bancaires in the ARes.
|
|
5812
|
+
* message extension: CB-EXEMPTION; string (4 characters)
|
|
5813
|
+
* This is a 3 byte bitmap (low significant byte first and most significant
|
|
5814
|
+
* bit first) that has been Base64 encoded
|
|
5815
|
+
*/
|
|
5816
|
+
cb_exemption?: string;
|
|
5817
|
+
|
|
5818
|
+
/**
|
|
5819
|
+
* The risk score returned from Cartes Bancaires in the ARes.
|
|
5820
|
+
* message extension: CB-SCORE; numeric value 0-99
|
|
5821
|
+
*/
|
|
5822
|
+
cb_score?: number;
|
|
5823
|
+
}
|
|
5824
|
+
|
|
5825
|
+
namespace CartesBancaires {
|
|
5826
|
+
type CbAvalgo = '0' | '1' | '2' | '3' | '4' | 'A';
|
|
5827
|
+
}
|
|
5828
|
+
}
|
|
5829
|
+
|
|
5830
|
+
type Version = '1.0.2' | '2.1.0' | '2.2.0';
|
|
5831
|
+
}
|
|
5526
5832
|
}
|
|
5527
5833
|
|
|
5528
5834
|
interface CardPresent {
|
|
@@ -585,7 +585,7 @@ declare module 'stripe' {
|
|
|
585
585
|
): Promise<Stripe.Response<Stripe.Price>>;
|
|
586
586
|
|
|
587
587
|
/**
|
|
588
|
-
* Returns a list of your active prices. For the list of inactive prices, set active to false.
|
|
588
|
+
* Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
|
|
589
589
|
*/
|
|
590
590
|
list(
|
|
591
591
|
params?: PriceListParams,
|
package/types/Refunds.d.ts
CHANGED
|
@@ -93,7 +93,7 @@ declare module 'stripe' {
|
|
|
93
93
|
source_transfer_reversal: string | Stripe.TransferReversal | null;
|
|
94
94
|
|
|
95
95
|
/**
|
|
96
|
-
* Status of the refund.
|
|
96
|
+
* Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).
|
|
97
97
|
*/
|
|
98
98
|
status: string | null;
|
|
99
99
|
|
package/types/SetupAttempts.d.ts
CHANGED
|
@@ -282,6 +282,12 @@ declare module 'stripe' {
|
|
|
282
282
|
*/
|
|
283
283
|
authentication_flow: ThreeDSecure.AuthenticationFlow | null;
|
|
284
284
|
|
|
285
|
+
/**
|
|
286
|
+
* The Electronic Commerce Indicator (ECI). A protocol-level field
|
|
287
|
+
* indicating what degree of authentication was performed.
|
|
288
|
+
*/
|
|
289
|
+
electronic_commerce_indicator: ThreeDSecure.ElectronicCommerceIndicator | null;
|
|
290
|
+
|
|
285
291
|
/**
|
|
286
292
|
* Indicates the outcome of 3D Secure authentication.
|
|
287
293
|
*/
|
|
@@ -293,6 +299,12 @@ declare module 'stripe' {
|
|
|
293
299
|
*/
|
|
294
300
|
result_reason: ThreeDSecure.ResultReason | null;
|
|
295
301
|
|
|
302
|
+
/**
|
|
303
|
+
* The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
|
|
304
|
+
* (dsTransId) for this payment.
|
|
305
|
+
*/
|
|
306
|
+
transaction_id: string | null;
|
|
307
|
+
|
|
296
308
|
/**
|
|
297
309
|
* The version of 3D Secure that was used.
|
|
298
310
|
*/
|
|
@@ -302,6 +314,8 @@ declare module 'stripe' {
|
|
|
302
314
|
namespace ThreeDSecure {
|
|
303
315
|
type AuthenticationFlow = 'challenge' | 'frictionless';
|
|
304
316
|
|
|
317
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
318
|
+
|
|
305
319
|
type Result =
|
|
306
320
|
| 'attempt_acknowledged'
|
|
307
321
|
| 'authenticated'
|
|
@@ -843,6 +843,12 @@ declare module 'stripe' {
|
|
|
843
843
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
844
844
|
*/
|
|
845
845
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
846
|
+
|
|
847
|
+
/**
|
|
848
|
+
* If 3D Secure authentication was performed with a third-party provider,
|
|
849
|
+
* the authentication details to use for this setup.
|
|
850
|
+
*/
|
|
851
|
+
three_d_secure?: Card.ThreeDSecure;
|
|
846
852
|
}
|
|
847
853
|
|
|
848
854
|
namespace Card {
|
|
@@ -918,6 +924,95 @@ declare module 'stripe' {
|
|
|
918
924
|
| 'visa';
|
|
919
925
|
|
|
920
926
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
927
|
+
|
|
928
|
+
interface ThreeDSecure {
|
|
929
|
+
/**
|
|
930
|
+
* The `transStatus` returned from the card Issuer's ACS in the ARes.
|
|
931
|
+
*/
|
|
932
|
+
ares_trans_status?: ThreeDSecure.AresTransStatus;
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* The cryptogram, also known as the "authentication value" (AAV, CAVV or
|
|
936
|
+
* AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
|
|
937
|
+
* (Most 3D Secure providers will return the base64-encoded version, which
|
|
938
|
+
* is what you should specify here.)
|
|
939
|
+
*/
|
|
940
|
+
cryptogram?: string;
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
|
|
944
|
+
* provider and indicates what degree of authentication was performed.
|
|
945
|
+
*/
|
|
946
|
+
electronic_commerce_indicator?: ThreeDSecure.ElectronicCommerceIndicator;
|
|
947
|
+
|
|
948
|
+
/**
|
|
949
|
+
* Network specific 3DS fields. Network specific arguments require an
|
|
950
|
+
* explicit card brand choice. The parameter `payment_method_options.card.network``
|
|
951
|
+
* must be populated accordingly
|
|
952
|
+
*/
|
|
953
|
+
network_options?: ThreeDSecure.NetworkOptions;
|
|
954
|
+
|
|
955
|
+
/**
|
|
956
|
+
* The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
|
|
957
|
+
* AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
|
|
958
|
+
*/
|
|
959
|
+
requestor_challenge_indicator?: string;
|
|
960
|
+
|
|
961
|
+
/**
|
|
962
|
+
* For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
|
|
963
|
+
* Transaction ID (dsTransID).
|
|
964
|
+
*/
|
|
965
|
+
transaction_id?: string;
|
|
966
|
+
|
|
967
|
+
/**
|
|
968
|
+
* The version of 3D Secure that was performed.
|
|
969
|
+
*/
|
|
970
|
+
version?: ThreeDSecure.Version;
|
|
971
|
+
}
|
|
972
|
+
|
|
973
|
+
namespace ThreeDSecure {
|
|
974
|
+
type AresTransStatus = 'A' | 'C' | 'I' | 'N' | 'R' | 'U' | 'Y';
|
|
975
|
+
|
|
976
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
977
|
+
|
|
978
|
+
interface NetworkOptions {
|
|
979
|
+
/**
|
|
980
|
+
* Cartes Bancaires-specific 3DS fields.
|
|
981
|
+
*/
|
|
982
|
+
cartes_bancaires?: NetworkOptions.CartesBancaires;
|
|
983
|
+
}
|
|
984
|
+
|
|
985
|
+
namespace NetworkOptions {
|
|
986
|
+
interface CartesBancaires {
|
|
987
|
+
/**
|
|
988
|
+
* The cryptogram calculation algorithm used by the card Issuer's ACS
|
|
989
|
+
* to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
|
|
990
|
+
* messageExtension: CB-AVALGO
|
|
991
|
+
*/
|
|
992
|
+
cb_avalgo: CartesBancaires.CbAvalgo;
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* The exemption indicator returned from Cartes Bancaires in the ARes.
|
|
996
|
+
* message extension: CB-EXEMPTION; string (4 characters)
|
|
997
|
+
* This is a 3 byte bitmap (low significant byte first and most significant
|
|
998
|
+
* bit first) that has been Base64 encoded
|
|
999
|
+
*/
|
|
1000
|
+
cb_exemption?: string;
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* The risk score returned from Cartes Bancaires in the ARes.
|
|
1004
|
+
* message extension: CB-SCORE; numeric value 0-99
|
|
1005
|
+
*/
|
|
1006
|
+
cb_score?: number;
|
|
1007
|
+
}
|
|
1008
|
+
|
|
1009
|
+
namespace CartesBancaires {
|
|
1010
|
+
type CbAvalgo = '0' | '1' | '2' | '3' | '4' | 'A';
|
|
1011
|
+
}
|
|
1012
|
+
}
|
|
1013
|
+
|
|
1014
|
+
type Version = '1.0.2' | '2.1.0' | '2.2.0';
|
|
1015
|
+
}
|
|
921
1016
|
}
|
|
922
1017
|
|
|
923
1018
|
interface Link {
|
|
@@ -1764,6 +1859,12 @@ declare module 'stripe' {
|
|
|
1764
1859
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
1765
1860
|
*/
|
|
1766
1861
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1862
|
+
|
|
1863
|
+
/**
|
|
1864
|
+
* If 3D Secure authentication was performed with a third-party provider,
|
|
1865
|
+
* the authentication details to use for this setup.
|
|
1866
|
+
*/
|
|
1867
|
+
three_d_secure?: Card.ThreeDSecure;
|
|
1767
1868
|
}
|
|
1768
1869
|
|
|
1769
1870
|
namespace Card {
|
|
@@ -1839,6 +1940,95 @@ declare module 'stripe' {
|
|
|
1839
1940
|
| 'visa';
|
|
1840
1941
|
|
|
1841
1942
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
1943
|
+
|
|
1944
|
+
interface ThreeDSecure {
|
|
1945
|
+
/**
|
|
1946
|
+
* The `transStatus` returned from the card Issuer's ACS in the ARes.
|
|
1947
|
+
*/
|
|
1948
|
+
ares_trans_status?: ThreeDSecure.AresTransStatus;
|
|
1949
|
+
|
|
1950
|
+
/**
|
|
1951
|
+
* The cryptogram, also known as the "authentication value" (AAV, CAVV or
|
|
1952
|
+
* AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
|
|
1953
|
+
* (Most 3D Secure providers will return the base64-encoded version, which
|
|
1954
|
+
* is what you should specify here.)
|
|
1955
|
+
*/
|
|
1956
|
+
cryptogram?: string;
|
|
1957
|
+
|
|
1958
|
+
/**
|
|
1959
|
+
* The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
|
|
1960
|
+
* provider and indicates what degree of authentication was performed.
|
|
1961
|
+
*/
|
|
1962
|
+
electronic_commerce_indicator?: ThreeDSecure.ElectronicCommerceIndicator;
|
|
1963
|
+
|
|
1964
|
+
/**
|
|
1965
|
+
* Network specific 3DS fields. Network specific arguments require an
|
|
1966
|
+
* explicit card brand choice. The parameter `payment_method_options.card.network``
|
|
1967
|
+
* must be populated accordingly
|
|
1968
|
+
*/
|
|
1969
|
+
network_options?: ThreeDSecure.NetworkOptions;
|
|
1970
|
+
|
|
1971
|
+
/**
|
|
1972
|
+
* The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
|
|
1973
|
+
* AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
|
|
1974
|
+
*/
|
|
1975
|
+
requestor_challenge_indicator?: string;
|
|
1976
|
+
|
|
1977
|
+
/**
|
|
1978
|
+
* For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
|
|
1979
|
+
* Transaction ID (dsTransID).
|
|
1980
|
+
*/
|
|
1981
|
+
transaction_id?: string;
|
|
1982
|
+
|
|
1983
|
+
/**
|
|
1984
|
+
* The version of 3D Secure that was performed.
|
|
1985
|
+
*/
|
|
1986
|
+
version?: ThreeDSecure.Version;
|
|
1987
|
+
}
|
|
1988
|
+
|
|
1989
|
+
namespace ThreeDSecure {
|
|
1990
|
+
type AresTransStatus = 'A' | 'C' | 'I' | 'N' | 'R' | 'U' | 'Y';
|
|
1991
|
+
|
|
1992
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
1993
|
+
|
|
1994
|
+
interface NetworkOptions {
|
|
1995
|
+
/**
|
|
1996
|
+
* Cartes Bancaires-specific 3DS fields.
|
|
1997
|
+
*/
|
|
1998
|
+
cartes_bancaires?: NetworkOptions.CartesBancaires;
|
|
1999
|
+
}
|
|
2000
|
+
|
|
2001
|
+
namespace NetworkOptions {
|
|
2002
|
+
interface CartesBancaires {
|
|
2003
|
+
/**
|
|
2004
|
+
* The cryptogram calculation algorithm used by the card Issuer's ACS
|
|
2005
|
+
* to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
|
|
2006
|
+
* messageExtension: CB-AVALGO
|
|
2007
|
+
*/
|
|
2008
|
+
cb_avalgo: CartesBancaires.CbAvalgo;
|
|
2009
|
+
|
|
2010
|
+
/**
|
|
2011
|
+
* The exemption indicator returned from Cartes Bancaires in the ARes.
|
|
2012
|
+
* message extension: CB-EXEMPTION; string (4 characters)
|
|
2013
|
+
* This is a 3 byte bitmap (low significant byte first and most significant
|
|
2014
|
+
* bit first) that has been Base64 encoded
|
|
2015
|
+
*/
|
|
2016
|
+
cb_exemption?: string;
|
|
2017
|
+
|
|
2018
|
+
/**
|
|
2019
|
+
* The risk score returned from Cartes Bancaires in the ARes.
|
|
2020
|
+
* message extension: CB-SCORE; numeric value 0-99
|
|
2021
|
+
*/
|
|
2022
|
+
cb_score?: number;
|
|
2023
|
+
}
|
|
2024
|
+
|
|
2025
|
+
namespace CartesBancaires {
|
|
2026
|
+
type CbAvalgo = '0' | '1' | '2' | '3' | '4' | 'A';
|
|
2027
|
+
}
|
|
2028
|
+
}
|
|
2029
|
+
|
|
2030
|
+
type Version = '1.0.2' | '2.1.0' | '2.2.0';
|
|
2031
|
+
}
|
|
1842
2032
|
}
|
|
1843
2033
|
|
|
1844
2034
|
interface Link {
|
|
@@ -2765,6 +2955,12 @@ declare module 'stripe' {
|
|
|
2765
2955
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
2766
2956
|
*/
|
|
2767
2957
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
2958
|
+
|
|
2959
|
+
/**
|
|
2960
|
+
* If 3D Secure authentication was performed with a third-party provider,
|
|
2961
|
+
* the authentication details to use for this setup.
|
|
2962
|
+
*/
|
|
2963
|
+
three_d_secure?: Card.ThreeDSecure;
|
|
2768
2964
|
}
|
|
2769
2965
|
|
|
2770
2966
|
namespace Card {
|
|
@@ -2840,6 +3036,95 @@ declare module 'stripe' {
|
|
|
2840
3036
|
| 'visa';
|
|
2841
3037
|
|
|
2842
3038
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
3039
|
+
|
|
3040
|
+
interface ThreeDSecure {
|
|
3041
|
+
/**
|
|
3042
|
+
* The `transStatus` returned from the card Issuer's ACS in the ARes.
|
|
3043
|
+
*/
|
|
3044
|
+
ares_trans_status?: ThreeDSecure.AresTransStatus;
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* The cryptogram, also known as the "authentication value" (AAV, CAVV or
|
|
3048
|
+
* AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
|
|
3049
|
+
* (Most 3D Secure providers will return the base64-encoded version, which
|
|
3050
|
+
* is what you should specify here.)
|
|
3051
|
+
*/
|
|
3052
|
+
cryptogram?: string;
|
|
3053
|
+
|
|
3054
|
+
/**
|
|
3055
|
+
* The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
|
|
3056
|
+
* provider and indicates what degree of authentication was performed.
|
|
3057
|
+
*/
|
|
3058
|
+
electronic_commerce_indicator?: ThreeDSecure.ElectronicCommerceIndicator;
|
|
3059
|
+
|
|
3060
|
+
/**
|
|
3061
|
+
* Network specific 3DS fields. Network specific arguments require an
|
|
3062
|
+
* explicit card brand choice. The parameter `payment_method_options.card.network``
|
|
3063
|
+
* must be populated accordingly
|
|
3064
|
+
*/
|
|
3065
|
+
network_options?: ThreeDSecure.NetworkOptions;
|
|
3066
|
+
|
|
3067
|
+
/**
|
|
3068
|
+
* The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
|
|
3069
|
+
* AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
|
|
3070
|
+
*/
|
|
3071
|
+
requestor_challenge_indicator?: string;
|
|
3072
|
+
|
|
3073
|
+
/**
|
|
3074
|
+
* For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
|
|
3075
|
+
* Transaction ID (dsTransID).
|
|
3076
|
+
*/
|
|
3077
|
+
transaction_id?: string;
|
|
3078
|
+
|
|
3079
|
+
/**
|
|
3080
|
+
* The version of 3D Secure that was performed.
|
|
3081
|
+
*/
|
|
3082
|
+
version?: ThreeDSecure.Version;
|
|
3083
|
+
}
|
|
3084
|
+
|
|
3085
|
+
namespace ThreeDSecure {
|
|
3086
|
+
type AresTransStatus = 'A' | 'C' | 'I' | 'N' | 'R' | 'U' | 'Y';
|
|
3087
|
+
|
|
3088
|
+
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
3089
|
+
|
|
3090
|
+
interface NetworkOptions {
|
|
3091
|
+
/**
|
|
3092
|
+
* Cartes Bancaires-specific 3DS fields.
|
|
3093
|
+
*/
|
|
3094
|
+
cartes_bancaires?: NetworkOptions.CartesBancaires;
|
|
3095
|
+
}
|
|
3096
|
+
|
|
3097
|
+
namespace NetworkOptions {
|
|
3098
|
+
interface CartesBancaires {
|
|
3099
|
+
/**
|
|
3100
|
+
* The cryptogram calculation algorithm used by the card Issuer's ACS
|
|
3101
|
+
* to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
|
|
3102
|
+
* messageExtension: CB-AVALGO
|
|
3103
|
+
*/
|
|
3104
|
+
cb_avalgo: CartesBancaires.CbAvalgo;
|
|
3105
|
+
|
|
3106
|
+
/**
|
|
3107
|
+
* The exemption indicator returned from Cartes Bancaires in the ARes.
|
|
3108
|
+
* message extension: CB-EXEMPTION; string (4 characters)
|
|
3109
|
+
* This is a 3 byte bitmap (low significant byte first and most significant
|
|
3110
|
+
* bit first) that has been Base64 encoded
|
|
3111
|
+
*/
|
|
3112
|
+
cb_exemption?: string;
|
|
3113
|
+
|
|
3114
|
+
/**
|
|
3115
|
+
* The risk score returned from Cartes Bancaires in the ARes.
|
|
3116
|
+
* message extension: CB-SCORE; numeric value 0-99
|
|
3117
|
+
*/
|
|
3118
|
+
cb_score?: number;
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3121
|
+
namespace CartesBancaires {
|
|
3122
|
+
type CbAvalgo = '0' | '1' | '2' | '3' | '4' | 'A';
|
|
3123
|
+
}
|
|
3124
|
+
}
|
|
3125
|
+
|
|
3126
|
+
type Version = '1.0.2' | '2.1.0' | '2.2.0';
|
|
3127
|
+
}
|
|
2843
3128
|
}
|
|
2844
3129
|
|
|
2845
3130
|
interface Link {
|
|
@@ -60,7 +60,7 @@ declare module 'stripe' {
|
|
|
60
60
|
metadata?: Stripe.MetadataParam;
|
|
61
61
|
|
|
62
62
|
/**
|
|
63
|
-
* The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `
|
|
63
|
+
* The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment".
|
|
64
64
|
*/
|
|
65
65
|
statement_descriptor?: string;
|
|
66
66
|
}
|
|
@@ -45,7 +45,7 @@ declare module 'stripe' {
|
|
|
45
45
|
metadata?: Stripe.MetadataParam;
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `
|
|
48
|
+
* Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
|
|
49
49
|
*/
|
|
50
50
|
statement_descriptor?: string;
|
|
51
51
|
}
|