stripe 19.4.0.pre.alpha.2 → 19.4.0.pre.alpha.3

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.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_version.rb +1 -1
  3. data/lib/stripe/event_types.rb +15 -0
  4. data/lib/stripe/events/v2_billing_contract_activated_event.rb +44 -0
  5. data/lib/stripe/events/v2_billing_contract_canceled_event.rb +44 -0
  6. data/lib/stripe/events/v2_billing_contract_created_event.rb +44 -0
  7. data/lib/stripe/events/v2_billing_contract_ended_event.rb +44 -0
  8. data/lib/stripe/events/v2_billing_contract_updated_event.rb +44 -0
  9. data/lib/stripe/params/capital/financing_transaction_list_params.rb +2 -2
  10. data/lib/stripe/params/checkout/session_create_params.rb +1 -1
  11. data/lib/stripe/params/invoice_create_preview_params.rb +1 -1
  12. data/lib/stripe/params/payment_intent_confirm_params.rb +10 -1
  13. data/lib/stripe/params/payment_intent_create_params.rb +10 -1
  14. data/lib/stripe/params/payment_intent_update_params.rb +10 -1
  15. data/lib/stripe/params/promotion_code_create_params.rb +1 -1
  16. data/lib/stripe/params/promotion_code_update_params.rb +1 -1
  17. data/lib/stripe/params/subscription_schedule_create_params.rb +2 -2
  18. data/lib/stripe/params/subscription_schedule_list_params.rb +1 -1
  19. data/lib/stripe/params/subscription_schedule_update_params.rb +2 -2
  20. data/lib/stripe/params/terminal/reader_activate_gift_card_params.rb +35 -0
  21. data/lib/stripe/params/terminal/reader_cashout_gift_card_params.rb +21 -0
  22. data/lib/stripe/params/terminal/reader_check_gift_card_balance_params.rb +21 -0
  23. data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb +4 -0
  24. data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb +4 -0
  25. data/lib/stripe/params/terminal/reader_reload_gift_card_params.rb +27 -0
  26. data/lib/stripe/params/v2/billing/contract_cancel_params.rb +1 -1
  27. data/lib/stripe/params/v2/billing/contract_create_params.rb +13 -175
  28. data/lib/stripe/params/v2/billing/contract_list_params.rb +1 -1
  29. data/lib/stripe/params/v2/billing/contract_update_params.rb +48 -495
  30. data/lib/stripe/params/v2/core/account_list_params.rb +9 -1
  31. data/lib/stripe/params/v2/data/analytics/metric_query_create_params.rb +2 -2
  32. data/lib/stripe/params.rb +8 -0
  33. data/lib/stripe/resources/account.rb +55 -3
  34. data/lib/stripe/resources/bank_account.rb +2 -2
  35. data/lib/stripe/resources/billing/alert_recovered.rb +17 -1
  36. data/lib/stripe/resources/capability.rb +2 -2
  37. data/lib/stripe/resources/capital/financing_transaction.rb +1 -1
  38. data/lib/stripe/resources/charge.rb +1 -1
  39. data/lib/stripe/resources/checkout/session.rb +21 -3
  40. data/lib/stripe/resources/confirmation_token.rb +1 -1
  41. data/lib/stripe/resources/dispute.rb +4 -2
  42. data/lib/stripe/resources/financial_connections/session.rb +2 -0
  43. data/lib/stripe/resources/invoice.rb +3 -0
  44. data/lib/stripe/resources/issuing/authorization.rb +52 -1
  45. data/lib/stripe/resources/issuing/transaction.rb +47 -1
  46. data/lib/stripe/resources/payment_attempt_record.rb +2 -2
  47. data/lib/stripe/resources/payment_intent.rb +28 -0
  48. data/lib/stripe/resources/payment_method.rb +1 -1
  49. data/lib/stripe/resources/payment_record.rb +2 -2
  50. data/lib/stripe/resources/person.rb +2 -2
  51. data/lib/stripe/resources/quote.rb +22 -1
  52. data/lib/stripe/resources/quote_preview_invoice.rb +3 -0
  53. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +44 -2
  54. data/lib/stripe/resources/setup_attempt.rb +16 -0
  55. data/lib/stripe/resources/setup_intent.rb +3 -0
  56. data/lib/stripe/resources/shared_payment/granted_token.rb +1 -1
  57. data/lib/stripe/resources/subscription_schedule.rb +44 -2
  58. data/lib/stripe/resources/tax/registration.rb +32 -0
  59. data/lib/stripe/resources/terminal/reader.rb +173 -0
  60. data/lib/stripe/resources/v2/billing/contract.rb +47 -330
  61. data/lib/stripe/resources/v2/billing/contract_pricing_line_quantity_change.rb +2 -2
  62. data/lib/stripe/resources/v2/core/account.rb +18 -0
  63. data/lib/stripe/resources/v2/money_management/payout_method.rb +16 -0
  64. data/lib/stripe/resources/v2/money_management/received_credit.rb +30 -0
  65. data/lib/stripe/resources.rb +15 -0
  66. data/lib/stripe/services/account_service.rb +1 -1
  67. data/lib/stripe/services/dispute_service.rb +1 -1
  68. data/lib/stripe/services/terminal/reader_service.rb +44 -0
  69. data/lib/stripe/services/v2/billing/contract_service.rb +7 -7
  70. data/lib/stripe/stripe_event_notification_handler.rb +30 -0
  71. data/lib/stripe/version.rb +1 -1
  72. data/rbi/stripe.rbi +1039 -1148
  73. metadata +11 -2
