@stripe/stripe-js 3.0.10 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/bank-accounts.d.mts +61 -0
- package/dist/api/bank-accounts.d.ts +61 -0
- package/dist/api/cards.d.mts +130 -0
- package/dist/api/cards.d.ts +130 -0
- package/dist/api/confirmation-tokens.d.mts +191 -0
- package/dist/api/confirmation-tokens.d.ts +191 -0
- package/dist/api/financial-connections.d.mts +232 -0
- package/dist/api/financial-connections.d.ts +232 -0
- package/dist/api/index.d.mts +12 -0
- package/dist/api/index.d.ts +12 -0
- package/dist/api/orders.d.mts +122 -0
- package/dist/api/orders.d.ts +122 -0
- package/dist/api/payment-intents.d.mts +330 -0
- package/dist/api/payment-intents.d.ts +330 -0
- package/dist/api/payment-methods.d.mts +452 -0
- package/dist/api/payment-methods.d.ts +452 -0
- package/dist/api/setup-intents.d.mts +184 -0
- package/dist/api/setup-intents.d.ts +184 -0
- package/dist/api/shared.d.mts +125 -0
- package/dist/api/shared.d.ts +125 -0
- package/dist/api/sources.d.mts +1045 -0
- package/dist/api/sources.d.ts +1045 -0
- package/dist/api/tokens.d.mts +639 -0
- package/dist/api/tokens.d.ts +639 -0
- package/dist/api/verification-sessions.d.mts +9 -0
- package/dist/api/verification-sessions.d.ts +9 -0
- package/dist/index.d.mts +4 -12792
- package/dist/index.d.ts +4 -12792
- package/dist/{stripe.js → index.js} +1 -1
- package/dist/{stripe.mjs → index.mjs} +1 -1
- package/dist/pure.d.mts +5 -0
- package/dist/pure.d.ts +5 -0
- package/dist/pure.js +204 -0
- package/dist/pure.mjs +200 -0
- package/dist/shared.d.mts +6 -0
- package/dist/shared.d.ts +6 -0
- package/dist/stripe-js/checkout.d.mts +153 -0
- package/dist/stripe-js/checkout.d.ts +153 -0
- package/dist/stripe-js/confirmation-tokens.d.mts +1 -0
- package/dist/stripe-js/confirmation-tokens.d.ts +1 -0
- package/dist/stripe-js/custom-checkout.d.mts +402 -0
- package/dist/stripe-js/custom-checkout.d.ts +402 -0
- package/dist/stripe-js/elements/address.d.mts +261 -0
- package/dist/stripe-js/elements/address.d.ts +261 -0
- package/dist/stripe-js/elements/affirm-message.d.mts +65 -0
- package/dist/stripe-js/elements/affirm-message.d.ts +65 -0
- package/dist/stripe-js/elements/afterpay-clearpay-message.d.mts +119 -0
- package/dist/stripe-js/elements/afterpay-clearpay-message.d.ts +119 -0
- package/dist/stripe-js/elements/apple-pay.d.mts +156 -0
- package/dist/stripe-js/elements/apple-pay.d.ts +156 -0
- package/dist/stripe-js/elements/au-bank-account.d.mts +138 -0
- package/dist/stripe-js/elements/au-bank-account.d.ts +138 -0
- package/dist/stripe-js/elements/base.d.mts +264 -0
- package/dist/stripe-js/elements/base.d.ts +264 -0
- package/dist/stripe-js/elements/card-cvc.d.mts +119 -0
- package/dist/stripe-js/elements/card-cvc.d.ts +119 -0
- package/dist/stripe-js/elements/card-expiry.d.mts +119 -0
- package/dist/stripe-js/elements/card-expiry.d.ts +119 -0
- package/dist/stripe-js/elements/card-number.d.mts +200 -0
- package/dist/stripe-js/elements/card-number.d.ts +200 -0
- package/dist/stripe-js/elements/card.d.mts +226 -0
- package/dist/stripe-js/elements/card.d.ts +226 -0
- package/dist/stripe-js/elements/cart.d.mts +224 -0
- package/dist/stripe-js/elements/cart.d.ts +224 -0
- package/dist/stripe-js/elements/eps-bank.d.mts +140 -0
- package/dist/stripe-js/elements/eps-bank.d.ts +140 -0
- package/dist/stripe-js/elements/express-checkout.d.mts +446 -0
- package/dist/stripe-js/elements/express-checkout.d.ts +446 -0
- package/dist/stripe-js/elements/fpx-bank.d.mts +134 -0
- package/dist/stripe-js/elements/fpx-bank.d.ts +134 -0
- package/dist/stripe-js/elements/iban.d.mts +135 -0
- package/dist/stripe-js/elements/iban.d.ts +135 -0
- package/dist/stripe-js/elements/ideal-bank.d.mts +140 -0
- package/dist/stripe-js/elements/ideal-bank.d.ts +140 -0
- package/dist/stripe-js/elements/index.d.mts +22 -0
- package/dist/stripe-js/elements/index.d.ts +22 -0
- package/dist/stripe-js/elements/issuing/index.d.mts +5 -0
- package/dist/stripe-js/elements/issuing/index.d.ts +5 -0
- package/dist/stripe-js/elements/issuing/issuing-card-copy-button.d.mts +37 -0
- package/dist/stripe-js/elements/issuing/issuing-card-copy-button.d.ts +37 -0
- package/dist/stripe-js/elements/issuing/issuing-card-cvc-display.d.mts +32 -0
- package/dist/stripe-js/elements/issuing/issuing-card-cvc-display.d.ts +32 -0
- package/dist/stripe-js/elements/issuing/issuing-card-expiry-display.d.mts +32 -0
- package/dist/stripe-js/elements/issuing/issuing-card-expiry-display.d.ts +32 -0
- package/dist/stripe-js/elements/issuing/issuing-card-number-display.d.mts +40 -0
- package/dist/stripe-js/elements/issuing/issuing-card-number-display.d.ts +40 -0
- package/dist/stripe-js/elements/issuing/issuing-card-pin-display.d.mts +32 -0
- package/dist/stripe-js/elements/issuing/issuing-card-pin-display.d.ts +32 -0
- package/dist/stripe-js/elements/link-authentication.d.mts +158 -0
- package/dist/stripe-js/elements/link-authentication.d.ts +158 -0
- package/dist/stripe-js/elements/p24-bank.d.mts +140 -0
- package/dist/stripe-js/elements/p24-bank.d.ts +140 -0
- package/dist/stripe-js/elements/payment-method-messaging.d.mts +98 -0
- package/dist/stripe-js/elements/payment-method-messaging.d.ts +98 -0
- package/dist/stripe-js/elements/payment-request-button.d.mts +151 -0
- package/dist/stripe-js/elements/payment-request-button.d.ts +151 -0
- package/dist/stripe-js/elements/payment.d.mts +275 -0
- package/dist/stripe-js/elements/payment.d.ts +275 -0
- package/dist/stripe-js/elements/shipping-address.d.mts +215 -0
- package/dist/stripe-js/elements/shipping-address.d.ts +215 -0
- package/dist/stripe-js/elements-group.d.mts +1143 -0
- package/dist/stripe-js/elements-group.d.ts +1143 -0
- package/dist/stripe-js/embedded-checkout.d.mts +35 -0
- package/dist/stripe-js/embedded-checkout.d.ts +35 -0
- package/dist/stripe-js/ephemeral-keys.d.mts +3 -0
- package/dist/stripe-js/ephemeral-keys.d.ts +3 -0
- package/dist/stripe-js/financial-connections.d.mts +19 -0
- package/dist/stripe-js/financial-connections.d.ts +19 -0
- package/dist/stripe-js/index.d.mts +13 -0
- package/dist/stripe-js/index.d.ts +13 -0
- package/dist/stripe-js/orders.d.mts +9 -0
- package/dist/stripe-js/orders.d.ts +9 -0
- package/dist/stripe-js/payment-intents.d.mts +1473 -0
- package/dist/stripe-js/payment-intents.d.ts +1473 -0
- package/dist/stripe-js/payment-request.d.mts +529 -0
- package/dist/stripe-js/payment-request.d.ts +529 -0
- package/dist/stripe-js/setup-intents.d.mts +250 -0
- package/dist/stripe-js/setup-intents.d.ts +250 -0
- package/dist/stripe-js/stripe.d.mts +1486 -0
- package/dist/stripe-js/stripe.d.ts +1486 -0
- package/dist/stripe-js/token-and-sources.d.mts +110 -0
- package/dist/stripe-js/token-and-sources.d.ts +110 -0
- package/dist/utils.d.mts +2 -0
- package/dist/utils.d.ts +2 -0
- package/lib/index.d.mts +1 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -0
- package/lib/index.mjs +1 -0
- package/package.json +11 -10
- package/pure/index.d.mts +1 -12771
- package/pure/index.d.ts +1 -12771
- package/pure/index.js +1 -204
- package/pure/index.mjs +1 -200
|
@@ -0,0 +1,1473 @@
|
|
|
1
|
+
import {
|
|
2
|
+
StripeIdealBankElement,
|
|
3
|
+
StripeIbanElement,
|
|
4
|
+
StripeP24BankElement,
|
|
5
|
+
StripeEpsBankElement,
|
|
6
|
+
StripeFpxBankElement,
|
|
7
|
+
StripeCardCvcElement,
|
|
8
|
+
StripeCardNumberElement,
|
|
9
|
+
StripeCardElement,
|
|
10
|
+
StripeAuBankAccountElement,
|
|
11
|
+
} from './elements';
|
|
12
|
+
import {PaymentMethodCreateParams, PaymentIntentConfirmParams} from '../api';
|
|
13
|
+
import {Omit} from '../utils';
|
|
14
|
+
|
|
15
|
+
export type CreatePaymentMethodData =
|
|
16
|
+
| CreatePaymentMethodAcssDebitData
|
|
17
|
+
| CreatePaymentMethodAffirmData
|
|
18
|
+
| CreatePaymentMethodAfterpayClearpayData
|
|
19
|
+
| CreatePaymentMethodAlipayData
|
|
20
|
+
| CreatePaymentMethodAuBecsDebitData
|
|
21
|
+
| CreatePaymentMethodBacsDebitData
|
|
22
|
+
| CreatePaymentMethodBancontactData
|
|
23
|
+
| CreatePaymentMethodBlikData
|
|
24
|
+
| CreatePaymentMethodBoletoData
|
|
25
|
+
| CreatePaymentMethodCardData
|
|
26
|
+
| CreatePaymentMethodCashappData
|
|
27
|
+
| CreatePaymentMethodCustomerBalanceData
|
|
28
|
+
| CreatePaymentMethodEpsData
|
|
29
|
+
| CreatePaymentMethodGiropayData
|
|
30
|
+
| CreatePaymentMethodGrabPayData
|
|
31
|
+
| CreatePaymentMethodIdealData
|
|
32
|
+
| CreatePaymentMethodKlarnaData
|
|
33
|
+
| CreatePaymentMethodKonbiniData
|
|
34
|
+
| CreatePaymentMethodP24Data
|
|
35
|
+
| CreatePaymentMethodPayPalData
|
|
36
|
+
| CreatePaymentMethodPayNowData
|
|
37
|
+
| CreatePaymentMethodPixData
|
|
38
|
+
| CreatePaymentMethodPromptPayData
|
|
39
|
+
| CreatePaymentMethodFpxData
|
|
40
|
+
| CreatePaymentMethodUsBankAccountData
|
|
41
|
+
| CreatePaymentMethodSepaDebitData
|
|
42
|
+
| CreatePaymentMethodSofortData
|
|
43
|
+
| CreatePaymentMethodWechatPayData;
|
|
44
|
+
|
|
45
|
+
export {
|
|
46
|
+
CreatePaymentMethodFromElement,
|
|
47
|
+
CreatePaymentMethodFromElements,
|
|
48
|
+
} from '../api';
|
|
49
|
+
|
|
50
|
+
export interface CreatePaymentMethodAlipayData
|
|
51
|
+
extends PaymentMethodCreateParams {
|
|
52
|
+
type: 'alipay';
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface CreatePaymentMethodWechatPayData
|
|
56
|
+
extends PaymentMethodCreateParams {
|
|
57
|
+
/**
|
|
58
|
+
* Requires beta access:
|
|
59
|
+
* Contact [Stripe support](https://support.stripe.com/) for more information.
|
|
60
|
+
*/
|
|
61
|
+
type: 'wechat_pay';
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface CreatePaymentMethodAffirmData
|
|
65
|
+
extends PaymentMethodCreateParams {
|
|
66
|
+
type: 'affirm';
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Can be omitted as there are no Affirm-specific fields.
|
|
70
|
+
*/
|
|
71
|
+
affirm?: {}; // eslint-disable-line @typescript-eslint/ban-types
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface CreatePaymentMethodAfterpayClearpayData
|
|
75
|
+
extends PaymentMethodCreateParams {
|
|
76
|
+
type: 'afterpay_clearpay';
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Can be omitted as there are no AfterpayClearpay-specific fields.
|
|
80
|
+
*/
|
|
81
|
+
afterpay_clearpay?: {}; // eslint-disable-line @typescript-eslint/ban-types
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export interface CreatePaymentMethodBancontactData
|
|
85
|
+
extends PaymentMethodCreateParams {
|
|
86
|
+
type: 'bancontact';
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* The customer's billing details.
|
|
90
|
+
* `name` is required.
|
|
91
|
+
*
|
|
92
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
93
|
+
*/
|
|
94
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
95
|
+
name: string;
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export interface CreatePaymentMethodBlikData extends PaymentMethodCreateParams {
|
|
100
|
+
type: 'blik';
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Details about the BLIK pament method. Currently there are no supported child attributes for this field.
|
|
104
|
+
*/
|
|
105
|
+
blik?: {}; // eslint-disable-line @typescript-eslint/ban-types
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface CreatePaymentMethodBoletoData
|
|
109
|
+
extends PaymentMethodCreateParams {
|
|
110
|
+
type: 'boleto';
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* The customer's billing details.
|
|
114
|
+
* `name`, `email`, and full `address` is required.
|
|
115
|
+
*
|
|
116
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
117
|
+
*/
|
|
118
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
119
|
+
email: string;
|
|
120
|
+
name: string;
|
|
121
|
+
address: PaymentMethodCreateParams.BillingDetails.Address & {
|
|
122
|
+
line1: string;
|
|
123
|
+
city: string;
|
|
124
|
+
postal_code: string;
|
|
125
|
+
state: string;
|
|
126
|
+
country: string;
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
boleto: {
|
|
131
|
+
tax_id: string;
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
export interface CreatePaymentMethodCardData extends PaymentMethodCreateParams {
|
|
136
|
+
type: 'card';
|
|
137
|
+
|
|
138
|
+
card: StripeCardElement | StripeCardNumberElement | {token: string};
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export interface CreatePaymentMethodCashappData
|
|
142
|
+
extends PaymentMethodCreateParams {
|
|
143
|
+
type: 'cashapp';
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
export interface CreatePaymentMethodCustomerBalanceData
|
|
147
|
+
extends PaymentMethodCreateParams {
|
|
148
|
+
/**
|
|
149
|
+
* Requires beta access:
|
|
150
|
+
* Contact [Stripe support](https://support.stripe.com/) for more information.
|
|
151
|
+
*/
|
|
152
|
+
customer_balance: Record<string, never>;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
export interface CreatePaymentMethodEpsData extends PaymentMethodCreateParams {
|
|
156
|
+
type: 'eps';
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* The customer's billing details.
|
|
160
|
+
* `name` is required.
|
|
161
|
+
*
|
|
162
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
163
|
+
*/
|
|
164
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
165
|
+
name: string;
|
|
166
|
+
};
|
|
167
|
+
|
|
168
|
+
eps:
|
|
169
|
+
| StripeEpsBankElement
|
|
170
|
+
| {
|
|
171
|
+
/**
|
|
172
|
+
* The customer's bank
|
|
173
|
+
*/
|
|
174
|
+
bank?: string;
|
|
175
|
+
};
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
export interface CreatePaymentMethodFpxData extends PaymentMethodCreateParams {
|
|
179
|
+
type: 'fpx';
|
|
180
|
+
|
|
181
|
+
fpx:
|
|
182
|
+
| StripeFpxBankElement
|
|
183
|
+
| {
|
|
184
|
+
/**
|
|
185
|
+
* The customer's bank.
|
|
186
|
+
*/
|
|
187
|
+
bank: string;
|
|
188
|
+
};
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export interface CreatePaymentMethodGiropayData
|
|
192
|
+
extends PaymentMethodCreateParams {
|
|
193
|
+
type: 'giropay';
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* The customer's billing details.
|
|
197
|
+
* `name` is required.
|
|
198
|
+
*
|
|
199
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
200
|
+
*/
|
|
201
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
202
|
+
name: string;
|
|
203
|
+
};
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
export interface CreatePaymentMethodGrabPayData
|
|
207
|
+
extends PaymentMethodCreateParams {
|
|
208
|
+
type: 'grabpay';
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Can be omitted as there are no GrabPay-specific fields.
|
|
212
|
+
*/
|
|
213
|
+
grabpay?: {}; // eslint-disable-line @typescript-eslint/ban-types
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
export interface CreatePaymentMethodIdealData
|
|
217
|
+
extends PaymentMethodCreateParams {
|
|
218
|
+
type: 'ideal';
|
|
219
|
+
|
|
220
|
+
ideal:
|
|
221
|
+
| StripeIdealBankElement
|
|
222
|
+
| {
|
|
223
|
+
/**
|
|
224
|
+
* The customer's bank.
|
|
225
|
+
*/
|
|
226
|
+
bank?: string;
|
|
227
|
+
};
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
export interface CreatePaymentMethodKlarnaData
|
|
231
|
+
extends PaymentMethodCreateParams {
|
|
232
|
+
/**
|
|
233
|
+
* Requires beta access:
|
|
234
|
+
* Contact [Stripe support](https://support.stripe.com/) for more information.
|
|
235
|
+
*/
|
|
236
|
+
type: 'klarna';
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* The customer's billing details.
|
|
240
|
+
* `address.country` is required.
|
|
241
|
+
*
|
|
242
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
243
|
+
*/
|
|
244
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
245
|
+
address: PaymentMethodCreateParams.BillingDetails.Address & {
|
|
246
|
+
country: string;
|
|
247
|
+
};
|
|
248
|
+
};
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
export interface CreatePaymentMethodKonbiniData
|
|
252
|
+
extends PaymentMethodCreateParams {
|
|
253
|
+
type: 'konbini';
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* The customer's billing details.
|
|
257
|
+
* `email` and `name` are required.
|
|
258
|
+
*
|
|
259
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
260
|
+
*/
|
|
261
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
262
|
+
email: string;
|
|
263
|
+
name: string;
|
|
264
|
+
};
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
export interface CreatePaymentMethodOxxoData extends PaymentMethodCreateParams {
|
|
268
|
+
type: 'oxxo';
|
|
269
|
+
|
|
270
|
+
/**
|
|
271
|
+
* The customer's billing details.
|
|
272
|
+
* `email` and `name` are required.
|
|
273
|
+
*
|
|
274
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
275
|
+
*/
|
|
276
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
277
|
+
email: string;
|
|
278
|
+
name: string;
|
|
279
|
+
};
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
export interface CreatePaymentMethodP24Data extends PaymentMethodCreateParams {
|
|
283
|
+
type: 'p24';
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* The customer's billing details.
|
|
287
|
+
* `email` is required.
|
|
288
|
+
*
|
|
289
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
290
|
+
*/
|
|
291
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
292
|
+
email: string;
|
|
293
|
+
};
|
|
294
|
+
p24?:
|
|
295
|
+
| StripeP24BankElement
|
|
296
|
+
| {
|
|
297
|
+
/**
|
|
298
|
+
* The customer's bank.
|
|
299
|
+
*/
|
|
300
|
+
bank?: string;
|
|
301
|
+
};
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
export interface CreatePaymentMethodPayNowData
|
|
305
|
+
extends PaymentMethodCreateParams {
|
|
306
|
+
type: 'paynow';
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export interface CreatePaymentMethodPayPalData
|
|
310
|
+
extends PaymentMethodCreateParams {
|
|
311
|
+
type: 'paypal';
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
export interface CreatePaymentMethodPixData extends PaymentMethodCreateParams {
|
|
315
|
+
type: 'pix';
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
export interface CreatePaymentMethodPromptPayData
|
|
319
|
+
extends PaymentMethodCreateParams {
|
|
320
|
+
type: 'promptpay';
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
export interface CreatePaymentMethodSepaDebitData
|
|
324
|
+
extends PaymentMethodCreateParams {
|
|
325
|
+
type: 'sepa_debit';
|
|
326
|
+
|
|
327
|
+
sepa_debit:
|
|
328
|
+
| StripeIbanElement
|
|
329
|
+
| {
|
|
330
|
+
/**
|
|
331
|
+
* An IBAN account number.
|
|
332
|
+
*/
|
|
333
|
+
iban: string;
|
|
334
|
+
};
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* The customer's billing details.
|
|
338
|
+
* `name` and `email` are required.
|
|
339
|
+
*
|
|
340
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
341
|
+
*/
|
|
342
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
343
|
+
name: string;
|
|
344
|
+
email: string;
|
|
345
|
+
};
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
export interface CreatePaymentMethodSofortData
|
|
349
|
+
extends PaymentMethodCreateParams {
|
|
350
|
+
type: 'sofort';
|
|
351
|
+
|
|
352
|
+
sofort: {
|
|
353
|
+
/**
|
|
354
|
+
* The country code where customer's bank is located.
|
|
355
|
+
*/
|
|
356
|
+
country: string;
|
|
357
|
+
};
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
* The customer's billing details.
|
|
361
|
+
* Required when `setup_future_usage` is set to `off_session`.
|
|
362
|
+
*
|
|
363
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
364
|
+
*/
|
|
365
|
+
billing_details?: PaymentMethodCreateParams.BillingDetails;
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
export interface CreatePaymentMethodAuBecsDebitData
|
|
369
|
+
extends PaymentMethodCreateParams {
|
|
370
|
+
/**
|
|
371
|
+
* Requires beta access:
|
|
372
|
+
* Contact [Stripe support](https://support.stripe.com/) for more information.
|
|
373
|
+
*/
|
|
374
|
+
type: 'au_becs_debit';
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Requires beta access:
|
|
378
|
+
* Contact [Stripe support](https://support.stripe.com/) for more information.
|
|
379
|
+
*/
|
|
380
|
+
au_becs_debit:
|
|
381
|
+
| StripeAuBankAccountElement
|
|
382
|
+
| {
|
|
383
|
+
/**
|
|
384
|
+
* A BSB number.
|
|
385
|
+
*/
|
|
386
|
+
bsb_number: string;
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
* An account number.
|
|
390
|
+
*/
|
|
391
|
+
account_number: string;
|
|
392
|
+
};
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* The customer's billing details.
|
|
396
|
+
* `name` and `email` are required.
|
|
397
|
+
*
|
|
398
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
399
|
+
*/
|
|
400
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
401
|
+
name: string;
|
|
402
|
+
email: string;
|
|
403
|
+
};
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
export interface CreatePaymentMethodBacsDebitData
|
|
407
|
+
extends PaymentMethodCreateParams {
|
|
408
|
+
type: 'bacs_debit';
|
|
409
|
+
|
|
410
|
+
bacs_debit: {
|
|
411
|
+
/**
|
|
412
|
+
* A sort code.
|
|
413
|
+
*/
|
|
414
|
+
sort_code: string;
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* An account number.
|
|
418
|
+
*/
|
|
419
|
+
account_number: string;
|
|
420
|
+
};
|
|
421
|
+
|
|
422
|
+
/**
|
|
423
|
+
* The customer's billing details.
|
|
424
|
+
* `name`, `email`, and `address` are required.
|
|
425
|
+
*
|
|
426
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
427
|
+
*/
|
|
428
|
+
billing_details: PaymentMethodCreateParams.BillingDetails & {
|
|
429
|
+
name: string;
|
|
430
|
+
email: string;
|
|
431
|
+
address: PaymentMethodCreateParams.BillingDetails.Address & {
|
|
432
|
+
line1: string;
|
|
433
|
+
city: string;
|
|
434
|
+
country: string;
|
|
435
|
+
postal_code: string;
|
|
436
|
+
};
|
|
437
|
+
};
|
|
438
|
+
}
|
|
439
|
+
export interface CreatePaymentMethodAcssDebitData
|
|
440
|
+
extends PaymentMethodCreateParams {
|
|
441
|
+
type: 'acss_debit';
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
* Can be omitted as Stripe will help to collect bank account details and verification.
|
|
445
|
+
* Refer to our [integration guide](https://stripe.com/docs/payments/acss-debit/accept-a-payment) for more details.
|
|
446
|
+
*/
|
|
447
|
+
acss_debit?: {
|
|
448
|
+
/**
|
|
449
|
+
* Customer’s bank account number.
|
|
450
|
+
*/
|
|
451
|
+
account_number: string;
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* Institution number of the customer’s bank.
|
|
455
|
+
*/
|
|
456
|
+
institution_number: string;
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* Transit number of the customer’s bank.
|
|
460
|
+
*/
|
|
461
|
+
transit_number: string;
|
|
462
|
+
};
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
* The customer's billing details.
|
|
466
|
+
* `name`, `email`, and `address` are required.
|
|
467
|
+
*
|
|
468
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
469
|
+
*/
|
|
470
|
+
billing_details: PaymentMethodCreateParams.BillingDetails;
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
export interface CreatePaymentMethodUsBankAccountData
|
|
474
|
+
extends PaymentMethodCreateParams {
|
|
475
|
+
type: 'us_bank_account';
|
|
476
|
+
|
|
477
|
+
/**
|
|
478
|
+
* Can be omitted as Stripe will help to collect bank account details and verification.
|
|
479
|
+
* Refer to our [integration guide](https://stripe.com/docs/payments/acss-debit/accept-a-payment) for more details.
|
|
480
|
+
*/
|
|
481
|
+
us_bank_account: {
|
|
482
|
+
/**
|
|
483
|
+
* Customer’s bank account number.
|
|
484
|
+
*/
|
|
485
|
+
account_number: string;
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* The routing transit number for the bank account.
|
|
489
|
+
*/
|
|
490
|
+
routing_number: string;
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* The type of entity that holds the account. This can be either `individual` or `company`.
|
|
494
|
+
*/
|
|
495
|
+
account_holder_type: string;
|
|
496
|
+
|
|
497
|
+
/**
|
|
498
|
+
* Account type: checkings or savings. Defaults to checking if omitted.
|
|
499
|
+
*/
|
|
500
|
+
account_type?: string;
|
|
501
|
+
};
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* The customer's billing details.
|
|
505
|
+
* `name`, `email`, and `address` are required.
|
|
506
|
+
*
|
|
507
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
508
|
+
*/
|
|
509
|
+
billing_details: PaymentMethodCreateParams.BillingDetails;
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
export interface CollectBankAccountParams {
|
|
513
|
+
/**
|
|
514
|
+
* The payment method type for the bank account details (e.g. `us_bank_account`)
|
|
515
|
+
*/
|
|
516
|
+
payment_method_type: string;
|
|
517
|
+
/**
|
|
518
|
+
* Payment method specific data to be sent with the request (billing details)
|
|
519
|
+
*/
|
|
520
|
+
payment_method_data: CollectBankAccountPaymentMethodData;
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
export interface CollectBankAccountPaymentMethodData {
|
|
524
|
+
/**
|
|
525
|
+
* The customer's billing details.
|
|
526
|
+
* `name`, `email`, and `address` are required.
|
|
527
|
+
*
|
|
528
|
+
* @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
|
|
529
|
+
*/
|
|
530
|
+
billing_details: PaymentMethodCreateParams.BillingDetails;
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
/**
|
|
534
|
+
* Data to be sent with a `stripe.confirmBancontactPayment` request.
|
|
535
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
536
|
+
*/
|
|
537
|
+
export interface ConfirmBancontactPaymentData
|
|
538
|
+
extends PaymentIntentConfirmParams {
|
|
539
|
+
/**
|
|
540
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
541
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
542
|
+
*
|
|
543
|
+
* @recommended
|
|
544
|
+
*/
|
|
545
|
+
payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* The url your customer will be directed to after they complete authentication.
|
|
549
|
+
*
|
|
550
|
+
* @recommended
|
|
551
|
+
*/
|
|
552
|
+
return_url?: string;
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* Data to be sent with a `stripe.ConfirmBlikPayment` request.
|
|
557
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
558
|
+
*/
|
|
559
|
+
export interface ConfirmBlikPaymentData extends PaymentIntentConfirmParams {
|
|
560
|
+
/**
|
|
561
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
562
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
563
|
+
*
|
|
564
|
+
* @recommended
|
|
565
|
+
*/
|
|
566
|
+
payment_method?: string | Omit<CreatePaymentMethodBlikData, 'type'>;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.
|
|
570
|
+
*/
|
|
571
|
+
payment_method_options: {
|
|
572
|
+
/**
|
|
573
|
+
* A configuration for this BLIK payment.
|
|
574
|
+
*/
|
|
575
|
+
blik: {
|
|
576
|
+
/**
|
|
577
|
+
* Your customer's 6-digit BLIK code.
|
|
578
|
+
*/
|
|
579
|
+
code: string;
|
|
580
|
+
};
|
|
581
|
+
};
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
* Data to be sent with a `stripe.confirmBoletoPayment` request.
|
|
586
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
587
|
+
*/
|
|
588
|
+
export interface ConfirmBoletoPaymentData extends PaymentIntentConfirmParams {
|
|
589
|
+
/**
|
|
590
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
591
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
592
|
+
*
|
|
593
|
+
* @recommended
|
|
594
|
+
*/
|
|
595
|
+
payment_method?: string | Omit<CreatePaymentMethodBoletoData, 'type'>;
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* An options object to control the behavior of `stripe.confirmBoletoPayment`.
|
|
600
|
+
*/
|
|
601
|
+
export interface ConfirmBoletoPaymentOptions {
|
|
602
|
+
/**
|
|
603
|
+
* Set this to `false` if you want to handle next actions yourself. Please refer to our [Stripe Boleto integration guide](https://stripe.com/docs/payments/boleto) for more info. Default is `true`.
|
|
604
|
+
*/
|
|
605
|
+
handleActions?: boolean;
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Data to be sent with a `stripe.confirmAlipayPayment` request.
|
|
610
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
611
|
+
*/
|
|
612
|
+
export interface ConfirmAlipayPaymentData extends PaymentIntentConfirmParams {
|
|
613
|
+
/**
|
|
614
|
+
* The `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
615
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent` or a new `PaymentMethod` will be created.
|
|
616
|
+
*
|
|
617
|
+
* @recommended
|
|
618
|
+
*/
|
|
619
|
+
payment_method?: string | Omit<CreatePaymentMethodAlipayData, 'type'>;
|
|
620
|
+
|
|
621
|
+
/**
|
|
622
|
+
* The url your customer will be directed to after they complete authentication.
|
|
623
|
+
*
|
|
624
|
+
* @recommended
|
|
625
|
+
*/
|
|
626
|
+
return_url?: string;
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* An options object to control the behavior of `stripe.confirmAlipayPayment`.
|
|
631
|
+
*/
|
|
632
|
+
export interface ConfirmAlipayPaymentOptions {
|
|
633
|
+
/**
|
|
634
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/alipay/accept-a-payment#handle-redirect).
|
|
635
|
+
* Default is `true`.
|
|
636
|
+
*/
|
|
637
|
+
handleActions?: boolean;
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* An options object to control the behavior of `stripe.confirmBancontactPayment`.
|
|
642
|
+
*/
|
|
643
|
+
export interface ConfirmBancontactPaymentOptions {
|
|
644
|
+
/**
|
|
645
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/bancontact#handle-redirect).
|
|
646
|
+
* Default is `true`.
|
|
647
|
+
*/
|
|
648
|
+
handleActions?: boolean;
|
|
649
|
+
}
|
|
650
|
+
|
|
651
|
+
/**
|
|
652
|
+
* An options object to control the behavior of `stripe.confirmBlikPayment`.
|
|
653
|
+
*/
|
|
654
|
+
export interface ConfirmBlikPaymentOptions {
|
|
655
|
+
/**
|
|
656
|
+
* Set this to false if you want to manually determine if the confirmation has succeeded or failed.
|
|
657
|
+
*/
|
|
658
|
+
handleActions?: boolean;
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
/**
|
|
662
|
+
* Data to be sent with a `stripe.confirmCardPayment` request.
|
|
663
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
664
|
+
*/
|
|
665
|
+
export interface ConfirmCardPaymentData extends PaymentIntentConfirmParams {
|
|
666
|
+
/**
|
|
667
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
668
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
669
|
+
*
|
|
670
|
+
* @recommended
|
|
671
|
+
*/
|
|
672
|
+
payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.
|
|
676
|
+
*/
|
|
677
|
+
payment_method_options?: {
|
|
678
|
+
/**
|
|
679
|
+
* Configuration for this card payment.
|
|
680
|
+
*/
|
|
681
|
+
card: {
|
|
682
|
+
/**
|
|
683
|
+
* Use the provided `CardCvcElement` when confirming the PaymentIntent with an existing PaymentMethod.
|
|
684
|
+
*/
|
|
685
|
+
cvc?: StripeCardCvcElement;
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent.
|
|
689
|
+
*/
|
|
690
|
+
network?: string;
|
|
691
|
+
};
|
|
692
|
+
};
|
|
693
|
+
}
|
|
694
|
+
|
|
695
|
+
/**
|
|
696
|
+
* An options object to control the behavior of `stripe.confirmCardPayment`.
|
|
697
|
+
*/
|
|
698
|
+
export interface ConfirmCardPaymentOptions {
|
|
699
|
+
/**
|
|
700
|
+
* Set this to `false` if you want to [handle next actions yourself](https://stripe.com/docs/payments/payment-intents/verifying-status#next-actions), or if you want to defer next action handling until later (e.g. for use in the [PaymentRequest API](https://stripe.com/docs/stripe-js/elements/payment-request-button#complete-payment-intents)).
|
|
701
|
+
* Default is `true`.
|
|
702
|
+
*/
|
|
703
|
+
handleActions?: boolean;
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
/**
|
|
707
|
+
* Data to be sent with a `stripe.confirmCashappPayment` request.
|
|
708
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
709
|
+
*/
|
|
710
|
+
export interface ConfirmCashappPaymentData extends PaymentIntentConfirmParams {
|
|
711
|
+
/**
|
|
712
|
+
* The `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
713
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent` or a new `PaymentMethod` will be created.
|
|
714
|
+
*
|
|
715
|
+
* @recommended
|
|
716
|
+
*/
|
|
717
|
+
payment_method?: string | Omit<CreatePaymentMethodCashappData, 'type'>;
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* The url your customer will be directed to after they complete authentication.
|
|
721
|
+
*/
|
|
722
|
+
return_url?: string;
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
/**
|
|
726
|
+
* An options object to control the behavior of `stripe.confirmCashappPayment`.
|
|
727
|
+
*/
|
|
728
|
+
export interface ConfirmCashappPaymentOptions {
|
|
729
|
+
/**
|
|
730
|
+
* Set this to `false` if you want to [manually handle the authorization QR code or redirect](https://stripe.com/docs/payments/cash-app-pay/accept-a-payment?platform=web&ui=API#handle-redirect).
|
|
731
|
+
* Default is `true`.
|
|
732
|
+
*/
|
|
733
|
+
handleActions?: boolean;
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* Data to be sent with a `stripe.confirmCustomerBalancePayment` request.
|
|
738
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
739
|
+
*/
|
|
740
|
+
export interface ConfirmCustomerBalancePaymentData
|
|
741
|
+
extends PaymentIntentConfirmParams {
|
|
742
|
+
/**
|
|
743
|
+
* An object specifying the `customer_balance` type.
|
|
744
|
+
*/
|
|
745
|
+
payment_method: CreatePaymentMethodCustomerBalanceData;
|
|
746
|
+
payment_method_options?: {
|
|
747
|
+
customer_balance?: {
|
|
748
|
+
funding_type?: 'bank_transfer';
|
|
749
|
+
bank_transfer?: {
|
|
750
|
+
type:
|
|
751
|
+
| 'eu_bank_transfer'
|
|
752
|
+
| 'gb_bank_transfer'
|
|
753
|
+
| 'id_bank_transfer'
|
|
754
|
+
| 'jp_bank_transfer'
|
|
755
|
+
| 'mx_bank_transfer'
|
|
756
|
+
| 'us_bank_transfer';
|
|
757
|
+
eu_bank_transfer?: {
|
|
758
|
+
country: 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
|
|
759
|
+
};
|
|
760
|
+
id_bank_transfer?: {
|
|
761
|
+
bank: 'bni' | 'bca';
|
|
762
|
+
};
|
|
763
|
+
requested_address_types?: Array<
|
|
764
|
+
| 'aba'
|
|
765
|
+
| 'swift'
|
|
766
|
+
| 'sort_code'
|
|
767
|
+
| 'zengin'
|
|
768
|
+
| 'iban'
|
|
769
|
+
| 'spei'
|
|
770
|
+
| 'id_bban'
|
|
771
|
+
| 'sepa'
|
|
772
|
+
>;
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
};
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
/**
|
|
779
|
+
* An options object to control the behavior of `stripe.confirmCustomerBalancePayment`.
|
|
780
|
+
*/
|
|
781
|
+
export interface ConfirmCustomerBalancePaymentOptions {
|
|
782
|
+
/**
|
|
783
|
+
* This must be set to `false`.
|
|
784
|
+
* The Customer Balance does not handle the next actions for you automatically (e.g. displaying bank transfer details).
|
|
785
|
+
* To make future upgrades easier, this option is required to always be sent.
|
|
786
|
+
* Please refer to our [Stripe Customer Balance integration guide](https://stripe.com/docs/payments/bank-transfers) for more info.
|
|
787
|
+
*/
|
|
788
|
+
handleActions: false;
|
|
789
|
+
}
|
|
790
|
+
|
|
791
|
+
/**
|
|
792
|
+
* Data to be sent with a `stripe.confirmEpsPayment` request.
|
|
793
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
794
|
+
*/
|
|
795
|
+
export interface ConfirmEpsPaymentData extends PaymentIntentConfirmParams {
|
|
796
|
+
/**
|
|
797
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
798
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
799
|
+
*
|
|
800
|
+
* @recommended
|
|
801
|
+
*/
|
|
802
|
+
payment_method?: string | Omit<CreatePaymentMethodEpsData, 'type'>;
|
|
803
|
+
|
|
804
|
+
/**
|
|
805
|
+
* The url your customer will be directed to after they complete authentication.
|
|
806
|
+
*
|
|
807
|
+
* @recommended
|
|
808
|
+
*/
|
|
809
|
+
return_url?: string;
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* An options object to control the behavior of `stripe.confirmEpsPayment`.
|
|
814
|
+
*/
|
|
815
|
+
export interface ConfirmEpsPaymentOptions {
|
|
816
|
+
/**
|
|
817
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/eps#handle-redirect).
|
|
818
|
+
* Default is `true`.
|
|
819
|
+
*/
|
|
820
|
+
handleActions?: boolean;
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* Data to be sent with a `stripe.confirmSepaDebitPayment` request.
|
|
825
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
826
|
+
*/
|
|
827
|
+
export interface ConfirmSepaDebitPaymentData
|
|
828
|
+
extends PaymentIntentConfirmParams {
|
|
829
|
+
/**
|
|
830
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
831
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
832
|
+
*
|
|
833
|
+
* @recommended
|
|
834
|
+
*/
|
|
835
|
+
payment_method?: string | Omit<CreatePaymentMethodSepaDebitData, 'type'>;
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* To save the SEPA Direct Debit account for reuse, set this parameter to `off_session`.
|
|
839
|
+
* SEPA Direct Debit only accepts an `off_session` value for this parameter.
|
|
840
|
+
*/
|
|
841
|
+
setup_future_usage?: 'off_session';
|
|
842
|
+
}
|
|
843
|
+
|
|
844
|
+
/**
|
|
845
|
+
* Data to be sent with a `stripe.confirmFpxPayment` request.
|
|
846
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
847
|
+
*/
|
|
848
|
+
export interface ConfirmFpxPaymentData extends PaymentIntentConfirmParams {
|
|
849
|
+
/**
|
|
850
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
851
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
852
|
+
*
|
|
853
|
+
* @recommended
|
|
854
|
+
*/
|
|
855
|
+
payment_method?: string | Omit<CreatePaymentMethodFpxData, 'type'>;
|
|
856
|
+
|
|
857
|
+
/**
|
|
858
|
+
* The url your customer will be directed to after they complete authentication.
|
|
859
|
+
*
|
|
860
|
+
* @recommended
|
|
861
|
+
*/
|
|
862
|
+
return_url?: string;
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* An options object to control the behavior of `stripe.confirmFpxPayment`.
|
|
867
|
+
*/
|
|
868
|
+
export interface ConfirmFpxPaymentOptions {
|
|
869
|
+
/**
|
|
870
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/fpx#handle-redirect).
|
|
871
|
+
* Default is `true`.
|
|
872
|
+
*/
|
|
873
|
+
handleActions?: boolean;
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
/**
|
|
877
|
+
* Data to be sent with a `stripe.confirmGiropayPayment` request.
|
|
878
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
879
|
+
*/
|
|
880
|
+
export interface ConfirmGiropayPaymentData extends PaymentIntentConfirmParams {
|
|
881
|
+
/**
|
|
882
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
883
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
884
|
+
*
|
|
885
|
+
* @recommended
|
|
886
|
+
*/
|
|
887
|
+
payment_method?: string | Omit<CreatePaymentMethodGiropayData, 'type'>;
|
|
888
|
+
|
|
889
|
+
/**
|
|
890
|
+
* The url your customer will be directed to after they complete authentication.
|
|
891
|
+
*
|
|
892
|
+
* @recommended
|
|
893
|
+
*/
|
|
894
|
+
return_url?: string;
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
/**
|
|
898
|
+
* An options object to control the behavior of `stripe.confirmGiropayPayment`.
|
|
899
|
+
*/
|
|
900
|
+
export interface ConfirmGiropayPaymentOptions {
|
|
901
|
+
/**
|
|
902
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/giropay#handle-redirect).
|
|
903
|
+
* Default is `true`.
|
|
904
|
+
*/
|
|
905
|
+
handleActions?: boolean;
|
|
906
|
+
}
|
|
907
|
+
|
|
908
|
+
/**
|
|
909
|
+
* Data to be sent with a `stripe.confirmGrabPayPayment` request.
|
|
910
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
911
|
+
*/
|
|
912
|
+
export interface ConfirmGrabPayPaymentData extends PaymentIntentConfirmParams {
|
|
913
|
+
/**
|
|
914
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
915
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
916
|
+
*
|
|
917
|
+
* @recommended
|
|
918
|
+
*/
|
|
919
|
+
payment_method?: string | Omit<CreatePaymentMethodGrabPayData, 'type'>;
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* The url your customer will be directed to after they complete authentication.
|
|
923
|
+
*
|
|
924
|
+
* @recommended
|
|
925
|
+
*/
|
|
926
|
+
return_url?: string;
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* An options object to control the behavior of `stripe.confirmGrabPayPayment`.
|
|
931
|
+
*/
|
|
932
|
+
export interface ConfirmGrabPayPaymentOptions {
|
|
933
|
+
/**
|
|
934
|
+
* Set this to `false` if you want to handle next actions yourself. Please refer to our [Stripe GrabPay integration guide](https://stripe.com/docs/payments/grabpay/accept-a-payment)
|
|
935
|
+
* for more info. Default is `true`.
|
|
936
|
+
*/
|
|
937
|
+
handleActions?: boolean;
|
|
938
|
+
}
|
|
939
|
+
|
|
940
|
+
/**
|
|
941
|
+
* Data to be sent with a `stripe.confirmIdealPayment` request.
|
|
942
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
943
|
+
*/
|
|
944
|
+
export interface ConfirmIdealPaymentData extends PaymentIntentConfirmParams {
|
|
945
|
+
/**
|
|
946
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
947
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
948
|
+
*
|
|
949
|
+
* @recommended
|
|
950
|
+
*/
|
|
951
|
+
payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;
|
|
952
|
+
|
|
953
|
+
/**
|
|
954
|
+
* The url your customer will be directed to after they complete authentication.
|
|
955
|
+
*
|
|
956
|
+
* @recommended
|
|
957
|
+
*/
|
|
958
|
+
return_url?: string;
|
|
959
|
+
}
|
|
960
|
+
|
|
961
|
+
/**
|
|
962
|
+
* An options object to control the behavior of `stripe.confirmIdealPayment`.
|
|
963
|
+
*/
|
|
964
|
+
export interface ConfirmIdealPaymentOptions {
|
|
965
|
+
/**
|
|
966
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/ideal#handle-redirect).
|
|
967
|
+
* Default is `true`.
|
|
968
|
+
*/
|
|
969
|
+
handleActions?: boolean;
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* Data to be sent with a `stripe.confirmKlarnaPayment` request.
|
|
974
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
975
|
+
*/
|
|
976
|
+
export interface ConfirmKlarnaPaymentData extends PaymentIntentConfirmParams {
|
|
977
|
+
/**
|
|
978
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
979
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
980
|
+
*
|
|
981
|
+
* @recommended
|
|
982
|
+
*/
|
|
983
|
+
payment_method?: string | Omit<CreatePaymentMethodKlarnaData, 'type'>;
|
|
984
|
+
|
|
985
|
+
/**
|
|
986
|
+
* The url your customer will be directed to after they complete authentication.
|
|
987
|
+
*
|
|
988
|
+
* @recommended
|
|
989
|
+
*/
|
|
990
|
+
return_url?: string;
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
/**
|
|
994
|
+
* An options object to control the behavior of `stripe.confirmKlarnaPayment`.
|
|
995
|
+
*/
|
|
996
|
+
export interface ConfirmKlarnaPaymentOptions {
|
|
997
|
+
/**
|
|
998
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/klarna#handle-redirect).
|
|
999
|
+
* Default is `true`.
|
|
1000
|
+
*/
|
|
1001
|
+
handleActions?: boolean;
|
|
1002
|
+
}
|
|
1003
|
+
|
|
1004
|
+
/**
|
|
1005
|
+
* Data to be sent with a `stripe.confirmKonbiniPayment` request.
|
|
1006
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1007
|
+
*/
|
|
1008
|
+
export interface ConfirmKonbiniPaymentData extends PaymentIntentConfirmParams {
|
|
1009
|
+
/**
|
|
1010
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1011
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1012
|
+
*
|
|
1013
|
+
* @recommended
|
|
1014
|
+
*/
|
|
1015
|
+
payment_method?: string | Omit<CreatePaymentMethodKonbiniData, 'type'>;
|
|
1016
|
+
|
|
1017
|
+
/**
|
|
1018
|
+
* An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.
|
|
1019
|
+
*/
|
|
1020
|
+
payment_method_options?: {
|
|
1021
|
+
/**
|
|
1022
|
+
* Configuration for this Konbini payment.
|
|
1023
|
+
*/
|
|
1024
|
+
konbini: {
|
|
1025
|
+
/**
|
|
1026
|
+
* An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. May not be all 0 and could be rejected in case of insufficient uniqueness. We recommend to use the customer’s phone number.
|
|
1027
|
+
*/
|
|
1028
|
+
confirmation_number?: string;
|
|
1029
|
+
};
|
|
1030
|
+
};
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* An options object to control the behavior of `stripe.confirmKonbiniPayment`.
|
|
1035
|
+
*/
|
|
1036
|
+
export interface ConfirmKonbiniPaymentOptions {
|
|
1037
|
+
/**
|
|
1038
|
+
* Set this to `false` if you want to handle next actions yourself. Please refer to our [integration guide](https://stripe.com/docs/payments/konbini/accept-a-payment) for more info. Default is `true`.
|
|
1039
|
+
*/
|
|
1040
|
+
handleActions?: boolean;
|
|
1041
|
+
}
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Data to be sent with a `stripe.confirmOxxoPayment` request.
|
|
1045
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1046
|
+
*/
|
|
1047
|
+
export interface ConfirmOxxoPaymentData extends PaymentIntentConfirmParams {
|
|
1048
|
+
/**
|
|
1049
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1050
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1051
|
+
*
|
|
1052
|
+
* @recommended
|
|
1053
|
+
*/
|
|
1054
|
+
payment_method?: string | Omit<CreatePaymentMethodOxxoData, 'type'>;
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
/**
|
|
1058
|
+
* An options object to control the behavior of `stripe.confirmOxxoPayment`.
|
|
1059
|
+
*/
|
|
1060
|
+
export interface ConfirmOxxoPaymentOptions {
|
|
1061
|
+
/**
|
|
1062
|
+
* Set this to `false` if you want to handle next actions yourself. Please refer to our [Stripe OXXO integration guide](https://stripe.com/docs/payments/oxxo) for more info. Default is `true`.
|
|
1063
|
+
*/
|
|
1064
|
+
handleActions?: boolean;
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
* Data to be sent with a `stripe.confirmP24Payment` request.
|
|
1069
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1070
|
+
*/
|
|
1071
|
+
export interface ConfirmP24PaymentData extends PaymentIntentConfirmParams {
|
|
1072
|
+
/**
|
|
1073
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1074
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1075
|
+
*
|
|
1076
|
+
* @recommended
|
|
1077
|
+
*/
|
|
1078
|
+
payment_method?: string | Omit<CreatePaymentMethodP24Data, 'type'>;
|
|
1079
|
+
|
|
1080
|
+
payment_method_options?: {
|
|
1081
|
+
/**
|
|
1082
|
+
* Configuration for this Przelewy24 payment.
|
|
1083
|
+
*/
|
|
1084
|
+
p24: {
|
|
1085
|
+
/**
|
|
1086
|
+
* Specify that payer has agreed to the Przelewy24 Terms of Service
|
|
1087
|
+
*/
|
|
1088
|
+
tos_shown_and_accepted?: boolean;
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
1091
|
+
|
|
1092
|
+
/**
|
|
1093
|
+
* The url your customer will be directed to after they complete authentication.
|
|
1094
|
+
*
|
|
1095
|
+
* @recommended
|
|
1096
|
+
*/
|
|
1097
|
+
return_url?: string;
|
|
1098
|
+
}
|
|
1099
|
+
|
|
1100
|
+
/**
|
|
1101
|
+
* Data to be sent with a `stripe.confirmPayNowPayment` request.
|
|
1102
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1103
|
+
*/
|
|
1104
|
+
export interface ConfirmPayNowPaymentData extends PaymentIntentConfirmParams {
|
|
1105
|
+
/**
|
|
1106
|
+
* The `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
1107
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent` or a new `PaymentMethod` will be created.
|
|
1108
|
+
*
|
|
1109
|
+
* @recommended
|
|
1110
|
+
*/
|
|
1111
|
+
payment_method?: string | Omit<CreatePaymentMethodPayNowData, 'type'>;
|
|
1112
|
+
}
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
* An options object to control the behavior of `stripe.confirmPayNowPayment`.
|
|
1116
|
+
*/
|
|
1117
|
+
export interface ConfirmPayNowPaymentOptions {
|
|
1118
|
+
/**
|
|
1119
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect).
|
|
1120
|
+
* Default is `true`.
|
|
1121
|
+
*/
|
|
1122
|
+
handleActions?: boolean;
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
/**
|
|
1126
|
+
* Data to be sent with a `stripe.confirmPayPalPayment` request.
|
|
1127
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1128
|
+
*/
|
|
1129
|
+
export interface ConfirmPayPalPaymentData extends PaymentIntentConfirmParams {
|
|
1130
|
+
/**
|
|
1131
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1132
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1133
|
+
*
|
|
1134
|
+
* @recommended
|
|
1135
|
+
*/
|
|
1136
|
+
payment_method?: string | Omit<CreatePaymentMethodPayPalData, 'type'>;
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* The required url your customer will be directed to after they complete authentication.
|
|
1140
|
+
*/
|
|
1141
|
+
return_url: string;
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
/**
|
|
1145
|
+
* An options object to control the behavior of `stripe.confirmP24Payment`.
|
|
1146
|
+
*/
|
|
1147
|
+
export interface ConfirmP24PaymentOptions {
|
|
1148
|
+
/**
|
|
1149
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect).
|
|
1150
|
+
* Default is `true`.
|
|
1151
|
+
*/
|
|
1152
|
+
handleActions?: boolean;
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1155
|
+
/**
|
|
1156
|
+
* Data to be sent with a `stripe.confirmPixPayment` request.
|
|
1157
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1158
|
+
*/
|
|
1159
|
+
export interface ConfirmPixPaymentData extends PaymentIntentConfirmParams {
|
|
1160
|
+
/**
|
|
1161
|
+
* The `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
1162
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent` or a new `PaymentMethod` will be created.
|
|
1163
|
+
*
|
|
1164
|
+
* @recommended
|
|
1165
|
+
*/
|
|
1166
|
+
payment_method?: string | Omit<CreatePaymentMethodPixData, 'type'>;
|
|
1167
|
+
}
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* An options object to control the behavior of `stripe.confirmPayNowPayment`.
|
|
1171
|
+
*/
|
|
1172
|
+
export interface ConfirmPixPaymentOptions {
|
|
1173
|
+
/**
|
|
1174
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect).
|
|
1175
|
+
* Default is `true`.
|
|
1176
|
+
*/
|
|
1177
|
+
handleActions?: boolean;
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
* Data to be sent with a `stripe.confirmPayNowPayment` request.
|
|
1182
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1183
|
+
*/
|
|
1184
|
+
export interface ConfirmPromptPayPaymentData
|
|
1185
|
+
extends PaymentIntentConfirmParams {
|
|
1186
|
+
/**
|
|
1187
|
+
* The `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
1188
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent` or a new `PaymentMethod` will be created.
|
|
1189
|
+
*
|
|
1190
|
+
* @recommended
|
|
1191
|
+
*/
|
|
1192
|
+
payment_method?: string | Omit<CreatePaymentMethodPromptPayData, 'type'>;
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
* An options object to control the behavior of `stripe.confirmPayNowPayment`.
|
|
1197
|
+
*/
|
|
1198
|
+
export interface ConfirmPromptPayPaymentOptions {
|
|
1199
|
+
/**
|
|
1200
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect).
|
|
1201
|
+
* Default is `true`.
|
|
1202
|
+
*/
|
|
1203
|
+
handleActions?: boolean;
|
|
1204
|
+
}
|
|
1205
|
+
|
|
1206
|
+
/**
|
|
1207
|
+
* Data to be sent with a `stripe.confirmSofortPayment` request.
|
|
1208
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1209
|
+
*/
|
|
1210
|
+
export interface ConfirmSofortPaymentData extends PaymentIntentConfirmParams {
|
|
1211
|
+
/**
|
|
1212
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1213
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1214
|
+
*
|
|
1215
|
+
* @recommended
|
|
1216
|
+
*/
|
|
1217
|
+
payment_method?: string | Omit<CreatePaymentMethodSofortData, 'type'>;
|
|
1218
|
+
|
|
1219
|
+
/**
|
|
1220
|
+
* The url your customer will be directed to after they complete authentication.
|
|
1221
|
+
*
|
|
1222
|
+
* @recommended
|
|
1223
|
+
*/
|
|
1224
|
+
return_url?: string;
|
|
1225
|
+
|
|
1226
|
+
/**
|
|
1227
|
+
* To set up a SEPA Direct Debit payment method using the bank details from this SOFORT payment, set this parameter to `off_session`.
|
|
1228
|
+
* When using this parameter, a `customer` will need to be set on the [PaymentIntent](https://stripe.com/docs/api/payment_intents).
|
|
1229
|
+
* The newly created SEPA Direct Debit [PaymentMethod](https://stripe.com/docs/api/payment_methods) will be attached to this customer.
|
|
1230
|
+
*/
|
|
1231
|
+
setup_future_usage?: 'off_session';
|
|
1232
|
+
}
|
|
1233
|
+
|
|
1234
|
+
/**
|
|
1235
|
+
* An options object to control the behavior of `stripe.confirmSofortPayment`.
|
|
1236
|
+
*/
|
|
1237
|
+
export interface ConfirmSofortPaymentOptions {
|
|
1238
|
+
/**
|
|
1239
|
+
* Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect).
|
|
1240
|
+
* Default is `true`.
|
|
1241
|
+
*/
|
|
1242
|
+
handleActions?: boolean;
|
|
1243
|
+
}
|
|
1244
|
+
|
|
1245
|
+
/**
|
|
1246
|
+
* Data to be sent with a `stripe.confirmWechatPayPayment` request.
|
|
1247
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1248
|
+
*/
|
|
1249
|
+
export interface ConfirmWechatPayPaymentData
|
|
1250
|
+
extends PaymentIntentConfirmParams {
|
|
1251
|
+
/**
|
|
1252
|
+
* The `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
1253
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent` or a new `PaymentMethod` will be created.
|
|
1254
|
+
*
|
|
1255
|
+
* @recommended
|
|
1256
|
+
*/
|
|
1257
|
+
payment_method?: string | Omit<CreatePaymentMethodWechatPayData, 'type'>;
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.
|
|
1261
|
+
*/
|
|
1262
|
+
payment_method_options?: {
|
|
1263
|
+
/**
|
|
1264
|
+
* Configuration for this wechat payment.
|
|
1265
|
+
*/
|
|
1266
|
+
wechat_pay: {
|
|
1267
|
+
client?: 'web';
|
|
1268
|
+
};
|
|
1269
|
+
};
|
|
1270
|
+
}
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* An options object to control the behavior of `stripe.confirmWechatPayPayment`.
|
|
1274
|
+
*/
|
|
1275
|
+
export interface ConfirmWechatPayPaymentOptions {
|
|
1276
|
+
/**
|
|
1277
|
+
* This must be set to false, and you are responsible for handling the next_action after confirming the PaymentIntent.
|
|
1278
|
+
*/
|
|
1279
|
+
handleActions: boolean;
|
|
1280
|
+
}
|
|
1281
|
+
|
|
1282
|
+
/**
|
|
1283
|
+
* Data to be sent with a `stripe.confirmAuBecsDebitPayment` request.
|
|
1284
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1285
|
+
*/
|
|
1286
|
+
export interface ConfirmAuBecsDebitPaymentData
|
|
1287
|
+
extends PaymentIntentConfirmParams {
|
|
1288
|
+
/**
|
|
1289
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1290
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1291
|
+
*
|
|
1292
|
+
* @recommended
|
|
1293
|
+
*/
|
|
1294
|
+
payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;
|
|
1295
|
+
|
|
1296
|
+
/**
|
|
1297
|
+
* To save the BECS Direct Debit account for reuse, set this parameter to `off_session`.
|
|
1298
|
+
* BECS Direct Debit only accepts an `off_session` value for this parameter.
|
|
1299
|
+
*/
|
|
1300
|
+
setup_future_usage?: 'off_session';
|
|
1301
|
+
}
|
|
1302
|
+
|
|
1303
|
+
/**
|
|
1304
|
+
* Data to be sent with a `stripe.confirmAffirmPayment` request.
|
|
1305
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1306
|
+
*/
|
|
1307
|
+
export interface ConfirmAffirmPaymentData extends PaymentIntentConfirmParams {
|
|
1308
|
+
/**
|
|
1309
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1310
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1311
|
+
*
|
|
1312
|
+
* @recommended
|
|
1313
|
+
*/
|
|
1314
|
+
payment_method?: string | Omit<CreatePaymentMethodAffirmData, 'type'>;
|
|
1315
|
+
|
|
1316
|
+
/**
|
|
1317
|
+
* The url your customer will be directed to after they complete authentication.
|
|
1318
|
+
*/
|
|
1319
|
+
return_url?: string;
|
|
1320
|
+
}
|
|
1321
|
+
|
|
1322
|
+
/**
|
|
1323
|
+
* An options object to control the behavior of `stripe.confirmAffirmPayment`.
|
|
1324
|
+
*/
|
|
1325
|
+
export interface ConfirmAffirmPaymentOptions {
|
|
1326
|
+
/**
|
|
1327
|
+
* Set this to `false` if you want to handle next actions yourself. Please refer to our [Stripe Affirm integration guide](https://stripe.com/docs/payments/affirm/accept-a-payment)
|
|
1328
|
+
* for more info. Default is `true`.
|
|
1329
|
+
*/
|
|
1330
|
+
handleActions?: boolean;
|
|
1331
|
+
}
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* Data to be sent with a `stripe.confirmAfterpayClearpayPayment` request.
|
|
1335
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1336
|
+
*/
|
|
1337
|
+
export interface ConfirmAfterpayClearpayPaymentData
|
|
1338
|
+
extends PaymentIntentConfirmParams {
|
|
1339
|
+
/**
|
|
1340
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1341
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1342
|
+
*
|
|
1343
|
+
* @recommended
|
|
1344
|
+
*/
|
|
1345
|
+
payment_method?:
|
|
1346
|
+
| string
|
|
1347
|
+
| Omit<CreatePaymentMethodAfterpayClearpayData, 'type'>;
|
|
1348
|
+
|
|
1349
|
+
/**
|
|
1350
|
+
* The url your customer will be directed to after they complete authentication.
|
|
1351
|
+
*/
|
|
1352
|
+
return_url?: string;
|
|
1353
|
+
}
|
|
1354
|
+
|
|
1355
|
+
/**
|
|
1356
|
+
* An options object to control the behavior of `stripe.confirmAfterpayClearpayPayment`.
|
|
1357
|
+
*/
|
|
1358
|
+
export interface ConfirmAfterpayClearpayPaymentOptions {
|
|
1359
|
+
/**
|
|
1360
|
+
* Set this to `false` if you want to handle next actions yourself. Please refer to our [Stripe Afterpay / Clearpay integration guide](https://stripe.com/docs/payments/afterpay-clearpay/accept-a-payment#handle-redirect)
|
|
1361
|
+
* for more info. Default is `true`.
|
|
1362
|
+
*/
|
|
1363
|
+
handleActions?: boolean;
|
|
1364
|
+
}
|
|
1365
|
+
|
|
1366
|
+
/**
|
|
1367
|
+
* Data to be sent with a `stripe.confirmAcssDebitPayment` request.
|
|
1368
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1369
|
+
*/
|
|
1370
|
+
export interface ConfirmAcssDebitPaymentData
|
|
1371
|
+
extends PaymentIntentConfirmParams {
|
|
1372
|
+
/**
|
|
1373
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1374
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1375
|
+
*
|
|
1376
|
+
* @recommended
|
|
1377
|
+
*/
|
|
1378
|
+
payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;
|
|
1379
|
+
}
|
|
1380
|
+
|
|
1381
|
+
/**
|
|
1382
|
+
* An options object to control the behavior of `stripe.confirmAcssDebitPayment`.
|
|
1383
|
+
*/
|
|
1384
|
+
export interface ConfirmAcssDebitPaymentOptions {
|
|
1385
|
+
/**
|
|
1386
|
+
* Set `skipMandate` to `true` if you want to skip displaying the mandate confirmation screen.
|
|
1387
|
+
*/
|
|
1388
|
+
skipMandate?: boolean;
|
|
1389
|
+
}
|
|
1390
|
+
|
|
1391
|
+
export interface ConfirmUsBankAccountPaymentData
|
|
1392
|
+
extends PaymentIntentConfirmParams {
|
|
1393
|
+
/**
|
|
1394
|
+
* Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
|
|
1395
|
+
* This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
|
|
1396
|
+
*
|
|
1397
|
+
* @recommended
|
|
1398
|
+
*/
|
|
1399
|
+
payment_method?: string | Omit<CreatePaymentMethodUsBankAccountData, 'type'>;
|
|
1400
|
+
}
|
|
1401
|
+
|
|
1402
|
+
/**
|
|
1403
|
+
* Data to be sent with a `stripe.confirmPayment` request.
|
|
1404
|
+
* Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
|
|
1405
|
+
*/
|
|
1406
|
+
export interface ConfirmPaymentData extends PaymentIntentConfirmParams {
|
|
1407
|
+
/**
|
|
1408
|
+
* The url your customer will be directed to after they complete payment.
|
|
1409
|
+
*/
|
|
1410
|
+
return_url: string;
|
|
1411
|
+
|
|
1412
|
+
/**
|
|
1413
|
+
* An object to attach additional billing_details to the PaymentMethod created via Elements.
|
|
1414
|
+
*
|
|
1415
|
+
* @docs https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_data
|
|
1416
|
+
*/
|
|
1417
|
+
payment_method_data?: {
|
|
1418
|
+
/**
|
|
1419
|
+
* The customer's billing details. Details collected by Elements will override values passed here.
|
|
1420
|
+
* Billing fields that are omitted in the Payment Element via the `fields` option required.
|
|
1421
|
+
*
|
|
1422
|
+
* @docs https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_data-billing_details
|
|
1423
|
+
*/
|
|
1424
|
+
billing_details?: PaymentMethodCreateParams.BillingDetails;
|
|
1425
|
+
|
|
1426
|
+
/**
|
|
1427
|
+
* Requires beta access:
|
|
1428
|
+
* Contact [Stripe support](https://support.stripe.com/) for more information.
|
|
1429
|
+
*
|
|
1430
|
+
* Specifies if the PaymentMethod should be redisplayed when using the Saved Payment Method feature
|
|
1431
|
+
*/
|
|
1432
|
+
allow_redisplay?: 'always' | 'limited' | 'unspecified';
|
|
1433
|
+
};
|
|
1434
|
+
|
|
1435
|
+
/**
|
|
1436
|
+
* Optional `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
|
|
1437
|
+
*
|
|
1438
|
+
* @docs https://stripe.com/docs/js/payment_intents/confirm_payment#confirm_payment_intent-options-confirmParams-payment_method
|
|
1439
|
+
*/
|
|
1440
|
+
payment_method?: string;
|
|
1441
|
+
|
|
1442
|
+
/**
|
|
1443
|
+
* Specifies which fields in the response should be expanded.
|
|
1444
|
+
*/
|
|
1445
|
+
expand?: Array<string>;
|
|
1446
|
+
}
|
|
1447
|
+
|
|
1448
|
+
/**
|
|
1449
|
+
* Data to be sent with a `stripe.verifyMicrodepositsForPayment` request.
|
|
1450
|
+
*/
|
|
1451
|
+
export interface VerifyMicrodepositsForPaymentData {
|
|
1452
|
+
/**
|
|
1453
|
+
* An array of two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
|
|
1454
|
+
*/
|
|
1455
|
+
amounts?: Array<number>;
|
|
1456
|
+
}
|
|
1457
|
+
|
|
1458
|
+
/**
|
|
1459
|
+
* Data to be sent with a `stripe.collectBankAccountForPayment` request.
|
|
1460
|
+
*/
|
|
1461
|
+
export interface CollectBankAccountForPaymentOptions {
|
|
1462
|
+
/**
|
|
1463
|
+
* The client secret of the PaymentIntent.
|
|
1464
|
+
*/
|
|
1465
|
+
clientSecret: string;
|
|
1466
|
+
|
|
1467
|
+
params: CollectBankAccountParams;
|
|
1468
|
+
|
|
1469
|
+
/**
|
|
1470
|
+
* Specifies which fields in the response should be expanded.
|
|
1471
|
+
*/
|
|
1472
|
+
expand?: Array<string>;
|
|
1473
|
+
}
|