-
Notifications
You must be signed in to change notification settings - Fork 774
/
Copy pathCharges.d.ts
2499 lines (2007 loc) · 83.6 KB
/
Charges.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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
/**
* The `Charge` object represents a single attempt to move money into your Stripe account.
* PaymentIntent confirmation is the most common way to create Charges, but transferring
* money to a different Stripe account through Connect also creates Charges.
* Some legacy payment flows create Charges directly, which is not recommended for new integrations.
*/
interface Charge {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'charge';
/**
* Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
*/
amount: number;
/**
* Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
*/
amount_captured: number;
/**
* Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
*/
amount_refunded: number;
/**
* ID of the Connect application that created the charge.
*/
application: string | Stripe.Application | null;
/**
* The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
*/
application_fee: string | Stripe.ApplicationFee | null;
/**
* The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
*/
application_fee_amount: number | null;
/**
* Authorization code on the charge.
*/
authorization_code?: string;
/**
* ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
*/
balance_transaction: string | Stripe.BalanceTransaction | null;
billing_details: Charge.BillingDetails;
/**
* The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
*/
calculated_statement_descriptor: string | null;
/**
* If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
*/
captured: boolean;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* 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).
*/
currency: string;
/**
* ID of the customer this charge is for if one exists.
*/
customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description: string | null;
/**
* Whether the charge has been disputed.
*/
disputed: boolean;
/**
* ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
*/
failure_balance_transaction: string | Stripe.BalanceTransaction | null;
/**
* Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
*/
failure_code: string | null;
/**
* Message to user further explaining reason for charge failure if available.
*/
failure_message: string | null;
/**
* Information on fraud assessments for the charge.
*/
fraud_details: Charge.FraudDetails | null;
/**
* ID of the invoice this charge is for if one exists.
*/
invoice: string | Stripe.Invoice | null;
level3?: Charge.Level3;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: Stripe.Metadata;
/**
* The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
*/
on_behalf_of: string | Stripe.Account | null;
/**
* Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
*/
outcome: Charge.Outcome | null;
/**
* `true` if the charge succeeded, or was successfully authorized for later capture.
*/
paid: boolean;
/**
* ID of the PaymentIntent associated with this charge, if one exists.
*/
payment_intent: string | Stripe.PaymentIntent | null;
/**
* ID of the payment method used in this charge.
*/
payment_method: string | null;
/**
* Details about the payment method at the time of the transaction.
*/
payment_method_details: Charge.PaymentMethodDetails | null;
/**
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
*/
radar_options?: Charge.RadarOptions;
/**
* This is the email address that the receipt for this charge was sent to.
*/
receipt_email: string | null;
/**
* This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
*/
receipt_number: string | null;
/**
* This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
*/
receipt_url: string | null;
/**
* Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
*/
refunded: boolean;
/**
* A list of refunds that have been applied to the charge.
*/
refunds?: ApiList<Stripe.Refund> | null;
/**
* ID of the review associated with this charge if one exists.
*/
review: string | Stripe.Review | null;
/**
* Shipping information for the charge.
*/
shipping: Charge.Shipping | null;
/**
* This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.
*/
source: Stripe.CustomerSource | null;
/**
* The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
*/
source_transfer: string | Stripe.Transfer | null;
/**
* For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
*
* For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
*/
statement_descriptor: string | null;
/**
* Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
*/
statement_descriptor_suffix: string | null;
/**
* The status of the payment is either `succeeded`, `pending`, or `failed`.
*/
status: Charge.Status;
/**
* ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
*/
transfer?: string | Stripe.Transfer;
/**
* An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
*/
transfer_data: Charge.TransferData | null;
/**
* A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
*/
transfer_group: string | null;
}
namespace Charge {
interface BillingDetails {
/**
* Billing address.
*/
address: Stripe.Address | null;
/**
* Email address.
*/
email: string | null;
/**
* Full name.
*/
name: string | null;
/**
* Billing phone number (including extension).
*/
phone: string | null;
}
interface FraudDetails {
/**
* Assessments from Stripe. If set, the value is `fraudulent`.
*/
stripe_report?: string;
/**
* Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
*/
user_report?: string;
}
interface Level3 {
customer_reference?: string;
line_items: Array<Level3.LineItem>;
merchant_reference: string;
shipping_address_zip?: string;
shipping_amount?: number;
shipping_from_zip?: string;
}
namespace Level3 {
interface LineItem {
discount_amount: number | null;
product_code: string;
product_description: string;
quantity: number | null;
tax_amount: number | null;
unit_cost: number | null;
}
}
interface Outcome {
/**
* An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
*/
advice_code: Outcome.AdviceCode | null;
/**
* For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
*/
network_advice_code: string | null;
/**
* For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
*/
network_decline_code: string | null;
/**
* Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
*/
network_status: string | null;
/**
* An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
*/
reason: string | null;
/**
* Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
*/
risk_level?: string;
/**
* Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
*/
risk_score?: number;
/**
* The ID of the Radar rule that matched the payment, if applicable.
*/
rule?: string | Outcome.Rule;
/**
* A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
*/
seller_message: string | null;
/**
* Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
*/
type: string;
}
namespace Outcome {
type AdviceCode =
| 'confirm_card_data'
| 'do_not_try_again'
| 'try_again_later';
interface Rule {
/**
* The action taken on the payment.
*/
action: string;
/**
* Unique identifier for the object.
*/
id: string;
/**
* The predicate to evaluate the payment against.
*/
predicate: string;
}
}
interface PaymentMethodDetails {
ach_credit_transfer?: PaymentMethodDetails.AchCreditTransfer;
ach_debit?: PaymentMethodDetails.AchDebit;
acss_debit?: PaymentMethodDetails.AcssDebit;
affirm?: PaymentMethodDetails.Affirm;
afterpay_clearpay?: PaymentMethodDetails.AfterpayClearpay;
alipay?: PaymentMethodDetails.Alipay;
alma?: PaymentMethodDetails.Alma;
amazon_pay?: PaymentMethodDetails.AmazonPay;
au_becs_debit?: PaymentMethodDetails.AuBecsDebit;
bacs_debit?: PaymentMethodDetails.BacsDebit;
bancontact?: PaymentMethodDetails.Bancontact;
blik?: PaymentMethodDetails.Blik;
boleto?: PaymentMethodDetails.Boleto;
card?: PaymentMethodDetails.Card;
card_present?: PaymentMethodDetails.CardPresent;
cashapp?: PaymentMethodDetails.Cashapp;
customer_balance?: PaymentMethodDetails.CustomerBalance;
eps?: PaymentMethodDetails.Eps;
fpx?: PaymentMethodDetails.Fpx;
giropay?: PaymentMethodDetails.Giropay;
gopay?: PaymentMethodDetails.Gopay;
grabpay?: PaymentMethodDetails.Grabpay;
id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
ideal?: PaymentMethodDetails.Ideal;
interac_present?: PaymentMethodDetails.InteracPresent;
kakao_pay?: PaymentMethodDetails.KakaoPay;
klarna?: PaymentMethodDetails.Klarna;
konbini?: PaymentMethodDetails.Konbini;
kr_card?: PaymentMethodDetails.KrCard;
link?: PaymentMethodDetails.Link;
mb_way?: PaymentMethodDetails.MbWay;
mobilepay?: PaymentMethodDetails.Mobilepay;
multibanco?: PaymentMethodDetails.Multibanco;
naver_pay?: PaymentMethodDetails.NaverPay;
oxxo?: PaymentMethodDetails.Oxxo;
p24?: PaymentMethodDetails.P24;
pay_by_bank?: PaymentMethodDetails.PayByBank;
payco?: PaymentMethodDetails.Payco;
paynow?: PaymentMethodDetails.Paynow;
paypal?: PaymentMethodDetails.Paypal;
payto?: PaymentMethodDetails.Payto;
pix?: PaymentMethodDetails.Pix;
promptpay?: PaymentMethodDetails.Promptpay;
qris?: PaymentMethodDetails.Qris;
rechnung?: PaymentMethodDetails.Rechnung;
revolut_pay?: PaymentMethodDetails.RevolutPay;
samsung_pay?: PaymentMethodDetails.SamsungPay;
sepa_credit_transfer?: PaymentMethodDetails.SepaCreditTransfer;
sepa_debit?: PaymentMethodDetails.SepaDebit;
shopeepay?: PaymentMethodDetails.Shopeepay;
sofort?: PaymentMethodDetails.Sofort;
stripe_account?: PaymentMethodDetails.StripeAccount;
swish?: PaymentMethodDetails.Swish;
twint?: PaymentMethodDetails.Twint;
/**
* The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.
* An additional hash is included on `payment_method_details` with a name matching this value.
* It contains information specific to the payment method.
*/
type: string;
us_bank_account?: PaymentMethodDetails.UsBankAccount;
wechat?: PaymentMethodDetails.Wechat;
wechat_pay?: PaymentMethodDetails.WechatPay;
zip?: PaymentMethodDetails.Zip;
}
namespace PaymentMethodDetails {
interface AchCreditTransfer {
/**
* Account number to transfer funds to.
*/
account_number: string | null;
/**
* Name of the bank associated with the routing number.
*/
bank_name: string | null;
/**
* Routing transit number for the bank account to transfer funds to.
*/
routing_number: string | null;
/**
* SWIFT code of the bank associated with the routing number.
*/
swift_code: string | null;
}
interface AchDebit {
/**
* Type of entity that holds the account. This can be either `individual` or `company`.
*/
account_holder_type: AchDebit.AccountHolderType | null;
/**
* Name of the bank associated with the bank account.
*/
bank_name: string | null;
/**
* Two-letter ISO code representing the country the bank account is located in.
*/
country: string | null;
/**
* Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
*/
fingerprint: string | null;
/**
* Last four digits of the bank account number.
*/
last4: string | null;
/**
* Routing transit number of the bank account.
*/
routing_number: string | null;
}
namespace AchDebit {
type AccountHolderType = 'company' | 'individual';
}
interface AcssDebit {
/**
* Name of the bank associated with the bank account.
*/
bank_name: string | null;
/**
* Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
*/
fingerprint: string | null;
/**
* Institution number of the bank account
*/
institution_number: string | null;
/**
* Last four digits of the bank account number.
*/
last4: string | null;
/**
* ID of the mandate used to make this payment.
*/
mandate?: string;
/**
* Transit number of the bank account.
*/
transit_number: string | null;
}
interface Affirm {
/**
* The Affirm transaction ID associated with this payment.
*/
transaction_id: string | null;
}
interface AfterpayClearpay {
/**
* The Afterpay order ID associated with this payment intent.
*/
order_id: string | null;
/**
* Order identifier shown to the merchant in Afterpay's online portal.
*/
reference: string | null;
}
interface Alipay {
/**
* Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
*/
buyer_id?: string;
/**
* Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
*/
fingerprint: string | null;
/**
* Transaction ID of this particular Alipay transaction.
*/
transaction_id: string | null;
}
interface Alma {}
interface AmazonPay {
funding?: AmazonPay.Funding;
}
namespace AmazonPay {
interface Funding {
card?: Funding.Card;
/**
* funding type of the underlying payment method.
*/
type: 'card' | null;
}
namespace Funding {
interface Card {
/**
* Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
*/
brand: string | null;
/**
* Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
*/
country: string | null;
/**
* Two-digit number representing the card's expiration month.
*/
exp_month: number | null;
/**
* Four-digit number representing the card's expiration year.
*/
exp_year: number | null;
/**
* Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
*/
funding: string | null;
/**
* The last four digits of the card.
*/
last4: string | null;
}
}
}
interface AuBecsDebit {
/**
* Bank-State-Branch number of the bank account.
*/
bsb_number: string | null;
/**
* Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
*/
fingerprint: string | null;
/**
* Last four digits of the bank account number.
*/
last4: string | null;
/**
* ID of the mandate used to make this payment.
*/
mandate?: string;
}
interface BacsDebit {
/**
* Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
*/
fingerprint: string | null;
/**
* Last four digits of the bank account number.
*/
last4: string | null;
/**
* ID of the mandate used to make this payment.
*/
mandate: string | null;
/**
* Sort code of the bank account. (e.g., `10-20-30`)
*/
sort_code: string | null;
}
interface Bancontact {
/**
* Bank code of bank associated with the bank account.
*/
bank_code: string | null;
/**
* Name of the bank associated with the bank account.
*/
bank_name: string | null;
/**
* Bank Identifier Code of the bank associated with the bank account.
*/
bic: string | null;
/**
* The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
*/
generated_sepa_debit: string | Stripe.PaymentMethod | null;
/**
* The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
*/
generated_sepa_debit_mandate: string | Stripe.Mandate | null;
/**
* Last four characters of the IBAN.
*/
iban_last4: string | null;
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
* Can be one of `en`, `de`, `fr`, or `nl`
*/
preferred_language: Bancontact.PreferredLanguage | null;
/**
* Owner's verified full name. Values are verified or provided by Bancontact directly
* (if supported) at the time of authorization or settlement. They cannot be set or mutated.
*/
verified_name: string | null;
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
interface Blik {
/**
* A unique and immutable identifier assigned by BLIK to every buyer.
*/
buyer_id: string | null;
}
interface Boleto {
/**
* The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
*/
tax_id: string;
}
interface Card {
/**
* The authorized amount.
*/
amount_authorized: number | null;
/**
* The latest amount intended to be authorized by this charge.
*/
amount_requested?: number | null;
/**
* Authorization code on the charge.
*/
authorization_code: string | null;
/**
* Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
*/
brand: string | null;
/**
* When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
*/
capture_before?: number;
/**
* Check results by Card networks on Card address and CVC at time of payment.
*/
checks: Card.Checks | null;
/**
* Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
*/
country: string | null;
decremental_authorization?: Card.DecrementalAuthorization;
/**
* A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
*/
description?: string | null;
/**
* Two-digit number representing the card's expiration month.
*/
exp_month: number;
/**
* Four-digit number representing the card's expiration year.
*/
exp_year: number;
extended_authorization?: Card.ExtendedAuthorization;
/**
* Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*
* *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
*/
fingerprint?: string | null;
/**
* Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
*/
funding: string | null;
/**
* Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
*/
iin?: string | null;
incremental_authorization?: Card.IncrementalAuthorization;
/**
* Installment details for this payment (Mexico only).
*
* For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
*/
installments: Card.Installments | null;
/**
* The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
*/
issuer?: string | null;
/**
* The last four digits of the card.
*/
last4: string | null;
/**
* ID of the mandate used to make this payment or created by it.
*/
mandate: string | null;
/**
* True if this payment was marked as MOTO and out of scope for SCA.
*/
moto?: boolean | null;
multicapture?: Card.Multicapture;
/**
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
*/
network: string | null;
/**
* If this card has network token credentials, this contains the details of the network token credentials.
*/
network_token?: Card.NetworkToken | null;
/**
* This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
*/
network_transaction_id: string | null;
overcapture?: Card.Overcapture;
partial_authorization?: Card.PartialAuthorization;
/**
* Status of a card based on the card issuer.
*/
regulated_status: Card.RegulatedStatus | null;
/**
* Populated if this transaction used 3D Secure authentication.
*/
three_d_secure: Card.ThreeDSecure | null;
/**
* If this Card is part of a card wallet, this contains the details of the card wallet.
*/
wallet: Card.Wallet | null;
}
namespace Card {
interface Checks {
/**
* If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
*/
address_line1_check: string | null;
/**
* If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
*/
address_postal_code_check: string | null;
/**
* If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
*/
cvc_check: string | null;
}
interface DecrementalAuthorization {
/**
* Indicates whether or not the decremental authorization feature is supported.
*/
status: DecrementalAuthorization.Status;
}
namespace DecrementalAuthorization {
type Status = 'available' | 'unavailable';
}
interface ExtendedAuthorization {
/**
* Indicates whether or not the capture window is extended beyond the standard authorization.
*/
status: ExtendedAuthorization.Status;
}
namespace ExtendedAuthorization {
type Status = 'disabled' | 'enabled';
}
interface IncrementalAuthorization {
/**
* Indicates whether or not the incremental authorization feature is supported.
*/
status: IncrementalAuthorization.Status;
}
namespace IncrementalAuthorization {
type Status = 'available' | 'unavailable';
}
interface Installments {
/**
* Installment plan selected for the payment.
*/
plan: Installments.Plan | null;
}
namespace Installments {
interface Plan {
/**
* For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
*/
count: number | null;