@@ -11,11 +11,19 @@ module Stripe
11
11
  attr_accessor :closed
12
12
  # The upper limit on the number of accounts returned by the List Account request.
13
13
  attr_accessor :limit
14
+ # Filter by the network object related to the account. If omitted, returns all Accounts regardless of the network object they have.
15
+ attr_accessor :related_network_object
14
16
 
15
- def initialize(applied_configurations: nil, closed: nil, limit: nil)
17
+ def initialize(
18
+ applied_configurations: nil,
19
+ closed: nil,
20
+ limit: nil,
21
+ related_network_object: nil
22
+ )
16
23
  @applied_configurations = applied_configurations
17
24
  @closed = closed
18
25
  @limit = limit
26
+ @related_network_object = related_network_object
19
27
  end
20
28
  end
21
29
  end
@@ -7,9 +7,9 @@ module Stripe
7
7
  module Analytics
8
8
  class MetricQueryCreateParams < ::Stripe::RequestParams
9
9
  class Metric < ::Stripe::RequestParams
10
- # The ID for this metric, e.g. metric_61Sud3n5oAGVCWiSr5.
10
+ # The ID for this metric (for example, `metric_61Sud3n5oAGVCWiSr5`). For the full list of supported metrics, see [Supported metrics](https://docs.stripe.com/data/analytics/supported-metrics).
11
11
  attr_accessor :id
12
- # The common name for this metric, e.g. revenue.mrr.
12
+ # The common name for this metric (for example, `revenue.mrr`). For the full list of supported metric names, see [Supported metrics](https://docs.stripe.com/data/analytics/supported-metrics).
13
13
  attr_accessor :name
14
14
 
15
15
  def initialize(id: nil, name: nil)
data/lib/stripe/params.rb CHANGED
@@ -732,7 +732,10 @@ module Stripe
732
732
  autoload :LocationRetrieveParams, "stripe/params/terminal/location_retrieve_params"
733
733
  autoload :LocationUpdateParams, "stripe/params/terminal/location_update_params"
734
734
  autoload :OnboardingLinkCreateParams, "stripe/params/terminal/onboarding_link_create_params"
