-
Notifications
You must be signed in to change notification settings - Fork 147
/
payment.d.ts
214 lines (189 loc) · 5.36 KB
/
payment.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
import {StripeElementBase} from './base';
import {StripeError} from '../stripe';
export type StripePaymentElement = StripeElementBase & {
/**
* The change event is triggered when the `Element`'s value changes.
*/
on(
eventType: 'change',
handler: (event: StripePaymentElementChangeEvent) => any
): StripePaymentElement;
once(
eventType: 'change',
handler: (event: StripePaymentElementChangeEvent) => any
): StripePaymentElement;
off(
eventType: 'change',
handler?: (event: StripePaymentElementChangeEvent) => any
): StripePaymentElement;
/**
* Triggered when the element is fully rendered and can accept `element.focus` calls.
*/
on(
eventType: 'ready',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
once(
eventType: 'ready',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
off(
eventType: 'ready',
handler?: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
/**
* Triggered when the element gains focus.
*/
on(
eventType: 'focus',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
once(
eventType: 'focus',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
off(
eventType: 'focus',
handler?: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
/**
* Triggered when the element loses focus.
*/
on(
eventType: 'blur',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
once(
eventType: 'blur',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
off(
eventType: 'blur',
handler?: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
/**
* Triggered when the escape key is pressed within the element.
*/
on(
eventType: 'escape',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
once(
eventType: 'escape',
handler: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
off(
eventType: 'escape',
handler?: (event: {elementType: 'payment'}) => any
): StripePaymentElement;
/**
* Triggered when the element fails to load.
*/
on(
eventType: 'loaderror',
handler: (event: {elementType: 'payment'; error: StripeError}) => any
): StripePaymentElement;
once(
eventType: 'loaderror',
handler: (event: {elementType: 'payment'; error: StripeError}) => any
): StripePaymentElement;
off(
eventType: 'loaderror',
handler?: (event: {elementType: 'payment'; error: StripeError}) => any
): StripePaymentElement;
/**
* Updates the options the `PaymentElement` was initialized with.
* Updates are merged into the existing configuration.
*/
update(options: Partial<StripePaymentElementOptions>): StripePaymentElement;
/**
* Collapses the Payment Element into a row of payment method tabs.
*/
collapse(): StripePaymentElement;
};
export type FieldOption = 'auto' | 'never';
export interface FieldsOption {
billingDetails?:
| FieldOption
| {
name?: FieldOption;
email?: FieldOption;
phone?: FieldOption;
address?:
| FieldOption
| {
country?: FieldOption;
postalCode?: FieldOption;
state?: FieldOption;
city?: FieldOption;
line1?: FieldOption;
line2?: FieldOption;
};
};
}
export type TermOption = 'auto' | 'always' | 'never';
export interface TermsOption {
bancontact?: TermOption;
card?: TermOption;
ideal?: TermOption;
sepaDebit?: TermOption;
sofort?: TermOption;
auBecsDebit?: TermOption;
usBankAccount?: TermOption;
}
export type WalletOption = 'auto' | 'never';
export interface WalletsOption {
applePay?: WalletOption;
googlePay?: WalletOption;
}
export interface StripePaymentElementOptions {
/**
* Override the business name displayed in the Payment Element.
* By default the PaymentElement will use your Stripe account or business name.
*/
business?: {name: string};
/**
* Override the order in which payment methods are displayed in the Payment Element.
* By default, the Payment Element will use a dynamic ordering that optimizes payment method display for each user.
*/
paymentMethodOrder?: string[];
/**
* Control which fields are displayed in the Payment Element.
*/
fields?: FieldsOption;
/**
* Apply a read-only state to the Payment Element so that payment details can’t be changed.
* Default is false.
*/
readOnly?: boolean;
/**
* Control terms display in the Payment Element.
*/
terms?: TermsOption;
/**
* Control wallets display in the Payment Element.
*/
wallets?: WalletsOption;
}
export interface StripePaymentElementChangeEvent {
/**
* The type of element that emitted this event.
*/
elementType: 'payment';
/**
* `true` if the all inputs in the Payment Element are empty.
*/
empty: boolean;
/**
* `true` if the every input in the Payment Element is well-formed and potentially complete.
*/
complete: boolean;
/**
* Whether or not the Payment Element is currently collapsed.
*/
collapsed: boolean;
/**
* An object containing the currently selected PaymentMethod type (in snake_case, for example "afterpay_clearpay").
*/
value: {type: string};
}