stripe 17.3.0.pre.alpha.2 → 18.1.0.pre.alpha.1

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 (83) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_version.rb +1 -1
  3. data/lib/stripe/object_types.rb +2 -0
  4. data/lib/stripe/params/account_create_params.rb +27 -10
  5. data/lib/stripe/params/account_person_create_params.rb +9 -9
  6. data/lib/stripe/params/account_person_update_params.rb +9 -9
  7. data/lib/stripe/params/account_update_params.rb +27 -10
  8. data/lib/stripe/params/balance_transfer_create_params.rb +66 -0
  9. data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +2 -2
  10. data/lib/stripe/params/charge_capture_params.rb +941 -2
  11. data/lib/stripe/params/charge_update_params.rb +941 -2
  12. data/lib/stripe/params/checkout/session_create_params.rb +3 -3
  13. data/lib/stripe/params/customer_balance_transaction_list_params.rb +21 -1
  14. data/lib/stripe/params/customer_session_create_params.rb +1 -1
  15. data/lib/stripe/params/invoice_create_preview_params.rb +28 -1
  16. data/lib/stripe/params/invoice_payment_list_params.rb +22 -0
  17. data/lib/stripe/params/issuing/authorization_create_params.rb +16 -1
  18. data/lib/stripe/params/order_create_params.rb +938 -1
  19. data/lib/stripe/params/order_update_params.rb +938 -1
  20. data/lib/stripe/params/payment_intent_capture_params.rb +962 -13
  21. data/lib/stripe/params/payment_intent_confirm_params.rb +2017 -123
  22. data/lib/stripe/params/payment_intent_create_params.rb +2017 -123
  23. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +29 -13
  24. data/lib/stripe/params/payment_intent_update_params.rb +2017 -123
  25. data/lib/stripe/params/payment_method_list_params.rb +8 -0
  26. data/lib/stripe/params/quote_create_params.rb +18 -18
  27. data/lib/stripe/params/quote_update_params.rb +18 -18
  28. data/lib/stripe/params/radar/account_evaluation_create_params.rb +81 -0
  29. data/lib/stripe/params/radar/account_evaluation_retrieve_params.rb +15 -0
  30. data/lib/stripe/params/radar/account_evaluation_update_params.rb +18 -0
  31. data/lib/stripe/params/setup_intent_confirm_params.rb +3 -3
  32. data/lib/stripe/params/setup_intent_create_params.rb +3 -3
  33. data/lib/stripe/params/setup_intent_update_params.rb +3 -3
  34. data/lib/stripe/params/subscription_schedule_amend_params.rb +28 -1
  35. data/lib/stripe/params/tax/registration_create_params.rb +1 -1
  36. data/lib/stripe/params/terminal/configuration_create_params.rb +9 -9
  37. data/lib/stripe/params/terminal/configuration_update_params.rb +9 -9
  38. data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +16 -1
  39. data/lib/stripe/params/token_create_params.rb +18 -18
  40. data/lib/stripe/params/transfer_create_params.rb +5 -5
  41. data/lib/stripe/params.rb +4 -0
  42. data/lib/stripe/resources/account.rb +19 -1
  43. data/lib/stripe/resources/application_fee.rb +2 -2
  44. data/lib/stripe/resources/balance_transfer.rb +139 -0
  45. data/lib/stripe/resources/bank_account.rb +2 -2
  46. data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +2 -2
  47. data/lib/stripe/resources/billing_portal/configuration.rb +2 -0
  48. data/lib/stripe/resources/capital/financing_offer.rb +6 -6
  49. data/lib/stripe/resources/capital/financing_summary.rb +7 -7
  50. data/lib/stripe/resources/charge.rb +5 -3
  51. data/lib/stripe/resources/checkout/session.rb +3 -3
  52. data/lib/stripe/resources/confirmation_token.rb +1 -1
  53. data/lib/stripe/resources/delegated_checkout/requested_session.rb +50 -50
  54. data/lib/stripe/resources/financial_connections/account.rb +22 -0
  55. data/lib/stripe/resources/invoice.rb +1 -1
  56. data/lib/stripe/resources/issuing/card.rb +18 -0
  57. data/lib/stripe/resources/mandate.rb +3 -3
  58. data/lib/stripe/resources/payment_attempt_record.rb +8 -6
  59. data/lib/stripe/resources/payment_intent.rb +38 -26
  60. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +13 -7
  61. data/lib/stripe/resources/payment_method.rb +1 -1
  62. data/lib/stripe/resources/payment_record.rb +8 -6
  63. data/lib/stripe/resources/person.rb +36 -36
  64. data/lib/stripe/resources/quote.rb +27 -27
  65. data/lib/stripe/resources/quote_preview_invoice.rb +1 -1
  66. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +9 -9
  67. data/lib/stripe/resources/radar/account_evaluation.rb +116 -0
  68. data/lib/stripe/resources/refund.rb +31 -0
  69. data/lib/stripe/resources/setup_attempt.rb +1 -1
  70. data/lib/stripe/resources/setup_intent.rb +3 -3
  71. data/lib/stripe/resources/subscription.rb +9 -9
  72. data/lib/stripe/resources/subscription_schedule.rb +9 -9
  73. data/lib/stripe/resources/transfer.rb +4 -4
  74. data/lib/stripe/resources.rb +2 -0
  75. data/lib/stripe/services/balance_transfer_service.rb +17 -0
  76. data/lib/stripe/services/radar/account_evaluation_service.rb +41 -0
  77. data/lib/stripe/services/radar_service.rb +2 -1
  78. data/lib/stripe/services/v1_services.rb +2 -1
  79. data/lib/stripe/services.rb +2 -0
  80. data/lib/stripe/util.rb +2 -5
  81. data/lib/stripe/version.rb +1 -1
  82. data/rbi/stripe.rbi +17737 -652
  83. metadata +10 -2