735
+ autoload :ReaderActivateGiftCardParams, "stripe/params/terminal/reader_activate_gift_card_params"
735
736
  autoload :ReaderCancelActionParams, "stripe/params/terminal/reader_cancel_action_params"
737
+ autoload :ReaderCashoutGiftCardParams, "stripe/params/terminal/reader_cashout_gift_card_params"
738
+ autoload :ReaderCheckGiftCardBalanceParams, "stripe/params/terminal/reader_check_gift_card_balance_params"
736
739
  autoload :ReaderCollectedDataRetrieveParams, "stripe/params/terminal/reader_collected_data_retrieve_params"
737
740
  autoload :ReaderCollectInputsParams, "stripe/params/terminal/reader_collect_inputs_params"
738
741
  autoload :ReaderCollectPaymentMethodParams, "stripe/params/terminal/reader_collect_payment_method_params"
@@ -744,6 +747,7 @@ module Stripe
744
747
  autoload :ReaderProcessPaymentIntentParams, "stripe/params/terminal/reader_process_payment_intent_params"
745
748
  autoload :ReaderProcessSetupIntentParams, "stripe/params/terminal/reader_process_setup_intent_params"
746
749
  autoload :ReaderRefundPaymentParams, "stripe/params/terminal/reader_refund_payment_params"
750
+ autoload :ReaderReloadGiftCardParams, "stripe/params/terminal/reader_reload_gift_card_params"
747
751
  autoload :ReaderRetrieveParams, "stripe/params/terminal/reader_retrieve_params"
748
752
  autoload :ReaderSetReaderDisplayParams, "stripe/params/terminal/reader_set_reader_display_params"
749
753
  autoload :ReaderSucceedInputCollectionParams, "stripe/params/terminal/reader_succeed_input_collection_params"
@@ -1925,7 +1929,10 @@ module Stripe
1925
1929
  stripe/params/terminal/location_retrieve_params
1926
1930
  stripe/params/terminal/location_update_params
1927
1931
  stripe/params/terminal/onboarding_link_create_params
1932
+ stripe/params/terminal/reader_activate_gift_card_params
1928
1933
  stripe/params/terminal/reader_cancel_action_params
1934
+ stripe/params/terminal/reader_cashout_gift_card_params
1935
+ stripe/params/terminal/reader_check_gift_card_balance_params
1929
1936
  stripe/params/terminal/reader_collect_inputs_params
1930
1937
  stripe/params/terminal/reader_collect_payment_method_params
1931
1938
  stripe/params/terminal/reader_collected_data_retrieve_params
@@ -1937,6 +1944,7 @@ module Stripe
1937
1944
  stripe/params/terminal/reader_process_payment_intent_params
1938
1945
  stripe/params/terminal/reader_process_setup_intent_params
1939
1946
  stripe/params/terminal/reader_refund_payment_params
1947
+ stripe/params/terminal/reader_reload_gift_card_params
1940
1948
  stripe/params/terminal/reader_retrieve_params
1941
1949
  stripe/params/terminal/reader_set_reader_display_params
1942
1950
  stripe/params/terminal/reader_succeed_input_collection_params
@@ -374,6 +374,29 @@ module Stripe
374
374
  end
375
375
  end
376
376
 
377
+ class AdministrativeAddress < ::Stripe::StripeObject
378
+ # City, district, suburb, town, or village.
379
+ attr_reader :city
380
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
381
+ attr_reader :country
382
+ # Address line 1, such as the street, PO Box, or company name.
383
+ attr_reader :line1
384
+ # Address line 2, such as the apartment, suite, unit, or building.
385
+ attr_reader :line2
386
+ # ZIP or postal code.
387
+ attr_reader :postal_code
388
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
389
+ attr_reader :state
390
+
391
+ def self.inner_class_types
392
+ @inner_class_types = {}
393
+ end
394
+
395
+ def self.field_remappings
396
+ @field_remappings = {}
397
+ end
398
+ end
399
+
377
400
  class DirectorshipDeclaration < ::Stripe::StripeObject
