stripe 19.2.0.pre.beta.2 → 19.3.0.pre.beta.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.
- checksums.yaml +4 -4
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/events/unknown_event_notification.rb +1 -0
- data/lib/stripe/params/account_create_params.rb +26 -0
- data/lib/stripe/params/account_update_params.rb +26 -0
- data/lib/stripe/params/balance_settings_update_params.rb +42 -2
- data/lib/stripe/params/charge_create_params.rb +4 -1
- data/lib/stripe/params/checkout/session_create_params.rb +28 -15
- data/lib/stripe/params/confirmation_token_create_params.rb +11 -1
- data/lib/stripe/params/invoice_create_preview_params.rb +4 -0
- data/lib/stripe/params/payment_intent_capture_params.rb +2 -2
- data/lib/stripe/params/payment_intent_confirm_params.rb +38 -5
- data/lib/stripe/params/payment_intent_create_params.rb +65 -6
- data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +2 -2
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +2 -2
- data/lib/stripe/params/payment_intent_update_params.rb +58 -5
- data/lib/stripe/params/payment_link_create_params.rb +30 -1
- data/lib/stripe/params/payment_link_update_params.rb +29 -0
- data/lib/stripe/params/payment_method_configuration_create_params.rb +43 -1
- data/lib/stripe/params/payment_method_configuration_list_params.rb +4 -0
- data/lib/stripe/params/payment_method_configuration_update_params.rb +43 -1
- data/lib/stripe/params/payment_method_create_params.rb +11 -1
- data/lib/stripe/params/payout_create_params.rb +1 -1
- data/lib/stripe/params/setup_intent_confirm_params.rb +18 -2
- data/lib/stripe/params/setup_intent_create_params.rb +18 -2
- data/lib/stripe/params/setup_intent_update_params.rb +18 -2
- data/lib/stripe/params/subscription_create_params.rb +5 -11
- data/lib/stripe/params/subscription_item_create_params.rb +1 -7
- data/lib/stripe/params/subscription_item_delete_params.rb +1 -7
- data/lib/stripe/params/subscription_item_update_params.rb +1 -7
- data/lib/stripe/params/subscription_pause_params.rb +50 -0
- data/lib/stripe/params/subscription_resume_params.rb +4 -0
- data/lib/stripe/params/subscription_schedule_create_params.rb +4 -0
- data/lib/stripe/params/subscription_schedule_update_params.rb +4 -0
- data/lib/stripe/params/subscription_update_params.rb +6 -8
- data/lib/stripe/params/terminal/configuration_create_params.rb +52 -0
- data/lib/stripe/params/terminal/configuration_update_params.rb +52 -0
- data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +11 -1
- data/lib/stripe/params/test_helpers/test_clock_create_params.rb +4 -1
- data/lib/stripe/params/v2/core/account_create_params.rb +28 -6
- data/lib/stripe/params/v2/core/account_token_create_params.rb +27 -5
- data/lib/stripe/params/v2/core/account_update_params.rb +29 -7
- data/lib/stripe/params/v2/iam/activity_log_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +1 -0
- data/lib/stripe/params.rb +1768 -795
- data/lib/stripe/railtie.rb +8 -0
- data/lib/stripe/resources/account.rb +4 -0
- data/lib/stripe/resources/balance_settings.rb +42 -2
- data/lib/stripe/resources/charge.rb +35 -0
- data/lib/stripe/resources/checkout/session.rb +23 -7
- data/lib/stripe/resources/confirmation_token.rb +26 -0
- data/lib/stripe/resources/discount.rb +2 -2
- data/lib/stripe/resources/invoice.rb +2 -0
- data/lib/stripe/resources/invoice_item.rb +34 -1
- data/lib/stripe/resources/issuing/dispute.rb +1 -1
- data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
- data/lib/stripe/resources/issuing/settlement.rb +1 -1
- data/lib/stripe/resources/mandate.rb +13 -0
- data/lib/stripe/resources/payment_attempt_record.rb +40 -10
- data/lib/stripe/resources/payment_intent.rb +71 -5
- data/lib/stripe/resources/payment_link.rb +40 -0
- data/lib/stripe/resources/payment_method.rb +26 -0
- data/lib/stripe/resources/payment_method_configuration.rb +68 -0
- data/lib/stripe/resources/payment_record.rb +40 -10
- data/lib/stripe/resources/product_catalog/trial_offer.rb +5 -2
- data/lib/stripe/resources/quote_preview_invoice.rb +2 -0
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +2 -0
- data/lib/stripe/resources/radar/payment_evaluation.rb +1 -1
- data/lib/stripe/resources/refund.rb +13 -0
- data/lib/stripe/resources/setup_attempt.rb +13 -0
- data/lib/stripe/resources/setup_intent.rb +26 -0
- data/lib/stripe/resources/shared_payment/granted_token.rb +26 -0
- data/lib/stripe/resources/subscription.rb +74 -4
- data/lib/stripe/resources/subscription_schedule.rb +2 -0
- data/lib/stripe/resources/terminal/configuration.rb +64 -0
- data/lib/stripe/resources/terminal/reader.rb +116 -0
- data/lib/stripe/resources/v2/commerce/product_catalog_import.rb +1 -1
- data/lib/stripe/resources/v2/core/account.rb +37 -10
- data/lib/stripe/resources/v2/core/account_token.rb +1 -1
- data/lib/stripe/resources/v2/core/batch_job.rb +2 -6
- data/lib/stripe/resources/v2/core/event.rb +1 -0
- data/lib/stripe/resources/v2/core/event_notification.rb +1 -0
- data/lib/stripe/resources/v2/network/business_profile.rb +3 -3
- data/lib/stripe/resources.rb +917 -301
- data/lib/stripe/services/account_service.rb +6 -6
- data/lib/stripe/services/coupon_service.rb +14 -0
- data/lib/stripe/services/credit_note_service.rb +0 -14
- data/lib/stripe/services/customer_service.rb +6 -6
- data/lib/stripe/services/invoice_service.rb +0 -30
- data/lib/stripe/services/payment_intent_service.rb +3 -1
- data/lib/stripe/services/promotion_code_service.rb +11 -11
- data/lib/stripe/services/subscription_schedule_service.rb +0 -44
- data/lib/stripe/services/subscription_service.rb +40 -14
- data/lib/stripe/services/v2/core/account_service.rb +1 -1
- data/lib/stripe/services/v2/core/account_token_service.rb +5 -1
- data/lib/stripe/services/v2/core/event_service.rb +2 -1
- data/lib/stripe/services/v2/{datum_service.rb → data_service.rb} +1 -1
- data/lib/stripe/services/v2/iam/activity_log_service.rb +11 -0
- data/lib/stripe/services/v2/network/business_profile_service.rb +2 -2
- data/lib/stripe/services/v2_services.rb +1 -1
- data/lib/stripe/services.rb +678 -268
- data/lib/stripe/stripe_event_notification_handler.rb +1 -0
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +25 -4
- data/rbi/stripe/resources/v2/core/event_notification.rbi +3 -0
- data/rbi/stripe.rbi +2438 -539
- metadata +6 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: afafb2a8e28c3da022dd66a279a3d5d2e9db63db55e3de937c97795cdf716776
|
|
4
|
+
data.tar.gz: 03e5ebc1552f8ea7442def80713c6aaf79c861f6b85b446074cf80e25892718e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b32bba5512cdf3ee41477cd06947a023827cbbca94d24d032dce892c4c0c291c73ea7bd48c65093aeb2736d33cd34b84d6104b8d93534da97a67da88d01f7c74
|
|
7
|
+
data.tar.gz: 8a716bbe5b5c4ee3931943d642981620911a9307255c39ba65861a6a00ffd5f387b1cb19e8069fa10a0ee8cdeef742d876d868105b351ac4d4b59db7a09eecfa
|
data/lib/stripe/api_version.rb
CHANGED
|
@@ -263,6 +263,15 @@ module Stripe
|
|
|
263
263
|
end
|
|
264
264
|
end
|
|
265
265
|
|
|
266
|
+
class BizumPayments < ::Stripe::RequestParams
|
|
267
|
+
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
268
|
+
attr_accessor :requested
|
|
269
|
+
|
|
270
|
+
def initialize(requested: nil)
|
|
271
|
+
@requested = requested
|
|
272
|
+
end
|
|
273
|
+
end
|
|
274
|
+
|
|
266
275
|
class BlikPayments < ::Stripe::RequestParams
|
|
267
276
|
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
268
277
|
attr_accessor :requested
|
|
@@ -677,6 +686,15 @@ module Stripe
|
|
|
677
686
|
end
|
|
678
687
|
end
|
|
679
688
|
|
|
689
|
+
class ScalapayPayments < ::Stripe::RequestParams
|
|
690
|
+
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
691
|
+
attr_accessor :requested
|
|
692
|
+
|
|
693
|
+
def initialize(requested: nil)
|
|
694
|
+
@requested = requested
|
|
695
|
+
end
|
|
696
|
+
end
|
|
697
|
+
|
|
680
698
|
class SepaBankTransferPayments < ::Stripe::RequestParams
|
|
681
699
|
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
682
700
|
attr_accessor :requested
|
|
@@ -871,6 +889,8 @@ module Stripe
|
|
|
871
889
|
attr_accessor :bank_transfer_payments
|
|
872
890
|
# The billie_payments capability.
|
|
873
891
|
attr_accessor :billie_payments
|
|
892
|
+
# The bizum_payments capability.
|
|
893
|
+
attr_accessor :bizum_payments
|
|
874
894
|
# The blik_payments capability.
|
|
875
895
|
attr_accessor :blik_payments
|
|
876
896
|
# The boleto_payments capability.
|
|
@@ -963,6 +983,8 @@ module Stripe
|
|
|
963
983
|
attr_accessor :samsung_pay_payments
|
|
964
984
|
# The satispay_payments capability.
|
|
965
985
|
attr_accessor :satispay_payments
|
|
986
|
+
# The scalapay_payments capability.
|
|
987
|
+
attr_accessor :scalapay_payments
|
|
966
988
|
# The sepa_bank_transfer_payments capability.
|
|
967
989
|
attr_accessor :sepa_bank_transfer_payments
|
|
968
990
|
# The sepa_debit_payments capability.
|
|
@@ -1015,6 +1037,7 @@ module Stripe
|
|
|
1015
1037
|
bancontact_payments: nil,
|
|
1016
1038
|
bank_transfer_payments: nil,
|
|
1017
1039
|
billie_payments: nil,
|
|
1040
|
+
bizum_payments: nil,
|
|
1018
1041
|
blik_payments: nil,
|
|
1019
1042
|
boleto_payments: nil,
|
|
1020
1043
|
card_issuing: nil,
|
|
@@ -1061,6 +1084,7 @@ module Stripe
|
|
|
1061
1084
|
revolut_pay_payments: nil,
|
|
1062
1085
|
samsung_pay_payments: nil,
|
|
1063
1086
|
satispay_payments: nil,
|
|
1087
|
+
scalapay_payments: nil,
|
|
1064
1088
|
sepa_bank_transfer_payments: nil,
|
|
1065
1089
|
sepa_debit_payments: nil,
|
|
1066
1090
|
shopeepay_payments: nil,
|
|
@@ -1093,6 +1117,7 @@ module Stripe
|
|
|
1093
1117
|
@bancontact_payments = bancontact_payments
|
|
1094
1118
|
@bank_transfer_payments = bank_transfer_payments
|
|
1095
1119
|
@billie_payments = billie_payments
|
|
1120
|
+
@bizum_payments = bizum_payments
|
|
1096
1121
|
@blik_payments = blik_payments
|
|
1097
1122
|
@boleto_payments = boleto_payments
|
|
1098
1123
|
@card_issuing = card_issuing
|
|
@@ -1139,6 +1164,7 @@ module Stripe
|
|
|
1139
1164
|
@revolut_pay_payments = revolut_pay_payments
|
|
1140
1165
|
@samsung_pay_payments = samsung_pay_payments
|
|
1141
1166
|
@satispay_payments = satispay_payments
|
|
1167
|
+
@scalapay_payments = scalapay_payments
|
|
1142
1168
|
@sepa_bank_transfer_payments = sepa_bank_transfer_payments
|
|
1143
1169
|
@sepa_debit_payments = sepa_debit_payments
|
|
1144
1170
|
@shopeepay_payments = shopeepay_payments
|
|
@@ -263,6 +263,15 @@ module Stripe
|
|
|
263
263
|
end
|
|
264
264
|
end
|
|
265
265
|
|
|
266
|
+
class BizumPayments < ::Stripe::RequestParams
|
|
267
|
+
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
268
|
+
attr_accessor :requested
|
|
269
|
+
|
|
270
|
+
def initialize(requested: nil)
|
|
271
|
+
@requested = requested
|
|
272
|
+
end
|
|
273
|
+
end
|
|
274
|
+
|
|
266
275
|
class BlikPayments < ::Stripe::RequestParams
|
|
267
276
|
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
268
277
|
attr_accessor :requested
|
|
@@ -677,6 +686,15 @@ module Stripe
|
|
|
677
686
|
end
|
|
678
687
|
end
|
|
679
688
|
|
|
689
|
+
class ScalapayPayments < ::Stripe::RequestParams
|
|
690
|
+
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
691
|
+
attr_accessor :requested
|
|
692
|
+
|
|
693
|
+
def initialize(requested: nil)
|
|
694
|
+
@requested = requested
|
|
695
|
+
end
|
|
696
|
+
end
|
|
697
|
+
|
|
680
698
|
class SepaBankTransferPayments < ::Stripe::RequestParams
|
|
681
699
|
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
682
700
|
attr_accessor :requested
|
|
@@ -871,6 +889,8 @@ module Stripe
|
|
|
871
889
|
attr_accessor :bank_transfer_payments
|
|
872
890
|
# The billie_payments capability.
|
|
873
891
|
attr_accessor :billie_payments
|
|
892
|
+
# The bizum_payments capability.
|
|
893
|
+
attr_accessor :bizum_payments
|
|
874
894
|
# The blik_payments capability.
|
|
875
895
|
attr_accessor :blik_payments
|
|
876
896
|
# The boleto_payments capability.
|
|
@@ -963,6 +983,8 @@ module Stripe
|
|
|
963
983
|
attr_accessor :samsung_pay_payments
|
|
964
984
|
# The satispay_payments capability.
|
|
965
985
|
attr_accessor :satispay_payments
|
|
986
|
+
# The scalapay_payments capability.
|
|
987
|
+
attr_accessor :scalapay_payments
|
|
966
988
|
# The sepa_bank_transfer_payments capability.
|
|
967
989
|
attr_accessor :sepa_bank_transfer_payments
|
|
968
990
|
# The sepa_debit_payments capability.
|
|
@@ -1015,6 +1037,7 @@ module Stripe
|
|
|
1015
1037
|
bancontact_payments: nil,
|
|
1016
1038
|
bank_transfer_payments: nil,
|
|
1017
1039
|
billie_payments: nil,
|
|
1040
|
+
bizum_payments: nil,
|
|
1018
1041
|
blik_payments: nil,
|
|
1019
1042
|
boleto_payments: nil,
|
|
1020
1043
|
card_issuing: nil,
|
|
@@ -1061,6 +1084,7 @@ module Stripe
|
|
|
1061
1084
|
revolut_pay_payments: nil,
|
|
1062
1085
|
samsung_pay_payments: nil,
|
|
1063
1086
|
satispay_payments: nil,
|
|
1087
|
+
scalapay_payments: nil,
|
|
1064
1088
|
sepa_bank_transfer_payments: nil,
|
|
1065
1089
|
sepa_debit_payments: nil,
|
|
1066
1090
|
shopeepay_payments: nil,
|
|
@@ -1093,6 +1117,7 @@ module Stripe
|
|
|
1093
1117
|
@bancontact_payments = bancontact_payments
|
|
1094
1118
|
@bank_transfer_payments = bank_transfer_payments
|
|
1095
1119
|
@billie_payments = billie_payments
|
|
1120
|
+
@bizum_payments = bizum_payments
|
|
1096
1121
|
@blik_payments = blik_payments
|
|
1097
1122
|
@boleto_payments = boleto_payments
|
|
1098
1123
|
@card_issuing = card_issuing
|
|
@@ -1139,6 +1164,7 @@ module Stripe
|
|
|
1139
1164
|
@revolut_pay_payments = revolut_pay_payments
|
|
1140
1165
|
@samsung_pay_payments = samsung_pay_payments
|
|
1141
1166
|
@satispay_payments = satispay_payments
|
|
1167
|
+
@scalapay_payments = scalapay_payments
|
|
1142
1168
|
@sepa_bank_transfer_payments = sepa_bank_transfer_payments
|
|
1143
1169
|
@sepa_debit_payments = sepa_debit_payments
|
|
1144
1170
|
@shopeepay_payments = shopeepay_payments
|
|
@@ -5,6 +5,21 @@ module Stripe
|
|
|
5
5
|
class BalanceSettingsUpdateParams < ::Stripe::RequestParams
|
|
6
6
|
class Payments < ::Stripe::RequestParams
|
|
7
7
|
class Payouts < ::Stripe::RequestParams
|
|
8
|
+
class AutomaticTransferRulesByCurrency < ::Stripe::RequestParams
|
|
9
|
+
# The ID of the FinancialAccount that funds will be transferred to during automatic transfers.
|
|
10
|
+
attr_accessor :payout_method
|
|
11
|
+
# The maximum amount in minor units to transfer to the FinancialAccount. Required and only applicable when `type` is `transfer_up_to_amount`.
|
|
12
|
+
attr_accessor :transfer_up_to_amount
|
|
13
|
+
# The type of automatic transfer rule.
|
|
14
|
+
attr_accessor :type
|
|
15
|
+
|
|
16
|
+
def initialize(payout_method: nil, transfer_up_to_amount: nil, type: nil)
|
|
17
|
+
@payout_method = payout_method
|
|
18
|
+
@transfer_up_to_amount = transfer_up_to_amount
|
|
19
|
+
@type = type
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
|
|
8
23
|
class Schedule < ::Stripe::RequestParams
|
|
9
24
|
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
|
|
10
25
|
attr_accessor :interval
|
|
@@ -19,6 +34,8 @@ module Stripe
|
|
|
19
34
|
@weekly_payout_days = weekly_payout_days
|
|
20
35
|
end
|
|
21
36
|
end
|
|
37
|
+
# Configures per-currency rules for automatically transferring funds from the payments balance to a FinancialAccount.
|
|
38
|
+
attr_accessor :automatic_transfer_rules_by_currency
|
|
22
39
|
# The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
|
|
23
40
|
attr_accessor :minimum_balance_by_currency
|
|
24
41
|
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
|
|
@@ -26,7 +43,13 @@ module Stripe
|
|
|
26
43
|
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
|
|
27
44
|
attr_accessor :statement_descriptor
|
|
28
45
|
|
|
29
|
-
def initialize(
|
|
46
|
+
def initialize(
|
|
47
|
+
automatic_transfer_rules_by_currency: nil,
|
|
48
|
+
minimum_balance_by_currency: nil,
|
|
49
|
+
schedule: nil,
|
|
50
|
+
statement_descriptor: nil
|
|
51
|
+
)
|
|
52
|
+
@automatic_transfer_rules_by_currency = automatic_transfer_rules_by_currency
|
|
30
53
|
@minimum_balance_by_currency = minimum_balance_by_currency
|
|
31
54
|
@schedule = schedule
|
|
32
55
|
@statement_descriptor = statement_descriptor
|
|
@@ -34,11 +57,28 @@ module Stripe
|
|
|
34
57
|
end
|
|
35
58
|
|
|
36
59
|
class SettlementTiming < ::Stripe::RequestParams
|
|
60
|
+
class StartOfDay < ::Stripe::RequestParams
|
|
61
|
+
# Hour at which the customized start of day begins according to the given timezone. Must be a [supported customized start of day hour](/connect/customized-start-of-day#available-timezones-and-cutoffs).
|
|
62
|
+
attr_accessor :hour
|
|
63
|
+
# Minutes at which the customized start of day begins according to the given timezone. Must be either 0 or 30.
|
|
64
|
+
attr_accessor :minutes
|
|
65
|
+
# Timezone for the customized start of day. Must be a [supported customized start of day timezone](/connect/customized-start-of-day#available-timezones-and-cutoffs).
|
|
66
|
+
attr_accessor :timezone
|
|
67
|
+
|
|
68
|
+
def initialize(hour: nil, minutes: nil, timezone: nil)
|
|
69
|
+
@hour = hour
|
|
70
|
+
@minutes = minutes
|
|
71
|
+
@timezone = timezone
|
|
72
|
+
end
|
|
73
|
+
end
|
|
37
74
|
# Change `delay_days` for this account, which determines the number of days charge funds are held before becoming available. The maximum value is 31. Passing an empty string to `delay_days_override` will return `delay_days` to the default, which is the lowest available value for the account. [Learn more about controlling delay days](/connect/manage-payout-schedule).
|
|
38
75
|
attr_accessor :delay_days_override
|
|
76
|
+
# Customized start of day configuration for automatic payouts to group and send payments in local timezones with a customized day starting time. For details, see our [Customized start of day](/connect/customized-start-of-day) documentation.
|
|
77
|
+
attr_accessor :start_of_day
|
|
39
78
|
|
|
40
|
-
def initialize(delay_days_override: nil)
|
|
79
|
+
def initialize(delay_days_override: nil, start_of_day: nil)
|
|
41
80
|
@delay_days_override = delay_days_override
|
|
81
|
+
@start_of_day = start_of_day
|
|
42
82
|
end
|
|
43
83
|
end
|
|
44
84
|
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
|
|
@@ -78,11 +78,14 @@ module Stripe
|
|
|
78
78
|
class TransferData < ::Stripe::RequestParams
|
|
79
79
|
# The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
|
|
80
80
|
attr_accessor :amount
|
|
81
|
+
# An arbitrary string attached to the transfer. Often useful for displaying to users.
|
|
82
|
+
attr_accessor :description
|
|
81
83
|
# ID of an existing, connected Stripe account.
|
|
82
84
|
attr_accessor :destination
|
|
83
85
|
|
|
84
|
-
def initialize(amount: nil, destination: nil)
|
|
86
|
+
def initialize(amount: nil, description: nil, destination: nil)
|
|
85
87
|
@amount = amount
|
|
88
|
+
@description = description
|
|
86
89
|
@destination = destination
|
|
87
90
|
end
|
|
88
91
|
end
|
|
@@ -138,7 +138,7 @@ module Stripe
|
|
|
138
138
|
attr_accessor :payment_method_reuse_agreement
|
|
139
139
|
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
|
140
140
|
# Session will determine whether to display an option to opt into promotional communication
|
|
141
|
-
# from the merchant depending on the customer's locale. Only available to US merchants.
|
|
141
|
+
# from the merchant depending on the customer's locale. Only available to US merchants and US customers.
|
|
142
142
|
attr_accessor :promotions
|
|
143
143
|
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
|
|
144
144
|
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
|
|
@@ -1089,7 +1089,7 @@ module Stripe
|
|
|
1089
1089
|
end
|
|
1090
1090
|
|
|
1091
1091
|
class Restrictions < ::Stripe::RequestParams
|
|
1092
|
-
#
|
|
1092
|
+
# The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
|
|
1093
1093
|
attr_accessor :brands_blocked
|
|
1094
1094
|
|
|
1095
1095
|
def initialize(brands_blocked: nil)
|
|
@@ -1765,6 +1765,15 @@ module Stripe
|
|
|
1765
1765
|
end
|
|
1766
1766
|
end
|
|
1767
1767
|
|
|
1768
|
+
class Scalapay < ::Stripe::RequestParams
|
|
1769
|
+
# Controls when the funds will be captured from the customer's account.
|
|
1770
|
+
attr_accessor :capture_method
|
|
1771
|
+
|
|
1772
|
+
def initialize(capture_method: nil)
|
|
1773
|
+
@capture_method = capture_method
|
|
1774
|
+
end
|
|
1775
|
+
end
|
|
1776
|
+
|
|
1768
1777
|
class SepaDebit < ::Stripe::RequestParams
|
|
1769
1778
|
class MandateOptions < ::Stripe::RequestParams
|
|
1770
1779
|
# 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'.
|
|
@@ -1922,7 +1931,7 @@ module Stripe
|
|
|
1922
1931
|
@setup_future_usage = setup_future_usage
|
|
1923
1932
|
end
|
|
1924
1933
|
end
|
|
1925
|
-
# contains details about the ACSS Debit payment method options. You can't set this parameter if `ui_mode` is `
|
|
1934
|
+
# contains details about the ACSS Debit payment method options. You can't set this parameter if `ui_mode` is `elements`.
|
|
1926
1935
|
attr_accessor :acss_debit
|
|
1927
1936
|
# contains details about the Affirm payment method options.
|
|
1928
1937
|
attr_accessor :affirm
|
|
@@ -1974,7 +1983,7 @@ module Stripe
|
|
|
1974
1983
|
attr_accessor :konbini
|
|
1975
1984
|
# contains details about the Korean card payment method options.
|
|
1976
1985
|
attr_accessor :kr_card
|
|
1977
|
-
# contains details about the Link payment method options.
|
|
1986
|
+
# contains details about the Link payment method options (Link is also known as Onelink in the UK).
|
|
1978
1987
|
attr_accessor :link
|
|
1979
1988
|
# contains details about the Mobilepay payment method options.
|
|
1980
1989
|
attr_accessor :mobilepay
|
|
@@ -2004,6 +2013,8 @@ module Stripe
|
|
|
2004
2013
|
attr_accessor :samsung_pay
|
|
2005
2014
|
# contains details about the Satispay payment method options.
|
|
2006
2015
|
attr_accessor :satispay
|
|
2016
|
+
# contains details about the Scalapay payment method options.
|
|
2017
|
+
attr_accessor :scalapay
|
|
2007
2018
|
# contains details about the Sepa Debit payment method options.
|
|
2008
2019
|
attr_accessor :sepa_debit
|
|
2009
2020
|
# contains details about the Sofort payment method options.
|
|
@@ -2061,6 +2072,7 @@ module Stripe
|
|
|
2061
2072
|
revolut_pay: nil,
|
|
2062
2073
|
samsung_pay: nil,
|
|
2063
2074
|
satispay: nil,
|
|
2075
|
+
scalapay: nil,
|
|
2064
2076
|
sepa_debit: nil,
|
|
2065
2077
|
sofort: nil,
|
|
2066
2078
|
swish: nil,
|
|
@@ -2110,6 +2122,7 @@ module Stripe
|
|
|
2110
2122
|
@revolut_pay = revolut_pay
|
|
2111
2123
|
@samsung_pay = samsung_pay
|
|
2112
2124
|
@satispay = satispay
|
|
2125
|
+
@scalapay = scalapay
|
|
2113
2126
|
@sepa_debit = sepa_debit
|
|
2114
2127
|
@sofort = sofort
|
|
2115
2128
|
@swish = swish
|
|
@@ -2416,7 +2429,7 @@ module Stripe
|
|
|
2416
2429
|
end
|
|
2417
2430
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
|
2418
2431
|
attr_accessor :application_fee_percent
|
|
2419
|
-
# A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if `ui_mode` is `
|
|
2432
|
+
# A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if `ui_mode` is `elements`.
|
|
2420
2433
|
attr_accessor :billing_cycle_anchor
|
|
2421
2434
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
2422
2435
|
attr_accessor :billing_mode
|
|
@@ -2501,7 +2514,7 @@ module Stripe
|
|
|
2501
2514
|
@display = display
|
|
2502
2515
|
end
|
|
2503
2516
|
end
|
|
2504
|
-
# contains details about the Link wallet options.
|
|
2517
|
+
# contains details about the Link wallet options (Link is also known as Onelink in the UK).
|
|
2505
2518
|
attr_accessor :link
|
|
2506
2519
|
|
|
2507
2520
|
def initialize(link: nil)
|
|
@@ -2510,7 +2523,7 @@ module Stripe
|
|
|
2510
2523
|
end
|
|
2511
2524
|
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
|
2512
2525
|
attr_accessor :adaptive_pricing
|
|
2513
|
-
# Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `
|
|
2526
|
+
# Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `elements`.
|
|
2514
2527
|
attr_accessor :after_expiration
|
|
2515
2528
|
# Enables user redeemable promotion codes.
|
|
2516
2529
|
attr_accessor :allow_promotion_codes
|
|
@@ -2518,9 +2531,9 @@ module Stripe
|
|
|
2518
2531
|
attr_accessor :automatic_tax
|
|
2519
2532
|
# Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
|
|
2520
2533
|
attr_accessor :billing_address_collection
|
|
2521
|
-
# The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `
|
|
2534
|
+
# The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `elements`.
|
|
2522
2535
|
attr_accessor :branding_settings
|
|
2523
|
-
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `
|
|
2536
|
+
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded_page` or `elements`.
|
|
2524
2537
|
attr_accessor :cancel_url
|
|
2525
2538
|
# A unique string to reference the Checkout Session. This can be a
|
|
2526
2539
|
# customer ID, a cart ID, or similar, and can be used to reconcile the
|
|
@@ -2610,7 +2623,7 @@ module Stripe
|
|
|
2610
2623
|
#
|
|
2611
2624
|
# You can't set this parameter if `ui_mode` is `custom`.
|
|
2612
2625
|
attr_accessor :optional_items
|
|
2613
|
-
# Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `
|
|
2626
|
+
# Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `elements`.
|
|
2614
2627
|
attr_accessor :origin_context
|
|
2615
2628
|
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
|
|
2616
2629
|
attr_accessor :payment_intent_data
|
|
@@ -2648,10 +2661,10 @@ module Stripe
|
|
|
2648
2661
|
# We recommend that you review your privacy policy and check with your legal contacts
|
|
2649
2662
|
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers).
|
|
2650
2663
|
attr_accessor :phone_number_collection
|
|
2651
|
-
# This parameter applies to `ui_mode:
|
|
2664
|
+
# This parameter applies to `ui_mode: embedded_page`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
|
|
2652
2665
|
attr_accessor :redirect_on_completion
|
|
2653
2666
|
# The URL to redirect your customer back to after they authenticate or cancel their payment on the
|
|
2654
|
-
# payment method's app or site. This parameter is required if `ui_mode` is `
|
|
2667
|
+
# payment method's app or site. This parameter is required if `ui_mode` is `embedded_page` or `elements`
|
|
2655
2668
|
# and redirect-based payment methods are enabled on the session.
|
|
2656
2669
|
attr_accessor :return_url
|
|
2657
2670
|
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
|
@@ -2666,19 +2679,19 @@ module Stripe
|
|
|
2666
2679
|
# to customize relevant text on the page, such as the submit button.
|
|
2667
2680
|
# `submit_type` can only be specified on Checkout Sessions in
|
|
2668
2681
|
# `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
|
|
2669
|
-
# You can't set this parameter if `ui_mode` is `
|
|
2682
|
+
# You can't set this parameter if `ui_mode` is `elements`.
|
|
2670
2683
|
attr_accessor :submit_type
|
|
2671
2684
|
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
|
|
2672
2685
|
attr_accessor :subscription_data
|
|
2673
2686
|
# The URL to which Stripe should send customers when payment or setup
|
|
2674
2687
|
# is complete.
|
|
2675
|
-
# This parameter is not allowed if ui_mode is `
|
|
2688
|
+
# This parameter is not allowed if ui_mode is `embedded_page` or `elements`. If you'd like to use
|
|
2676
2689
|
# information from the successful Checkout Session on your page, read the
|
|
2677
2690
|
# guide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page).
|
|
2678
2691
|
attr_accessor :success_url
|
|
2679
2692
|
# Controls tax ID collection during checkout.
|
|
2680
2693
|
attr_accessor :tax_id_collection
|
|
2681
|
-
# The UI mode of the Session. Defaults to `
|
|
2694
|
+
# The UI mode of the Session. Defaults to `hosted_page`.
|
|
2682
2695
|
attr_accessor :ui_mode
|
|
2683
2696
|
# Wallet-specific configuration.
|
|
2684
2697
|
attr_accessor :wallet_options
|
|
@@ -103,6 +103,7 @@ module Stripe
|
|
|
103
103
|
end
|
|
104
104
|
end
|
|
105
105
|
|
|
106
|
+
class Bizum < ::Stripe::RequestParams; end
|
|
106
107
|
class Blik < ::Stripe::RequestParams; end
|
|
107
108
|
|
|
108
109
|
class Boleto < ::Stripe::RequestParams
|
|
@@ -305,6 +306,7 @@ module Stripe
|
|
|
305
306
|
class RevolutPay < ::Stripe::RequestParams; end
|
|
306
307
|
class SamsungPay < ::Stripe::RequestParams; end
|
|
307
308
|
class Satispay < ::Stripe::RequestParams; end
|
|
309
|
+
class Scalapay < ::Stripe::RequestParams; end
|
|
308
310
|
|
|
309
311
|
class SepaDebit < ::Stripe::RequestParams
|
|
310
312
|
# IBAN of the bank account.
|
|
@@ -418,6 +420,8 @@ module Stripe
|
|
|
418
420
|
attr_accessor :billie
|
|
419
421
|
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
|
|
420
422
|
attr_accessor :billing_details
|
|
423
|
+
# If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method.
|
|
424
|
+
attr_accessor :bizum
|
|
421
425
|
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
|
|
422
426
|
attr_accessor :blik
|
|
423
427
|
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
|
|
@@ -452,7 +456,7 @@ module Stripe
|
|
|
452
456
|
attr_accessor :konbini
|
|
453
457
|
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
|
|
454
458
|
attr_accessor :kr_card
|
|
455
|
-
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
|
|
459
|
+
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK).
|
|
456
460
|
attr_accessor :link
|
|
457
461
|
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
458
462
|
attr_accessor :mb_way
|
|
@@ -498,6 +502,8 @@ module Stripe
|
|
|
498
502
|
attr_accessor :samsung_pay
|
|
499
503
|
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
|
|
500
504
|
attr_accessor :satispay
|
|
505
|
+
# If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method.
|
|
506
|
+
attr_accessor :scalapay
|
|
501
507
|
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
|
|
502
508
|
attr_accessor :sepa_debit
|
|
503
509
|
# ID of the SharedPaymentGrantedToken used to confirm this PaymentIntent.
|
|
@@ -538,6 +544,7 @@ module Stripe
|
|
|
538
544
|
bancontact: nil,
|
|
539
545
|
billie: nil,
|
|
540
546
|
billing_details: nil,
|
|
547
|
+
bizum: nil,
|
|
541
548
|
blik: nil,
|
|
542
549
|
boleto: nil,
|
|
543
550
|
cashapp: nil,
|
|
@@ -578,6 +585,7 @@ module Stripe
|
|
|
578
585
|
revolut_pay: nil,
|
|
579
586
|
samsung_pay: nil,
|
|
580
587
|
satispay: nil,
|
|
588
|
+
scalapay: nil,
|
|
581
589
|
sepa_debit: nil,
|
|
582
590
|
shared_payment_granted_token: nil,
|
|
583
591
|
shopeepay: nil,
|
|
@@ -604,6 +612,7 @@ module Stripe
|
|
|
604
612
|
@bancontact = bancontact
|
|
605
613
|
@billie = billie
|
|
606
614
|
@billing_details = billing_details
|
|
615
|
+
@bizum = bizum
|
|
607
616
|
@blik = blik
|
|
608
617
|
@boleto = boleto
|
|
609
618
|
@cashapp = cashapp
|
|
@@ -644,6 +653,7 @@ module Stripe
|
|
|
644
653
|
@revolut_pay = revolut_pay
|
|
645
654
|
@samsung_pay = samsung_pay
|
|
646
655
|
@satispay = satispay
|
|
656
|
+
@scalapay = scalapay
|
|
647
657
|
@sepa_debit = sepa_debit
|
|
648
658
|
@shared_payment_granted_token = shared_payment_granted_token
|
|
649
659
|
@shopeepay = shopeepay
|
|
@@ -957,6 +957,8 @@ module Stripe
|
|
|
957
957
|
@field_encodings = { unit_amount_decimal: :decimal_string }
|
|
958
958
|
end
|
|
959
959
|
end
|
|
960
|
+
# Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
961
|
+
attr_accessor :discountable
|
|
960
962
|
# The coupons to redeem into discounts for the item.
|
|
961
963
|
attr_accessor :discounts
|
|
962
964
|
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
@@ -973,6 +975,7 @@ module Stripe
|
|
|
973
975
|
attr_accessor :tax_rates
|
|
974
976
|
|
|
975
977
|
def initialize(
|
|
978
|
+
discountable: nil,
|
|
976
979
|
discounts: nil,
|
|
977
980
|
metadata: nil,
|
|
978
981
|
period: nil,
|
|
@@ -981,6 +984,7 @@ module Stripe
|
|
|
981
984
|
quantity: nil,
|
|
982
985
|
tax_rates: nil
|
|
983
986
|
)
|
|
987
|
+
@discountable = discountable
|
|
984
988
|
@discounts = discounts
|
|
985
989
|
@metadata = metadata
|
|
986
990
|
@period = period
|
|
@@ -133,9 +133,9 @@ module Stripe
|
|
|
133
133
|
class Shipping < ::Stripe::RequestParams
|
|
134
134
|
# If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0.
|
|
135
135
|
attr_accessor :amount
|
|
136
|
-
# 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.
|
|
136
|
+
# If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed.
|
|
137
137
|
attr_accessor :from_postal_code
|
|
138
|
-
# 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.
|
|
138
|
+
# If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed.
|
|
139
139
|
attr_accessor :to_postal_code
|
|
140
140
|
|
|
141
141
|
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil)
|