@@ -164,10 +164,10 @@ module Stripe
164
164
  end
165
165
 
166
166
  class OrderDetails < ::Stripe::StripeObject
167
- # The URL to the order status.
168
- attr_reader :order_status_url
169
167
  # The seller's order identifier.
170
168
  attr_reader :order_id
169
+ # The URL to the order status.
170
+ attr_reader :order_status_url
171
171
 
172
172
  def self.inner_class_types
173
173
  @inner_class_types = {}
@@ -178,51 +178,6 @@ module Stripe
178
178
  end
179
179
  end
180
180
 
181
- class SellerDetails < ::Stripe::StripeObject
182
- def self.inner_class_types
183
- @inner_class_types = {}
184
- end
185
-
186
- def self.field_remappings
187
- @field_remappings = {}
188
- end
189
- end
190
-
191
- class TotalDetails < ::Stripe::StripeObject
192
- class ApplicableFee < ::Stripe::StripeObject
193
- # The amount of the applicable fee.
194
- attr_reader :amount
195
- # The description of the applicable fee.
196
- attr_reader :description
197
- # The display name of the applicable fee.
198
- attr_reader :display_name
199
-
200
- def self.inner_class_types
201
- @inner_class_types = {}
202
- end
203
-
204
- def self.field_remappings
205
- @field_remappings = {}
206
- end
207
- end
208
- # The amount discount of the total details.
209
- attr_reader :amount_discount
210
- # The amount fulfillment of the total details.
211
- attr_reader :amount_fulfillment
212
- # The amount tax of the total details.
213
- attr_reader :amount_tax
214
- # The applicable fees of the total details.
215
- attr_reader :applicable_fees
216
-
217
- def self.inner_class_types
218
- @inner_class_types = { applicable_fees: ApplicableFee }
219
- end
220
-
221
- def self.field_remappings
222
- @field_remappings = {}
223
- end
224
- end
225
-
226
181
  class PaymentMethodPreview < ::Stripe::StripeObject
227
182
  class BillingDetails < ::Stripe::StripeObject
228
183
  class Address < ::Stripe::StripeObject
@@ -296,6 +251,51 @@ module Stripe
296
251
  @field_remappings = {}