378
401
  # The Unix timestamp marking when the directorship declaration attestation was made.
379
402
  attr_reader :date
@@ -408,6 +431,29 @@ module Stripe
408
431
  end
409
432
  end
410
433
 
434
+ class PrincipalPlaceOfBusiness < ::Stripe::StripeObject
435
+ # City, district, suburb, town, or village.
436
+ attr_reader :city
437
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
438
+ attr_reader :country
439
+ # Address line 1, such as the street, PO Box, or company name.
440
+ attr_reader :line1
441
+ # Address line 2, such as the apartment, suite, unit, or building.
442
+ attr_reader :line2
443
+ # ZIP or postal code.
444
+ attr_reader :postal_code
445
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
446
+ attr_reader :state
447
+
448
+ def self.inner_class_types
449
+ @inner_class_types = {}
450
+ end
451
+
452
+ def self.field_remappings
453
+ @field_remappings = {}
454
+ end
455
+ end
456
+
411
457
  class RegistrationDate < ::Stripe::StripeObject
412
458
  # The day of registration, between 1 and 31.
413
459
  attr_reader :day
@@ -478,6 +524,8 @@ module Stripe
478
524
  attr_reader :address_kana
479
525
  # The Kanji variation of the company's primary address (Japan only).
480
526
  attr_reader :address_kanji
527
+ # Attribute for field administrative_address
528
+ attr_reader :administrative_address
481
529
  # Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided).
482
530
  attr_reader :directors_provided
483
531
  # This hash is used to attest that the director information provided to Stripe is both current and correct.
@@ -502,6 +550,8 @@ module Stripe
502
550
  attr_reader :ownership_exemption_reason
503
551
  # The company's phone number (used for verification).
504
552
  attr_reader :phone
553
+ # Attribute for field principal_place_of_business
554
+ attr_reader :principal_place_of_business
505
555
  # Attribute for field registration_date
506
556
  attr_reader :registration_date
507
557
  # This hash is used to attest that the representative is authorized to act as the representative of their legal entity.
@@ -522,8 +572,10 @@ module Stripe
522
572
  address: Address,
523
573
  address_kana: AddressKana,
524
574
  address_kanji: AddressKanji,
575
+ administrative_address: AdministrativeAddress,
525
576
  directorship_declaration: DirectorshipDeclaration,
526
577
  ownership_declaration: OwnershipDeclaration,
578
+ principal_place_of_business: PrincipalPlaceOfBusiness,
527
579
  registration_date: RegistrationDate,
528
580
  representative_declaration: RepresentativeDeclaration,
529
581
  verification: Verification,
@@ -676,7 +728,7 @@ module Stripe
676
728
  attr_reader :currently_due
677
729
  # This is typed as an enum for consistency with `requirements.disabled_reason`.
678
730
  attr_reader :disabled_reason
679
- # Details about validation and verification failures for `due` requirements that must be resolved.
731
+ # Fields that are `currently_due` and need to be collected again because validation or verification failed.
680
732
  attr_reader :errors
681
733
  # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
682
734
  attr_reader :eventually_due
@@ -747,7 +799,7 @@ module Stripe
747
799
  attr_reader :currently_due
748
800
  # If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
749
801
  attr_reader :disabled_reason
750
- # Details about validation and verification failures for `due` requirements that must be resolved.
802
+ # Fields that are `currently_due` and need to be collected again because validation or verification failed.
751
803
  attr_reader :errors
752
804
  # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
753
805
  attr_reader :eventually_due
@@ -1299,7 +1351,7 @@ module Stripe
1299
1351
  # With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
1300
1352
  # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
1301
1353
  #
1302
- # If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
1354
+ # If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/connect/marketplace/tasks/create#prefill-account-information) when
1303
1355
  # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
1304
1356
  # You can prefill any information on the account.
1305
1357
  def self.create(params = {}, opts = {})
