stripe 17.4.0 → 17.5.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1000 -109
- package/README.md +4 -4
- package/VERSION +1 -1
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/Capital/FinancingSummary.js +12 -0
- package/cjs/resources/Capital/FinancingTransactions.js +17 -0
- package/cjs/resources/FinancialConnections/Accounts.js +5 -0
- package/cjs/resources/FinancialConnections/Institutions.js +17 -0
- package/cjs/resources/GiftCards/Cards.js +23 -0
- package/cjs/resources/GiftCards/Transactions.js +33 -0
- package/cjs/resources/Invoices.js +17 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
- package/cjs/resources/Margins.js +22 -0
- package/cjs/resources/Orders.js +24 -0
- package/cjs/resources/PaymentAttemptRecords.js +17 -0
- package/cjs/resources/PaymentIntents.js +8 -0
- package/cjs/resources/PaymentRecords.js +29 -0
- package/cjs/resources/Quotes.js +32 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Tax/Associations.js +9 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
- package/cjs/resources/Terminal/Readers.js +12 -0
- package/cjs/resources.js +48 -10
- package/cjs/stripe.core.js +1 -1
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/Capital/FinancingOffers.js +18 -0
- package/esm/resources/Capital/FinancingSummary.js +9 -0
- package/esm/resources/Capital/FinancingTransactions.js +14 -0
- package/esm/resources/FinancialConnections/Accounts.js +5 -0
- package/esm/resources/FinancialConnections/Institutions.js +14 -0
- package/esm/resources/GiftCards/Cards.js +20 -0
- package/esm/resources/GiftCards/Transactions.js +30 -0
- package/esm/resources/Invoices.js +17 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
- package/esm/resources/Margins.js +19 -0
- package/esm/resources/Orders.js +21 -0
- package/esm/resources/PaymentAttemptRecords.js +14 -0
- package/esm/resources/PaymentIntents.js +8 -0
- package/esm/resources/PaymentRecords.js +26 -0
- package/esm/resources/Quotes.js +32 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Tax/Associations.js +6 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
- package/esm/resources/Terminal/Readers.js +12 -0
- package/esm/resources.js +33 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +5 -1
- package/types/AccountNotices.d.ts +113 -0
- package/types/AccountNoticesResource.d.ts +98 -0
- package/types/AccountSessions.d.ts +50 -5
- package/types/AccountSessionsResource.d.ts +360 -5
- package/types/Accounts.d.ts +191 -2
- package/types/AccountsResource.d.ts +522 -2
- package/types/BalanceTransactions.d.ts +3 -1
- package/types/BalanceTransactionsResource.d.ts +1 -1
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +2 -2
- package/types/Billing/CreditGrantsResource.d.ts +8 -8
- package/types/Billing/MeterErrorReports.d.ts +106 -0
- package/types/Billing/MeterEventAdjustmentsResource.d.ts +1 -1
- package/types/Billing/MeterEvents.d.ts +1 -2
- package/types/Billing/MeterEventsResource.d.ts +2 -2
- package/types/Billing/Meters.d.ts +1 -1
- package/types/Billing/MetersResource.d.ts +8 -8
- package/types/BillingPortal/Configurations.d.ts +1 -1
- package/types/Capabilities.d.ts +1 -1
- package/types/Capital/FinancingOffers.d.ts +188 -0
- package/types/Capital/FinancingOffersResource.d.ts +97 -0
- package/types/Capital/FinancingSummary.d.ts +106 -0
- package/types/Capital/FinancingSummaryResource.d.ts +27 -0
- package/types/Capital/FinancingTransactions.d.ts +135 -0
- package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
- package/types/Charges.d.ts +244 -2
- package/types/ChargesResource.d.ts +1294 -0
- package/types/Checkout/Sessions.d.ts +333 -6
- package/types/Checkout/SessionsResource.d.ts +460 -8
- package/types/ConfirmationTokens.d.ts +99 -0
- package/types/Coupons.d.ts +1 -1
- package/types/CouponsResource.d.ts +1 -1
- package/types/CreditNotes.d.ts +21 -0
- package/types/CreditNotesResource.d.ts +51 -0
- package/types/CustomersResource.d.ts +8 -1
- package/types/EventTypes.d.ts +598 -2
- package/types/Events.d.ts +93 -0
- package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
- package/types/FinancialConnections/Accounts.d.ts +29 -1
- package/types/FinancialConnections/AccountsResource.d.ts +35 -3
- package/types/FinancialConnections/Institutions.d.ts +93 -0
- package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
- package/types/FinancialConnections/Sessions.d.ts +49 -1
- package/types/FinancialConnections/SessionsResource.d.ts +38 -1
- package/types/FundingInstructions.d.ts +21 -0
- package/types/GiftCards/Cards.d.ts +118 -0
- package/types/GiftCards/CardsResource.d.ts +159 -0
- package/types/GiftCards/Transactions.d.ts +129 -0
- package/types/GiftCards/TransactionsResource.d.ts +201 -0
- package/types/InvoiceItems.d.ts +5 -0
- package/types/InvoiceItemsResource.d.ts +98 -0
- package/types/InvoiceLineItems.d.ts +28 -1
- package/types/InvoicePayments.d.ts +113 -0
- package/types/Invoices.d.ts +156 -2
- package/types/InvoicesResource.d.ts +5537 -1852
- package/types/Issuing/Authorizations.d.ts +1 -1
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
- package/types/Issuing/DisputeSettlementDetails.d.ts +73 -0
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
- package/types/Issuing/Settlements.d.ts +103 -0
- package/types/Issuing/Transactions.d.ts +2 -0
- package/types/Issuing/TransactionsResource.d.ts +5 -0
- package/types/LineItems.d.ts +33 -1
- package/types/Mandates.d.ts +77 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1160 -0
- package/types/OrdersResource.d.ts +2923 -0
- package/types/PaymentAttemptRecords.d.ts +242 -0
- package/types/PaymentAttemptRecordsResource.d.ts +47 -0
- package/types/PaymentIntents.d.ts +688 -4
- package/types/PaymentIntentsResource.d.ts +7994 -3677
- package/types/PaymentLinks.d.ts +6 -0
- package/types/PaymentLinksResource.d.ts +23 -2
- package/types/PaymentMethodConfigurations.d.ts +180 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
- package/types/PaymentMethods.d.ts +99 -0
- package/types/PaymentMethodsResource.d.ts +133 -0
- package/types/PaymentRecords.d.ts +259 -0
- package/types/PaymentRecordsResource.d.ts +455 -0
- package/types/Prices.d.ts +22 -0
- package/types/PricesResource.d.ts +22 -0
- package/types/Products.d.ts +39 -0
- package/types/ProductsResource.d.ts +36 -0
- package/types/QuoteLines.d.ts +634 -0
- package/types/QuotePreviewInvoices.d.ts +1634 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +824 -0
- package/types/Quotes.d.ts +591 -1
- package/types/QuotesResource.d.ts +2526 -194
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +48 -0
- package/types/SetupIntents.d.ts +133 -3
- package/types/SetupIntentsResource.d.ts +681 -9
- package/types/Sources.d.ts +23 -0
- package/types/SubscriptionItems.d.ts +21 -0
- package/types/SubscriptionItemsResource.d.ts +109 -0
- package/types/SubscriptionSchedules.d.ts +210 -0
- package/types/SubscriptionSchedulesResource.d.ts +1234 -16
- package/types/Subscriptions.d.ts +96 -1
- package/types/SubscriptionsResource.d.ts +372 -5
- package/types/Tax/Associations.d.ts +126 -0
- package/types/Tax/AssociationsResource.d.ts +29 -0
- package/types/Tax/Forms.d.ts +220 -0
- package/types/Tax/FormsResource.d.ts +107 -0
- package/types/Terminal/LocationsResource.d.ts +1 -1
- package/types/Terminal/ReaderCollectedData.d.ts +51 -0
- package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
- package/types/Terminal/Readers.d.ts +278 -0
- package/types/Terminal/ReadersResource.d.ts +215 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +104 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
- package/types/Treasury/FinancialAccountFeatures.d.ts +10 -3
- package/types/Treasury/FinancialAccounts.d.ts +5 -0
- package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
- package/types/Treasury/OutboundTransfers.d.ts +26 -0
- package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
- package/types/Treasury/ReceivedCredits.d.ts +26 -0
- package/types/Treasury/ReceivedDebits.d.ts +31 -0
- package/types/WebhookEndpointsResource.d.ts +70 -0
- package/types/index.d.ts +62 -0
package/types/Refunds.d.ts
CHANGED
|
@@ -139,6 +139,8 @@ declare module 'stripe' {
|
|
|
139
139
|
|
|
140
140
|
grabpay?: DestinationDetails.Grabpay;
|
|
141
141
|
|
|
142
|
+
id_bank_transfer?: DestinationDetails.IdBankTransfer;
|
|
143
|
+
|
|
142
144
|
jp_bank_transfer?: DestinationDetails.JpBankTransfer;
|
|
143
145
|
|
|
144
146
|
klarna?: DestinationDetails.Klarna;
|
|
@@ -277,6 +279,18 @@ declare module 'stripe' {
|
|
|
277
279
|
|
|
278
280
|
interface Grabpay {}
|
|
279
281
|
|
|
282
|
+
interface IdBankTransfer {
|
|
283
|
+
/**
|
|
284
|
+
* The reference assigned to the refund.
|
|
285
|
+
*/
|
|
286
|
+
reference: string | null;
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
|
|
290
|
+
*/
|
|
291
|
+
reference_status: string | null;
|
|
292
|
+
}
|
|
293
|
+
|
|
280
294
|
interface JpBankTransfer {
|
|
281
295
|
/**
|
|
282
296
|
* The reference assigned to the refund.
|
package/types/SetupAttempts.d.ts
CHANGED
|
@@ -108,6 +108,8 @@ declare module 'stripe' {
|
|
|
108
108
|
|
|
109
109
|
cashapp?: PaymentMethodDetails.Cashapp;
|
|
110
110
|
|
|
111
|
+
id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
|
|
112
|
+
|
|
111
113
|
ideal?: PaymentMethodDetails.Ideal;
|
|
112
114
|
|
|
113
115
|
kakao_pay?: PaymentMethodDetails.KakaoPay;
|
|
@@ -120,6 +122,8 @@ declare module 'stripe' {
|
|
|
120
122
|
|
|
121
123
|
paypal?: PaymentMethodDetails.Paypal;
|
|
122
124
|
|
|
125
|
+
payto?: PaymentMethodDetails.Payto;
|
|
126
|
+
|
|
123
127
|
revolut_pay?: PaymentMethodDetails.RevolutPay;
|
|
124
128
|
|
|
125
129
|
sepa_debit?: PaymentMethodDetails.SepaDebit;
|
|
@@ -394,6 +398,32 @@ declare module 'stripe' {
|
|
|
394
398
|
|
|
395
399
|
interface Cashapp {}
|
|
396
400
|
|
|
401
|
+
interface IdBankTransfer {
|
|
402
|
+
/**
|
|
403
|
+
* Bank where the account is located.
|
|
404
|
+
*/
|
|
405
|
+
bank: IdBankTransfer.Bank | null;
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* Local bank code of the bank.
|
|
409
|
+
*/
|
|
410
|
+
bank_code: string | null;
|
|
411
|
+
|
|
412
|
+
/**
|
|
413
|
+
* Name of the bank associated with the bank account.
|
|
414
|
+
*/
|
|
415
|
+
bank_name: string | null;
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
|
|
419
|
+
*/
|
|
420
|
+
display_name: string | null;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
namespace IdBankTransfer {
|
|
424
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
425
|
+
}
|
|
426
|
+
|
|
397
427
|
interface Ideal {
|
|
398
428
|
/**
|
|
399
429
|
* The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
|
|
@@ -476,6 +506,8 @@ declare module 'stripe' {
|
|
|
476
506
|
|
|
477
507
|
interface Paypal {}
|
|
478
508
|
|
|
509
|
+
interface Payto {}
|
|
510
|
+
|
|
479
511
|
interface RevolutPay {}
|
|
480
512
|
|
|
481
513
|
interface SepaDebit {}
|
|
@@ -557,6 +589,16 @@ declare module 'stripe' {
|
|
|
557
589
|
*/
|
|
558
590
|
message?: string;
|
|
559
591
|
|
|
592
|
+
/**
|
|
593
|
+
* For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
|
|
594
|
+
*/
|
|
595
|
+
network_advice_code?: string;
|
|
596
|
+
|
|
597
|
+
/**
|
|
598
|
+
* For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
|
|
599
|
+
*/
|
|
600
|
+
network_decline_code?: string;
|
|
601
|
+
|
|
560
602
|
/**
|
|
561
603
|
* If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
|
|
562
604
|
*/
|
|
@@ -679,11 +721,15 @@ declare module 'stripe' {
|
|
|
679
721
|
| 'email_invalid'
|
|
680
722
|
| 'expired_card'
|
|
681
723
|
| 'financial_connections_account_inactive'
|
|
724
|
+
| 'financial_connections_institution_unavailable'
|
|
682
725
|
| 'financial_connections_no_successful_transaction_refresh'
|
|
683
726
|
| 'forwarding_api_inactive'
|
|
684
727
|
| 'forwarding_api_invalid_parameter'
|
|
685
728
|
| 'forwarding_api_upstream_connection_error'
|
|
686
729
|
| 'forwarding_api_upstream_connection_timeout'
|
|
730
|
+
| 'gift_card_balance_insufficient'
|
|
731
|
+
| 'gift_card_code_exists'
|
|
732
|
+
| 'gift_card_inactive'
|
|
687
733
|
| 'idempotency_key_in_use'
|
|
688
734
|
| 'incorrect_address'
|
|
689
735
|
| 'incorrect_cvc'
|
|
@@ -773,6 +819,7 @@ declare module 'stripe' {
|
|
|
773
819
|
| 'return_intent_already_processed'
|
|
774
820
|
| 'routing_number_invalid'
|
|
775
821
|
| 'secret_key_required'
|
|
822
|
+
| 'sensitive_data_access_expired'
|
|
776
823
|
| 'sepa_unsupported_account'
|
|
777
824
|
| 'setup_attempt_failed'
|
|
778
825
|
| 'setup_intent_authentication_failure'
|
|
@@ -790,6 +837,7 @@ declare module 'stripe' {
|
|
|
790
837
|
| 'taxes_calculation_failed'
|
|
791
838
|
| 'terminal_location_country_unsupported'
|
|
792
839
|
| 'terminal_reader_busy'
|
|
840
|
+
| 'terminal_reader_collected_data_invalid'
|
|
793
841
|
| 'terminal_reader_hardware_fault'
|
|
794
842
|
| 'terminal_reader_invalid_location_for_activation'
|
|
795
843
|
| 'terminal_reader_invalid_location_for_payment'
|
package/types/SetupIntents.d.ts
CHANGED
|
@@ -214,6 +214,16 @@ declare module 'stripe' {
|
|
|
214
214
|
*/
|
|
215
215
|
message?: string;
|
|
216
216
|
|
|
217
|
+
/**
|
|
218
|
+
* For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
|
|
219
|
+
*/
|
|
220
|
+
network_advice_code?: string;
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
|
|
224
|
+
*/
|
|
225
|
+
network_decline_code?: string;
|
|
226
|
+
|
|
217
227
|
/**
|
|
218
228
|
* If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
|
|
219
229
|
*/
|
|
@@ -336,11 +346,15 @@ declare module 'stripe' {
|
|
|
336
346
|
| 'email_invalid'
|
|
337
347
|
| 'expired_card'
|
|
338
348
|
| 'financial_connections_account_inactive'
|
|
349
|
+
| 'financial_connections_institution_unavailable'
|
|
339
350
|
| 'financial_connections_no_successful_transaction_refresh'
|
|
340
351
|
| 'forwarding_api_inactive'
|
|
341
352
|
| 'forwarding_api_invalid_parameter'
|
|
342
353
|
| 'forwarding_api_upstream_connection_error'
|
|
343
354
|
| 'forwarding_api_upstream_connection_timeout'
|
|
355
|
+
| 'gift_card_balance_insufficient'
|
|
356
|
+
| 'gift_card_code_exists'
|
|
357
|
+
| 'gift_card_inactive'
|
|
344
358
|
| 'idempotency_key_in_use'
|
|
345
359
|
| 'incorrect_address'
|
|
346
360
|
| 'incorrect_cvc'
|
|
@@ -430,6 +444,7 @@ declare module 'stripe' {
|
|
|
430
444
|
| 'return_intent_already_processed'
|
|
431
445
|
| 'routing_number_invalid'
|
|
432
446
|
| 'secret_key_required'
|
|
447
|
+
| 'sensitive_data_access_expired'
|
|
433
448
|
| 'sepa_unsupported_account'
|
|
434
449
|
| 'setup_attempt_failed'
|
|
435
450
|
| 'setup_intent_authentication_failure'
|
|
@@ -447,6 +462,7 @@ declare module 'stripe' {
|
|
|
447
462
|
| 'taxes_calculation_failed'
|
|
448
463
|
| 'terminal_location_country_unsupported'
|
|
449
464
|
| 'terminal_reader_busy'
|
|
465
|
+
| 'terminal_reader_collected_data_invalid'
|
|
450
466
|
| 'terminal_reader_hardware_fault'
|
|
451
467
|
| 'terminal_reader_invalid_location_for_activation'
|
|
452
468
|
| 'terminal_reader_invalid_location_for_payment'
|
|
@@ -583,6 +599,8 @@ declare module 'stripe' {
|
|
|
583
599
|
|
|
584
600
|
paypal?: PaymentMethodOptions.Paypal;
|
|
585
601
|
|
|
602
|
+
payto?: PaymentMethodOptions.Payto;
|
|
603
|
+
|
|
586
604
|
sepa_debit?: PaymentMethodOptions.SepaDebit;
|
|
587
605
|
|
|
588
606
|
us_bank_account?: PaymentMethodOptions.UsBankAccount;
|
|
@@ -651,7 +669,12 @@ declare module 'stripe' {
|
|
|
651
669
|
}
|
|
652
670
|
|
|
653
671
|
namespace BacsDebit {
|
|
654
|
-
interface MandateOptions {
|
|
672
|
+
interface MandateOptions {
|
|
673
|
+
/**
|
|
674
|
+
* Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
|
|
675
|
+
*/
|
|
676
|
+
reference_prefix?: string;
|
|
677
|
+
}
|
|
655
678
|
}
|
|
656
679
|
|
|
657
680
|
interface Card {
|
|
@@ -763,6 +786,86 @@ declare module 'stripe' {
|
|
|
763
786
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
764
787
|
*/
|
|
765
788
|
billing_agreement_id: string | null;
|
|
789
|
+
|
|
790
|
+
/**
|
|
791
|
+
* 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).
|
|
792
|
+
*/
|
|
793
|
+
currency?: string | null;
|
|
794
|
+
|
|
795
|
+
/**
|
|
796
|
+
* The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
|
797
|
+
*/
|
|
798
|
+
subsellers?: Array<string>;
|
|
799
|
+
}
|
|
800
|
+
|
|
801
|
+
interface Payto {
|
|
802
|
+
mandate_options?: Payto.MandateOptions;
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
namespace Payto {
|
|
806
|
+
interface MandateOptions {
|
|
807
|
+
/**
|
|
808
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
809
|
+
*/
|
|
810
|
+
amount: number | null;
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
814
|
+
*/
|
|
815
|
+
amount_type: MandateOptions.AmountType | null;
|
|
816
|
+
|
|
817
|
+
/**
|
|
818
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
819
|
+
*/
|
|
820
|
+
end_date: string | null;
|
|
821
|
+
|
|
822
|
+
/**
|
|
823
|
+
* The periodicity at which payments will be collected.
|
|
824
|
+
*/
|
|
825
|
+
payment_schedule: MandateOptions.PaymentSchedule | null;
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
829
|
+
*/
|
|
830
|
+
payments_per_period: number | null;
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
834
|
+
*/
|
|
835
|
+
purpose: MandateOptions.Purpose | null;
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
839
|
+
*/
|
|
840
|
+
start_date: string | null;
|
|
841
|
+
}
|
|
842
|
+
|
|
843
|
+
namespace MandateOptions {
|
|
844
|
+
type AmountType = 'fixed' | 'maximum';
|
|
845
|
+
|
|
846
|
+
type PaymentSchedule =
|
|
847
|
+
| 'adhoc'
|
|
848
|
+
| 'annual'
|
|
849
|
+
| 'daily'
|
|
850
|
+
| 'fortnightly'
|
|
851
|
+
| 'monthly'
|
|
852
|
+
| 'quarterly'
|
|
853
|
+
| 'semi_annual'
|
|
854
|
+
| 'weekly';
|
|
855
|
+
|
|
856
|
+
type Purpose =
|
|
857
|
+
| 'dependant_support'
|
|
858
|
+
| 'government'
|
|
859
|
+
| 'loan'
|
|
860
|
+
| 'mortgage'
|
|
861
|
+
| 'other'
|
|
862
|
+
| 'pension'
|
|
863
|
+
| 'personal'
|
|
864
|
+
| 'retail'
|
|
865
|
+
| 'salary'
|
|
866
|
+
| 'tax'
|
|
867
|
+
| 'utility';
|
|
868
|
+
}
|
|
766
869
|
}
|
|
767
870
|
|
|
768
871
|
interface SepaDebit {
|
|
@@ -770,7 +873,12 @@ declare module 'stripe' {
|
|
|
770
873
|
}
|
|
771
874
|
|
|
772
875
|
namespace SepaDebit {
|
|
773
|
-
interface MandateOptions {
|
|
876
|
+
interface MandateOptions {
|
|
877
|
+
/**
|
|
878
|
+
* Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
|
|
879
|
+
*/
|
|
880
|
+
reference_prefix?: string;
|
|
881
|
+
}
|
|
774
882
|
}
|
|
775
883
|
|
|
776
884
|
interface UsBankAccount {
|
|
@@ -788,6 +896,8 @@ declare module 'stripe' {
|
|
|
788
896
|
interface FinancialConnections {
|
|
789
897
|
filters?: FinancialConnections.Filters;
|
|
790
898
|
|
|
899
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
900
|
+
|
|
791
901
|
/**
|
|
792
902
|
* The list of permissions to request. The `payment_method` permission must be included.
|
|
793
903
|
*/
|
|
@@ -810,19 +920,39 @@ declare module 'stripe' {
|
|
|
810
920
|
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
811
921
|
*/
|
|
812
922
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
923
|
+
|
|
924
|
+
/**
|
|
925
|
+
* The institution to use to filter for possible accounts to link.
|
|
926
|
+
*/
|
|
927
|
+
institution?: string;
|
|
813
928
|
}
|
|
814
929
|
|
|
815
930
|
namespace Filters {
|
|
816
931
|
type AccountSubcategory = 'checking' | 'savings';
|
|
817
932
|
}
|
|
818
933
|
|
|
934
|
+
interface ManualEntry {
|
|
935
|
+
/**
|
|
936
|
+
* Settings for configuring manual entry of account details.
|
|
937
|
+
*/
|
|
938
|
+
mode?: ManualEntry.Mode;
|
|
939
|
+
}
|
|
940
|
+
|
|
941
|
+
namespace ManualEntry {
|
|
942
|
+
type Mode = 'automatic' | 'custom';
|
|
943
|
+
}
|
|
944
|
+
|
|
819
945
|
type Permission =
|
|
820
946
|
| 'balances'
|
|
821
947
|
| 'ownership'
|
|
822
948
|
| 'payment_method'
|
|
823
949
|
| 'transactions';
|
|
824
950
|
|
|
825
|
-
type Prefetch =
|
|
951
|
+
type Prefetch =
|
|
952
|
+
| 'balances'
|
|
953
|
+
| 'inferred_balances'
|
|
954
|
+
| 'ownership'
|
|
955
|
+
| 'transactions';
|
|
826
956
|
}
|
|
827
957
|
|
|
828
958
|
interface MandateOptions {
|