297
252
  end
298
253
  end
254
+
255
+ class SellerDetails < ::Stripe::StripeObject
256
+ def self.inner_class_types
257
+ @inner_class_types = {}
258
+ end
259
+
260
+ def self.field_remappings
261
+ @field_remappings = {}
262
+ end
263
+ end
264
+
265
+ class TotalDetails < ::Stripe::StripeObject
266
+ class ApplicableFee < ::Stripe::StripeObject
267
+ # The amount of the applicable fee.
268
+ attr_reader :amount
269
+ # The description of the applicable fee.
270
+ attr_reader :description
271
+ # The display name of the applicable fee.
272
+ attr_reader :display_name
273
+
274
+ def self.inner_class_types
275
+ @inner_class_types = {}
276
+ end
277
+
278
+ def self.field_remappings
279
+ @field_remappings = {}
280
+ end
281
+ end
282
+ # The amount discount of the total details.
283
+ attr_reader :amount_discount
284
+ # The amount fulfillment of the total details.
285
+ attr_reader :amount_fulfillment
286
+ # The amount tax of the total details.
287
+ attr_reader :amount_tax
288
+ # The applicable fees of the total details.
289
+ attr_reader :applicable_fees
290
+
291
+ def self.inner_class_types
292
+ @inner_class_types = { applicable_fees: ApplicableFee }
293
+ end
294
+
295
+ def self.field_remappings
296
+ @field_remappings = {}
297
+ end
298
+ end
299
299
  # The subtotal amount of the requested session.
300
300
  attr_reader :amount_subtotal
301
301
  # The total amount of the requested session.
@@ -324,6 +324,8 @@ module Stripe
324
324
  attr_reader :order_details
325
325
  # The payment method used for the requested session.
326
326
  attr_reader :payment_method
327
+ # The preview of the payment method to be created when the requested session is confirmed.
328
+ attr_reader :payment_method_preview
327
329
  # Attribute for field seller_details
328
330
  attr_reader :seller_details
329
331
  # Whether or not the payment method should be saved for future use.
@@ -338,8 +340,6 @@ module Stripe
338
340
  attr_reader :total_details
339
341
  # Time at which the object was last updated. Measured in seconds since the Unix epoch.
340
342
  attr_reader :updated_at
341
- # The preview of the payment method to be created when the requested session is confirmed.
342
- attr_reader :payment_method_preview
343
343
 
344
344
  # Confirms a requested session
345
345
  def confirm(params = {}, opts = {})
@@ -406,9 +406,9 @@ module Stripe
406
406
  fulfillment_details: FulfillmentDetails,
407
407
  line_item_details: LineItemDetail,
408
408
  order_details: OrderDetails,
409
+ payment_method_preview: PaymentMethodPreview,
409
410
  seller_details: SellerDetails,
410
411
  total_details: TotalDetails,
411
- payment_method_preview: PaymentMethodPreview,
412
412
  }
413
413
  end
414
414
 
@@ -34,6 +34,25 @@ module Stripe
34
34
  end
35
35
  end
36
36
 
37
+ class AccountNumber < ::Stripe::StripeObject
38
+ # When the account number is expected to expire, if applicable.
39
+ attr_reader :expected_expiry_date
40
+ # The type of account number associated with the account.
41
+ attr_reader :identifier_type
42
+ # Whether the account number is currently active and usable for transactions.
43
+ attr_reader :status
44
+ # The payment networks that the account number can be used for.
45
+ attr_reader :supported_networks
46
+
47
+ def self.inner_class_types
48
+ @inner_class_types = {}
49
+ end
50
+
51
+ def self.field_remappings
52
+ @field_remappings = {}
53
+ end
54
+ end
55
+
37
56
  class Balance < ::Stripe::StripeObject
38
57
  class Cash < ::Stripe::StripeObject
39
58
  # The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.
@@ -163,6 +182,8 @@ module Stripe
163
182
  end
164
183
  # The account holder that this account belongs to.
165
184
  attr_reader :account_holder