@@ -38,7 +38,7 @@ module Stripe
38
38
  end
39
39
  # Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
40
40
  attr_reader :currently_due
41
- # Details about validation and verification failures for `due` requirements that must be resolved.
41
+ # Fields that are `currently_due` and need to be collected again because validation or verification failed.
42
42
  attr_reader :errors
43
43
  # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
44
44
  attr_reader :past_due
@@ -73,7 +73,7 @@ module Stripe
73
73
  end
74
74
  # Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
75
75
  attr_reader :currently_due
76
- # Details about validation and verification failures for `due` requirements that must be resolved.
76
+ # Fields that are `currently_due` and need to be collected again because validation or verification failed.
77
77
  attr_reader :errors
78
78
  # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
79
79
  attr_reader :past_due
@@ -9,6 +9,22 @@ module Stripe
9
9
  "billing.alert_recovered"
10
10
  end
11
11
 
12
+ class AggregationPeriod < ::Stripe::StripeObject
13
+ # End time of the aggregation period
14
+ attr_reader :ends_at
15
+ # Start time of the aggregation period
16
+ attr_reader :starts_at
17
+
18
+ def self.inner_class_types
19
+ @inner_class_types = {}
20
+ end
21
+
22
+ def self.field_remappings
23
+ @field_remappings = {}
24
+ end
25
+ end
26
+ # The aggregation period for which this alert recovered
27
+ attr_reader :aggregation_period
12
28
  # A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
13
29
  attr_reader :alert
14
30
  # Time at which the object was created. Measured in seconds since the Unix epoch.
@@ -29,7 +45,7 @@ module Stripe
29
45
  attr_reader :value
30
46
 
31
47
  def self.inner_class_types
32
- @inner_class_types = {}
48
+ @inner_class_types = { aggregation_period: AggregationPeriod }
33
49
  end
34
50
 
35
51
  def self.field_remappings
@@ -53,7 +53,7 @@ module Stripe
53
53
  attr_reader :currently_due
54
54
  # This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
55
55
  attr_reader :disabled_reason
56
- # Details about validation and verification failures for `due` requirements that must be resolved.
56
+ # Fields that are `currently_due` and need to be collected again because validation or verification failed.
57
57
  attr_reader :errors
58
58
  # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
59
59
  attr_reader :eventually_due
@@ -140,7 +140,7 @@ module Stripe
140
140
  attr_reader :currently_due
141
141
  # Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
142
142
  attr_reader :disabled_reason
143
- # Details about validation and verification failures for `due` requirements that must be resolved.
143
+ # Fields that are `currently_due` and need to be collected again because validation or verification failed.
144
144
  attr_reader :errors
145
145
  # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
146
146
  attr_reader :eventually_due
@@ -33,7 +33,7 @@ module Stripe
33
33
  attr_reader :currency
34
34
  # The fee amount being repaid, paid out, or reversed in minor units.
35
35
  attr_reader :fee_amount
36
- # The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
36
+ # The linked payment for the transaction. This field only applies to financing transactions of type `payment` and reason `automatic_withholding`.
37
37
  attr_reader :linked_payment
38
38
  # The reason for the financing transaction (if applicable).
39
39
  attr_reader :reason
@@ -1268,7 +1268,7 @@ module Stripe
1268
1268
  class Fpx < ::Stripe::StripeObject
1269
1269
  # Account holder type, if provided. Can be one of `individual` or `company`.
1270
1270
  attr_reader :account_holder_type
1271
- # The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
1271
+ # The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
1272
1272
  attr_reader :bank
1273
1273
  # Unique transaction id generated by FPX for every request from the merchant
1274
1274
  attr_reader :transaction_id
@@ -109,6 +109,8 @@ module Stripe
109
109
  @field_remappings = {}
110
110
  end
111
111
  end
112
+ # Controls how much address information Checkout collects when automatic tax is enabled.
113
+ attr_reader :address_collection_precision
112
114
  # Indicates whether automatic tax is enabled for the session