185
+ # Details about the account numbers.
186
+ attr_reader :account_numbers
166
187
  # The most recent information about the account's balance.
167
188
  attr_reader :balance
168
189
  # The state of the most recent attempt to refresh the account balance.
@@ -330,6 +351,7 @@ module Stripe
330
351
  def self.inner_class_types
331
352
  @inner_class_types = {
332
353
  account_holder: AccountHolder,
354
+ account_numbers: AccountNumber,
333
355
  balance: Balance,
334
356
  balance_refresh: BalanceRefresh,
335
357
  inferred_balances_refresh: InferredBalancesRefresh,
@@ -997,7 +997,7 @@ module Stripe
997
997
  # * `subscription_cycle`: A subscription advanced into a new period.
998
998
  # * `subscription_threshold`: A subscription reached a billing threshold.
999
999
  # * `subscription_update`: A subscription was updated.
1000
- # * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.
1000
+ # * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription.
1001
1001
  attr_reader :billing_reason
1002
1002
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
1003
1003
  attr_reader :collection_method
@@ -14,6 +14,21 @@ module Stripe
14
14
  "issuing.card"
15
15
  end
16
16
 
17
+ class LatestFraudWarning < ::Stripe::StripeObject
18
+ # Timestamp of the most recent fraud warning.
19
+ attr_reader :started_at
20
+ # The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card.
21
+ attr_reader :type
22
+
23
+ def self.inner_class_types
24
+ @inner_class_types = {}
25
+ end
26
+
27
+ def self.field_remappings
28
+ @field_remappings = {}
29
+ end
30
+ end
31
+
17
32
  class Shipping < ::Stripe::StripeObject
18
33
  class Address < ::Stripe::StripeObject
19
34
  # City, district, suburb, town, or village.
@@ -237,6 +252,8 @@ module Stripe
237
252
  attr_reader :id
238
253
  # The last 4 digits of the card number.
239
254
  attr_reader :last4
255
+ # Stripe’s assessment of whether this card’s details have been compromised. If this property isn't null, cancel and reissue the card to prevent fraudulent activity risk.
256
+ attr_reader :latest_fraud_warning
240
257
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
241
258
  attr_reader :livemode
242
259
  # 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.
@@ -399,6 +416,7 @@ module Stripe
399
416
 
400
417
  def self.inner_class_types
401
418
  @inner_class_types = {
419
+ latest_fraud_warning: LatestFraudWarning,
402
420
  shipping: Shipping,
403
421
  spending_controls: SpendingControls,
404
422
  wallets: Wallets,
@@ -234,15 +234,15 @@ module Stripe
234
234
  class Payto < ::Stripe::StripeObject
235
235
  # Amount that will be collected. It is required when `amount_type` is `fixed`.
236
236
  attr_reader :amount
237
- # 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.
237
+ # 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. Defaults to `maximum`.
238
238
  attr_reader :amount_type
239
239
  # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
240
240
  attr_reader :end_date
241
- # The periodicity at which payments will be collected.
241
+ # The periodicity at which payments will be collected. Defaults to `adhoc`.
242
242
  attr_reader :payment_schedule
243
243
  # 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.
244
244
  attr_reader :payments_per_period
245
- # The purpose for which payments are made. Defaults to retail.
245
+ # The purpose for which payments are made. Has a default value based on your merchant category code.
246
246
  attr_reader :purpose
247
247
  # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
248
248
  attr_reader :start_date
@@ -897,7 +897,7 @@ module Stripe
897
897
  end
898
898
 
899
899
  class Ideal < ::Stripe::StripeObject
900
- # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
900
+ # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
901
901
  attr_reader :bank
902
902
  # The Bank Identifier Code of the customer's bank.
903
903
  attr_reader :bic
@@ -907,6 +907,8 @@ module Stripe
907
907
  attr_reader :generated_sepa_debit_mandate
908
908
  # Last four characters of the IBAN.
909
909
  attr_reader :iban_last4
910
+ # Unique transaction ID generated by iDEAL.
911
+ attr_reader :transaction_id
910
912
  # Owner's verified full name. Values are verified or provided by iDEAL directly
911
913
  # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
912
914
  attr_reader :verified_name
@@ -1681,9 +1683,9 @@ module Stripe
1681
1683
  end
1682
1684
 
1683
1685
  class UsBankAccount < ::Stripe::StripeObject
1684
- # Attribute for field account_holder_type
1686
+ # The type of entity that holds the account. This can be either 'individual' or 'company'.
1685
1687
  attr_reader :account_holder_type
1686
- # Attribute for field account_type
1688
+ # The type of the bank account. This can be either 'checking' or 'savings'.
1687
1689
  attr_reader :account_type
1688
1690
  # Name of the bank associated with the bank account.
1689
1691
  attr_reader :bank_name
@@ -1693,9 +1695,9 @@ module Stripe
1693
1695
  attr_reader :last4
1694
1696
  # ID of the mandate used to make this payment.
1695
1697
  attr_reader :mandate
1696
- # Reference number to locate ACH payments with customer’s bank.
1698
+ # The ACH payment reference for this transaction.
1697
1699
  attr_reader :payment_reference
1698
- # Routing number of the bank account.
1700
+ # The routing number for the bank account.
1699
1701
  attr_reader :routing_number
1700
1702
 
1701
1703
  def self.inner_class_types
@@ -1877,7 +1879,7 @@ module Stripe
1877
1879
  # An additional hash is included on `payment_method_details` with a name matching this value.
1878
1880
  # It contains information specific to the payment method.
1879
1881
  attr_reader :type
1880
- # Details of the US Bank Account used for this payment attempt.
1882
+ # Attribute for field us_bank_account
1881
1883
  attr_reader :us_bank_account
1882
1884
  # Attribute for field wechat
1883
1885
  attr_reader :wechat
@@ -27,13 +27,26 @@ module Stripe
27
27
 
28
28
  nested_resource_class_methods :amount_details_line_item, operations: %i[list]
29
29
 
30
+ class AllocatedFunds < ::Stripe::StripeObject
31
+ # Allocated Funds configuration for this PaymentIntent.
32
+ attr_reader :enabled
33
+
34
+ def self.inner_class_types
35
+ @inner_class_types = {}
36
+ end
37
+
38
+ def self.field_remappings
39
+ @field_remappings = {}
40
+ end
41
+ end
42
+
30
43
  class AmountDetails < ::Stripe::StripeObject
31
44
  class Shipping < ::Stripe::StripeObject
32
- # Portion of the amount that is for shipping.
45
+ # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0.
33
46
  attr_reader :amount
34
- # The postal code that represents the shipping source.
47
+ # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.
35
48
  attr_reader :from_postal_code
36
- # The postal code that represents the shipping destination.
49
+ # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed.
37
50
  attr_reader :to_postal_code
38
51
 
39
52
  def self.inner_class_types
@@ -46,7 +59,9 @@ module Stripe
46
59
  end
47
60
 
48
61
  class Tax < ::Stripe::StripeObject
49
- # Total portion of the amount that is for tax.
62
+ # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
63
+ #
64
+ # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
50
65
  attr_reader :total_tax_amount
51
66
 
52
67
  def self.inner_class_types
@@ -70,7 +85,9 @@ module Stripe
70
85
  @field_remappings = {}
71
86
  end
72
87
  end
73
- # The total discount applied on the transaction.
88
+ # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
89
+ #
90
+ # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.
74
91
  attr_reader :discount_amount
75
92
  # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
76
93
  attr_reader :line_items
@@ -1541,11 +1558,17 @@ module Stripe
1541
1558
  attr_reader :benefit
1542
1559
  # Attribute for field car_rental
1543
1560
  attr_reader :car_rental
1544
- # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
1561
+ # A unique value to identify the customer. This field is available only for card payments.
1562
+ #
1563
+ # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
1545
1564
  attr_reader :customer_reference
1546
1565
  # Attribute for field event_details
1547
1566
  attr_reader :event_details
1548
- # A unique value assigned by the business to identify the transaction.
1567
+ # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
1568
+ #
1569
+ # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
1570
+ #
1571
+ # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
1549
1572
  attr_reader :order_reference
1550
1573
  # Attribute for field subscription
1551
1574
  attr_reader :subscription
@@ -2038,6 +2061,8 @@ module Stripe
2038
2061
  @field_remappings = {}
2039
2062
  end
2040
2063
  end
2064
+ # Controls when the funds will be captured from the customer's account.
2065
+ attr_reader :capture_method
2041
2066
  # Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
2042
2067
  attr_reader :request_extended_authorization
2043
2068
  # Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
@@ -2677,15 +2702,15 @@ module Stripe
2677
2702
  class MandateOptions < ::Stripe::StripeObject
2678
2703
  # Amount that will be collected. It is required when `amount_type` is `fixed`.
2679
2704
  attr_reader :amount
2680
- # 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.
2705
+ # 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. Defaults to `maximum`.
2681
2706
  attr_reader :amount_type
2682
2707
  # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
2683
2708
  attr_reader :end_date
2684
- # The periodicity at which payments will be collected.
2709
+ # The periodicity at which payments will be collected. Defaults to `adhoc`.
2685
2710
  attr_reader :payment_schedule
2686
2711
  # 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.
2687
2712
  attr_reader :payments_per_period
2688
- # The purpose for which payments are made. Defaults to retail.
2713
+ # The purpose for which payments are made. Has a default value based on your merchant category code.
2689
2714
  attr_reader :purpose
2690
2715
 
2691
2716
  def self.inner_class_types
@@ -3434,19 +3459,8 @@ module Stripe
3434
3459
  @field_remappings = {}
3435
3460
  end
3436
3461
  end
3437
-
3438
- class AllocatedFunds < ::Stripe::StripeObject
3439
- # Allocated Funds configuration for this PaymentIntent.
3440
- attr_reader :enabled
3441
-
3442
- def self.inner_class_types
3443
- @inner_class_types = {}
3444
- end
3445
-
3446
- def self.field_remappings
3447
- @field_remappings = {}
3448
- end
3449
- end
3462
+ # Allocated Funds configuration for this PaymentIntent.
3463
+ attr_reader :allocated_funds
3450
3464
  # Amount intended to be collected by this PaymentIntent. 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).
3451
3465
  attr_reader :amount
3452
3466
  # Amount that can be captured from this PaymentIntent.
@@ -3559,8 +3573,6 @@ module Stripe
3559
3573
  attr_reader :transfer_data
3560
3574
  # A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
3561
3575
  attr_reader :transfer_group
3562
- # Allocated Funds configuration for this PaymentIntent.
3563
- attr_reader :allocated_funds
3564
3576
 
3565
3577
  # Manually reconcile the remaining amount for a customer_balance PaymentIntent.
3566
3578
  def apply_customer_balance(params = {}, opts = {})
@@ -3922,6 +3934,7 @@ module Stripe
3922
3934
 
3923
3935
  def self.inner_class_types
3924
3936
  @inner_class_types = {
3937
+ allocated_funds: AllocatedFunds,
3925
3938
  amount_details: AmountDetails,
3926
3939
  automatic_payment_methods: AutomaticPaymentMethods,
3927
3940
  hooks: Hooks,
@@ -3934,7 +3947,6 @@ module Stripe
3934
3947
  processing: Processing,
3935
3948
  shipping: Shipping,
3936
3949
  transfer_data: TransferData,
3937
- allocated_funds: AllocatedFunds,
3938
3950
  }
3939
3951
  end
3940
3952
 
@@ -89,7 +89,9 @@ module Stripe
89
89
  end
90
90
 
91
91
  class Tax < ::Stripe::StripeObject
92
- # Total portion of the amount that is for tax.
92
+ # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
93
+ #
94
+ # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
93
95
  attr_reader :total_tax_amount
94
96
 
95
97
  def self.inner_class_types
@@ -100,7 +102,9 @@ module Stripe
100
102
  @field_remappings = {}
101
103
  end
102
104
  end
103
- # The amount an item was discounted for. Positive integer.
105
+ # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
106
+ #
107
+ # This field is mutually exclusive with the `amount_details[discount_amount]` field.
104
108
  attr_reader :discount_amount
105
109
  # Unique identifier for the object.
106
110
  attr_reader :id
@@ -108,17 +112,19 @@ module Stripe
108
112
  attr_reader :object
109
113
  # Payment method-specific information for line items.
110
114
  attr_reader :payment_method_options
111
- # Unique identifier of the product. At most 12 characters long.
115
+ # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.
112
116
  attr_reader :product_code
113
- # Name of the product. At most 100 characters long.
117
+ # The product name of the line item. Required for L3 rates. At most 1024 characters long.
118
+ #
119
+ # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters.
114
120
  attr_reader :product_name
115
- # Number of items of the product. Positive integer.
121
+ # The quantity of items. Required for L3 rates. An integer greater than 0.
116
122
  attr_reader :quantity
117
123
  # Contains information about the tax on the item.
118
124
  attr_reader :tax
119
- # Cost of the product. Non-negative integer.
125
+ # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
120
126
  attr_reader :unit_cost
121
- # A unit of measure for the line item, such as gallons, feet, meters, etc.
127
+ # A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long.
122
128
  attr_reader :unit_of_measure
123
129
 
124
130
  def self.inner_class_types
@@ -927,7 +927,7 @@ module Stripe
927
927
  end
928
928
 
929
929
  class Ideal < ::Stripe::StripeObject
930
- # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
930
+ # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
931
931
  attr_reader :bank
932
932
  # The Bank Identifier Code of the customer's bank, if the bank was provided.
933
933
  attr_reader :bic
@@ -895,7 +895,7 @@ module Stripe
895
895
  end
896
896
 
897
897
  class Ideal < ::Stripe::StripeObject
898
- # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
898
+ # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
899
899
  attr_reader :bank
900
900
  # The Bank Identifier Code of the customer's bank.
901
901
  attr_reader :bic
@@ -905,6 +905,8 @@ module Stripe
905
905
  attr_reader :generated_sepa_debit_mandate
906
906
  # Last four characters of the IBAN.
907
907
  attr_reader :iban_last4
908
+ # Unique transaction ID generated by iDEAL.
909
+ attr_reader :transaction_id
908
910
  # Owner's verified full name. Values are verified or provided by iDEAL directly
909
911
  # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
910
912
  attr_reader :verified_name
@@ -1679,9 +1681,9 @@ module Stripe
1679
1681
  end
1680
1682
 
1681
1683
  class UsBankAccount < ::Stripe::StripeObject
1682
- # Attribute for field account_holder_type
1684
+ # The type of entity that holds the account. This can be either 'individual' or 'company'.
1683
1685
  attr_reader :account_holder_type
1684
- # Attribute for field account_type
1686
+ # The type of the bank account. This can be either 'checking' or 'savings'.
1685
1687
  attr_reader :account_type
1686
1688
  # Name of the bank associated with the bank account.
1687
1689
  attr_reader :bank_name
@@ -1691,9 +1693,9 @@ module Stripe
1691
1693
  attr_reader :last4
1692
1694
  # ID of the mandate used to make this payment.
1693
1695
  attr_reader :mandate
1694
- # Reference number to locate ACH payments with customer’s bank.
1696
+ # The ACH payment reference for this transaction.
1695
1697
  attr_reader :payment_reference
1696
- # Routing number of the bank account.
1698
+ # The routing number for the bank account.
1697
1699
  attr_reader :routing_number
1698
1700
 
1699
1701
  def self.inner_class_types
@@ -1875,7 +1877,7 @@ module Stripe
1875
1877
  # An additional hash is included on `payment_method_details` with a name matching this value.
1876
1878
  # It contains information specific to the payment method.
1877
1879
  attr_reader :type
1878
- # Details of the US Bank Account used for this payment attempt.
1880
+ # Attribute for field us_bank_account
1879
1881
  attr_reader :us_bank_account
1880
1882
  # Attribute for field wechat
1881
1883
  attr_reader :wechat
@@ -292,6 +292,36 @@ module Stripe
292
292
  end
293
293
  end
294
294
 
295
+ class SelfReportedIncome < ::Stripe::StripeObject
296
+ # Amount in the minor currency unit (e.g., cents for USD)
297
+ attr_reader :amount
298
+ # 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).
299
+ attr_reader :currency
300
+
301
+ def self.inner_class_types
302
+ @inner_class_types = {}
303
+ end
304
+
305
+ def self.field_remappings
306
+ @field_remappings = {}
307
+ end
308
+ end
309
+
310
+ class SelfReportedMonthlyHousingPayment < ::Stripe::StripeObject
311
+ # Amount in the minor currency unit (e.g., cents for USD)
312
+ attr_reader :amount
313
+ # 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).
314
+ attr_reader :currency
315
+
316
+ def self.inner_class_types
317
+ @inner_class_types = {}
318
+ end
319
+
320
+ def self.field_remappings
321
+ @field_remappings = {}
322
+ end
323
+ end
324
+
295
325
  class UsCfpbData < ::Stripe::StripeObject
296
326
  class EthnicityDetails < ::Stripe::StripeObject
297
327
  # The persons ethnicity
@@ -395,36 +425,6 @@ module Stripe
395
425
  @field_remappings = {}
396
426
  end
397
427
  end
398
-
399
- class SelfReportedIncome < ::Stripe::StripeObject
400
- # Amount in the minor currency unit (e.g., cents for USD)
401
- attr_reader :amount
402
- # 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).
403
- attr_reader :currency
404
-
405
- def self.inner_class_types
406
- @inner_class_types = {}
407
- end
408
-
409
- def self.field_remappings
410
- @field_remappings = {}
411
- end
412
- end
413
-
414
- class SelfReportedMonthlyHousingPayment < ::Stripe::StripeObject
415
- # Amount in the minor currency unit (e.g., cents for USD)
416
- attr_reader :amount
417
- # 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).
418
- attr_reader :currency
419
-
420
- def self.inner_class_types
421
- @inner_class_types = {}
422
- end
423
-
424
- def self.field_remappings
425
- @field_remappings = {}
426
- end
427
- end
428
428
  # The account the person is associated with.
429
429
  attr_reader :account
430
430
  # Attribute for field additional_tos_acceptances
@@ -483,16 +483,16 @@ module Stripe
483
483
  attr_reader :relationship
484
484
  # Information about the requirements for this person, including what information needs to be collected, and by when.
485
485
  attr_reader :requirements
486
+ # Attribute for field self_reported_income
487
+ attr_reader :self_reported_income
488
+ # Attribute for field self_reported_monthly_housing_payment
489
+ attr_reader :self_reported_monthly_housing_payment
486
490
  # Whether the last four digits of the person's Social Security number have been provided (U.S. only).
487
491
  attr_reader :ssn_last_4_provided
488
492
  # Demographic data related to the person.
489
493
  attr_reader :us_cfpb_data
490
494
  # Attribute for field verification
491
495
  attr_reader :verification
492
- # Attribute for field self_reported_income
493
- attr_reader :self_reported_income
494
- # Attribute for field self_reported_monthly_housing_payment
495
- attr_reader :self_reported_monthly_housing_payment
496
496
  # Always true for a deleted object
497
497
  attr_reader :deleted
498
498
 
@@ -528,10 +528,10 @@ module Stripe
528
528
  registered_address: RegisteredAddress,
529
529
  relationship: Relationship,
530
530
  requirements: Requirements,
531
- us_cfpb_data: UsCfpbData,
532
- verification: Verification,
533
531
  self_reported_income: SelfReportedIncome,
534
532
  self_reported_monthly_housing_payment: SelfReportedMonthlyHousingPayment,
533
+ us_cfpb_data: UsCfpbData,
534
+ verification: Verification,
535
535
  }
536
536
  end
537
537