113
115
  attr_reader :enabled
114
116
  # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
@@ -247,11 +249,11 @@ module Stripe
247
249
  attr_reader :phone
248
250
  # Shipping information for this Checkout Session.
249
251
  attr_reader :shipping_details
250
- # Customer’s tax ids for this Checkout Session.
251
- attr_reader :tax_ids
252
+ # Customer’s tax id for this Checkout Session.
253
+ attr_reader :tax_id
252
254
 
253
255
  def self.inner_class_types
254
- @inner_class_types = { shipping_details: ShippingDetails, tax_ids: TaxId }
256
+ @inner_class_types = { shipping_details: ShippingDetails, tax_id: TaxId }
255
257
  end
256
258
 
257
259
  def self.field_remappings
@@ -1880,6 +1882,14 @@ module Stripe
1880
1882
  class Payco < ::Stripe::StripeObject
1881
1883
  # Controls when the funds will be captured from the customer's account.
1882
1884
  attr_reader :capture_method
1885
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1886
+ #
1887
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1888
+ #
1889
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1890
+ #
1891
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1892
+ attr_reader :setup_future_usage
1883
1893
 
1884
1894
  def self.inner_class_types
1885
1895
  @inner_class_types = {}
@@ -2056,6 +2066,14 @@ module Stripe
2056
2066
  class SamsungPay < ::Stripe::StripeObject
2057
2067
  # Controls when the funds will be captured from the customer's account.
2058
2068
  attr_reader :capture_method
2069
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2070
+ #
2071
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
2072
+ #
2073
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
2074
+ #
2075
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2076
+ attr_reader :setup_future_usage
2059
2077
 
2060
2078
  def self.inner_class_types
2061
2079
  @inner_class_types = {}
@@ -988,7 +988,7 @@ module Stripe
988
988
  class Fpx < ::Stripe::StripeObject
989
989
  # Account holder type, if provided. Can be one of `individual` or `company`.
990
990
  attr_reader :account_holder_type
991
- # The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
991
+ # The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
992
992
  attr_reader :bank
993
993
 
994
994
  def self.inner_class_types
@@ -345,6 +345,8 @@ module Stripe
345
345
  attr_reader :brand
346
346
  # The type of dispute opened. Different case types may have varying fees and financial impact.
347
347
  attr_reader :case_type
348
+ # 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`.
349
+ attr_reader :network
348
350
  # The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.
349
351
  attr_reader :network_reason_code
350
352
 
@@ -463,7 +465,7 @@ module Stripe
463
465
  # The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
464
466
  attr_reader :status
465
467
 
466
- # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
468
+ # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost.
467
469
  #
468
470
  # The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
469
471
  def close(params = {}, opts = {})
@@ -475,7 +477,7 @@ module Stripe
475
477
  )
476
478
  end
477
479
 
478
- # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
480
+ # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost.
479
481
  #
480
482
  # The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
481
483
  def self.close(dispute, params = {}, opts = {})
@@ -38,6 +38,8 @@ module Stripe
38
38
  attr_reader :countries
39
39
  # Stripe ID of the institution with which the customer should be directed to log in.
40
40
  attr_reader :institution
41
+ # Whether the Session should require that linked accounts support payments and retrieve account numbers before completion.
42
+ attr_reader :require_payment_method_support
41
43
 
42
44
  def self.inner_class_types
43
45
  @inner_class_types = {}
@@ -263,6 +263,9 @@ module Stripe
263
263
  attr_reader :decline_code
264
264
  # A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
265
265
  attr_reader :doc_url
266
+ # A GiftCardOperation represents an operation performed on a third-party gift card,
267
+ # such as activation, reload, cashout, balance check, or void.
268
+ attr_reader :gift_card_operation
266
269
  # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
267
270
  attr_reader :message
268
271
  # 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.
@@ -551,8 +551,12 @@ module Stripe
551
551
  end
552
552
 
553
553
  class NetworkData < ::Stripe::StripeObject
554
+ # Country code of the acquirer assigned by the card network.
555
+ attr_reader :acquiring_institution_country
554
556
  # Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.
555
557
  attr_reader :acquiring_institution_id
558
+ # Identifier assigned by the acquirer to track all messages related to this transaction.
559
+ attr_reader :retrieval_reference_number
556
560
  # The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.
557
561
  attr_reader :system_trace_audit_number
558
562
  # Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
@@ -634,6 +638,35 @@ module Stripe
634
638
  @field_remappings = {}
635
639
  end
636
640
  end
641
+
642
+ class NetworkData < ::Stripe::StripeObject
643
+ class TraceId < ::Stripe::StripeObject
644
+ # The unique reference number within the specified financial network on the specified network date.
645
+ attr_reader :banknet_reference_number
646
+ # The identifier of the program or service.
647
+ attr_reader :financial_network_code
648
+ # The card network's record date for this authorization.
649
+ attr_reader :network_date
650
+
651
+ def self.inner_class_types
652
+ @inner_class_types = {}
653
+ end
654
+
655
+ def self.field_remappings
656
+ @field_remappings = {}
657
+ end
658
+ end
659
+ # Mastercard identifier for each authorization request.
660
+ attr_reader :trace_id
661
+
662
+ def self.inner_class_types
663
+ @inner_class_types = { trace_id: TraceId }
664
+ end
665
+
666
+ def self.field_remappings
667
+ @field_remappings = {}
668
+ end
669
+ end
637
670
  # The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.
638
671
  attr_reader :amount
639
672
  # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
@@ -650,6 +683,8 @@ module Stripe
650
683
  attr_reader :merchant_amount
651
684
  # The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
652
685
  attr_reader :merchant_currency
686
+ # Details about the authorization request, such as identifiers, set by the card network.
687
+ attr_reader :network_data
653
688
  # The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
654
689
  attr_reader :network_risk_score
655
690
  # When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
@@ -660,7 +695,20 @@ module Stripe
660
695
  attr_reader :requested_at
661
696
 
662
697
  def self.inner_class_types
663
- @inner_class_types = { amount_details: AmountDetails }
698
+ @inner_class_types = { amount_details: AmountDetails, network_data: NetworkData }
699
+ end
700
+
701
+ def self.field_remappings
702
+ @field_remappings = {}
703
+ end
704
+ end
705
+
706
+ class TerminalData < ::Stripe::StripeObject
707
+ # The method used to confirm the cardholder's identity.
708
+ attr_reader :cardholder_verification_result
709
+
710
+ def self.inner_class_types
711
+ @inner_class_types = {}
664
712
  end
665
713
 
666
714
  def self.field_remappings
@@ -922,6 +970,8 @@ module Stripe
922
970
  attr_reader :request_history
923
971
  # The current status of the authorization in its lifecycle.
924
972
  attr_reader :status
973
+ # Details about the cardholder verification outcome at the terminal.
974
+ attr_reader :terminal_data
925
975
  # [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.
926
976
  attr_reader :token
927
977
  # Attribute for field token_details
@@ -1168,6 +1218,7 @@ module Stripe
1168
1218
  pending_request: PendingRequest,
1169
1219
  redaction: Redaction,
1170
1220
  request_history: RequestHistory,
1221
+ terminal_data: TerminalData,
1171
1222
  token_details: TokenDetails,
1172
1223
  treasury: Treasury,
1173
1224
  verification_data: VerificationData,
@@ -185,17 +185,43 @@ module Stripe
185
185
  end
186
186
 
187
187
  class NetworkData < ::Stripe::StripeObject
188
+ class TraceId < ::Stripe::StripeObject
189
+ # The unique reference number within the specified financial network on the specified network date.
190
+ attr_reader :banknet_reference_number
191
+ # The identifier of the program or service.
192
+ attr_reader :financial_network_code
193
+ # The card network's record date for this transaction.
194
+ attr_reader :network_date
195
+
196
+ def self.inner_class_types
197
+ @inner_class_types = {}
198
+ end
199
+
200
+ def self.field_remappings
201
+ @field_remappings = {}
202
+ end
203
+ end
188
204
  # The network-provided acquirer reference number for this transaction, if available. Use this value for downstream operational workflows such as filing disputes with the card network.
189
205
  attr_reader :acquirer_reference_number
206
+ # The two-letter country code of the acquirer ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
207
+ attr_reader :acquiring_institution_country
208
+ # Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be null.
209
+ attr_reader :acquiring_institution_id
190
210
  # A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
191
211
  attr_reader :authorization_code
192
212
  # The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
193
213
  attr_reader :processing_date
214
+ # Identifier assigned by the acquirer to track all messages related to this transaction.
215
+ attr_reader :retrieval_reference_number
216
+ # The card network over which Stripe received the transaction. This field may differ from the associated card’s primary network.
217
+ attr_reader :routed_network
218
+ # Attribute for field trace_id
219
+ attr_reader :trace_id
194
220
  # Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
195
221
  attr_reader :transaction_id
196
222
 
197
223
  def self.inner_class_types
198
- @inner_class_types = {}
224
+ @inner_class_types = { trace_id: TraceId }
199
225
  end
200
226
 
201
227
  def self.field_remappings
@@ -524,6 +550,23 @@ module Stripe
524
550
  end
525
551
  end
526
552
 
553
+ class SettlementDetails < ::Stripe::StripeObject
554
+ # `merchant_amount` in the settlement currency.
555
+ attr_reader :amount
556
+ # Settlement currency.
557
+ attr_reader :currency
558
+ # Exchange rate used by the network to convert the `merchant_amount` to `settlement_details.amount`. The `merchant_amount` multiplied with this rate will equal to the `settlement_details.amount`.
559
+ attr_reader :exchange_rate
560
+
561
+ def self.inner_class_types
562
+ @inner_class_types = {}
563
+ end
564
+
565
+ def self.field_remappings
566
+ @field_remappings = {}
567
+ end
568
+ end
569
+
527
570
  class Treasury < ::Stripe::StripeObject
528
571
  # The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund
529
572
  attr_reader :received_credit
@@ -582,6 +625,8 @@ module Stripe
582
625
  attr_reader :redaction
583
626
  # The ID of the [settlement](https://docs.stripe.com/api/issuing/settlements) to which this transaction belongs.
584
627
  attr_reader :settlement
628
+ # Details about the transaction for settlement reconciliation.
629
+ attr_reader :settlement_details
585
630
  # [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
586
631
  attr_reader :token
587
632
  # [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
@@ -670,6 +715,7 @@ module Stripe
670
715
  network_data: NetworkData,
671
716
  purchase_details: PurchaseDetails,
672
717
  redaction: Redaction,
718
+ settlement_details: SettlementDetails,
673
719
  treasury: Treasury,
674
720
  }
675
721
  end
@@ -285,7 +285,7 @@ module Stripe
285
285
  class AmazonPay < ::Stripe::StripeObject
286
286
  class Funding < ::Stripe::StripeObject
287
287
  class Card < ::Stripe::StripeObject
288
- # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
288
+ # Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
289
289
  attr_reader :brand
290
290
  # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
291
291
  attr_reader :brand_product
@@ -932,7 +932,7 @@ module Stripe
932
932
  class Fpx < ::Stripe::StripeObject
933
933
  # Account holder type, if provided. Can be one of `individual` or `company`.
934
934
  attr_reader :account_holder_type
935
- # The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
935
+ # The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
936
936
  attr_reader :bank
937
937
  # Unique transaction id generated by FPX for every request from the merchant
938
938
  attr_reader :transaction_id