class

Stripe::PaymentMethodOptionsParam

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Constants

ERROR_MESSAGE_FOR_ARES_TRANS_STATUS = "invalid value for \"ares_trans_status\", must be one of [A, C, I, N, R, U, Y]."
ERROR_MESSAGE_FOR_CAPTURE_METHOD = "invalid value for \"capture_method\", must be one of [, manual]."
ERROR_MESSAGE_FOR_CLIENT = "invalid value for \"client\", must be one of [android, ios, web]."
ERROR_MESSAGE_FOR_CURRENCY = "invalid value for \"currency\", must be one of [cad, usd]."
ERROR_MESSAGE_FOR_ELECTRONIC_COMMERCE_INDICATOR = "invalid value for \"electronic_commerce_indicator\", must be one of [01, 02, 05, 06, 07]."
ERROR_MESSAGE_FOR_EXEMPTION_INDICATOR = "invalid value for \"exemption_indicator\", must be one of [low_risk, none]."
ERROR_MESSAGE_FOR_FUNDING_TYPE = "invalid value for \"funding_type\", must be one of [bank_transfer]."
ERROR_MESSAGE_FOR_PREFERRED_LOCALE = "invalid value for \"preferred_locale\", must be one of [cs-CZ, da-DK, de-AT, de-DE, de-LU, el-GR, en-GB, en-US, es-ES, fi-FI, fr-BE, fr-FR, fr-LU, hu-HU, it-IT, nl-BE, nl-NL, pl-PL, pt-PT, sk-SK, sv-SE]."
ERROR_MESSAGE_FOR_REQUEST_THREE_D_SECURE = "invalid value for \"request_three_d_secure\", must be one of [any, automatic, challenge]."
ERROR_MESSAGE_FOR_SETUP_FUTURE_USAGE = "invalid value for \"setup_future_usage\", must be one of [none]."
ERROR_MESSAGE_FOR_VERIFICATION_METHOD = "invalid value for \"verification_method\", must be one of [automatic, instant]."
ERROR_MESSAGE_FOR_VERSION = "invalid value for \"version\", must be one of [1.0.2, 2.1.0, 2.2.0]."
MAX_LENGTH_FOR_APP_ID = 5000
MAX_LENGTH_FOR_BILLING_AGREEMENT_ID = 5000
MAX_LENGTH_FOR_CRYPTOGRAM = 5000
MAX_LENGTH_FOR_REFERENCE = 5000
MAX_LENGTH_FOR_REQUESTOR_CHALLENGE_INDICATOR = 2
MAX_LENGTH_FOR_RISK_CORRELATION_ID = 32
MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR_SUFFIX_KANA = 22
MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR_SUFFIX_KANJI = 17
MAX_LENGTH_FOR_TRANSACTION_ID = 5000
VALID_VALUES_FOR_ARES_TRANS_STATUS = String.static_array("A", "C", "I", "N", "R", "U", "Y")
VALID_VALUES_FOR_CAPTURE_METHOD = String.static_array("", "manual")
VALID_VALUES_FOR_CLIENT = String.static_array("android", "ios", "web")
VALID_VALUES_FOR_CURRENCY = String.static_array("cad", "usd")
VALID_VALUES_FOR_ELECTRONIC_COMMERCE_INDICATOR = String.static_array("01", "02", "05", "06", "07")
VALID_VALUES_FOR_EXEMPTION_INDICATOR = String.static_array("low_risk", "none")
VALID_VALUES_FOR_FUNDING_TYPE = String.static_array("bank_transfer")
VALID_VALUES_FOR_PREFERRED_LOCALE = String.static_array("cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE")
VALID_VALUES_FOR_REQUEST_THREE_D_SECURE = String.static_array("any", "automatic", "challenge")
VALID_VALUES_FOR_SETUP_FUTURE_USAGE = String.static_array("none")
VALID_VALUES_FOR_VERIFICATION_METHOD = String.static_array("automatic", "instant")
VALID_VALUES_FOR_VERSION = String.static_array("1.0.2", "2.1.0", "2.2.0")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

acss_debit
Source
acss_debit=(new_value : Stripe::SetupIntentPaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] acss_debit Object to be assigned

Source
affirm
Source
affirm=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] affirm Object to be assigned

Source
afterpay_clearpay
Source
afterpay_clearpay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] afterpay_clearpay Object to be assigned

Source
alipay
Source
alipay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] alipay Object to be assigned

Source
amazon_pay
Source
amazon_pay=(new_value : Stripe::SetupIntentPaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amazon_pay Object to be assigned

Source
app_id

The app ID registered with WeChat Pay. Only required when client is ios or android.

Source
app_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] app_id Object to be assigned

Source
ares_trans_status

The transStatus returned from the card Issuer’s ACS in the ARes.

Source
ares_trans_status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ares_trans_status Object to be assigned

Source
au_becs_debit
Source
au_becs_debit=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] au_becs_debit Object to be assigned

Source
bacs_debit
Source
bacs_debit=(new_value : Stripe::SetupIntentPaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] bacs_debit Object to be assigned

Source
bancontact
Source
bancontact=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] bancontact Object to be assigned

Source
bank_transfer
Source
bank_transfer=(new_value : Stripe::BankTransferParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] bank_transfer Object to be assigned

Source
billing_agreement_id

The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.

Source
billing_agreement_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] billing_agreement_id Object to be assigned

Source
blik
Source
blik=(new_value : Stripe::PaymentMethodOptionsParamBlik | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] blik Object to be assigned

Source
boleto
Source
boleto=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] boleto Object to be assigned

Source
capture_method

Controls when the funds will be captured from the customer's account.

Source
capture_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] capture_method Object to be assigned

Source
card
Source
card=(new_value : Stripe::SetupIntentParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] card Object to be assigned

Source
card_present
Source
card_present=(new_value : Stripe::SetupIntentPaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] card_present Object to be assigned

Source
cashapp
Source
cashapp=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cashapp Object to be assigned

Source
client

The client type that the end customer will pay from

Source
client=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client Object to be assigned

Source
cryptogram

The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. (Most 3D Secure providers will return the base64-encoded version, which is what you should specify here.)

Source
cryptogram=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cryptogram Object to be assigned

Source
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency. This is only accepted for Checkout Sessions in setup mode.

Source
currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source
customer_balance
Source
customer_balance=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] customer_balance Object to be assigned

Source
electronic_commerce_indicator

The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.

Source
electronic_commerce_indicator=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] electronic_commerce_indicator Object to be assigned

Source
eps=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] eps Object to be assigned

Source
exemption_indicator

The exemption requested via 3DS and accepted by the issuer at authentication time.

Source
exemption_indicator=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] exemption_indicator Object to be assigned

Source
expires_after_days

The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.

Source
expires_after_days=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expires_after_days Object to be assigned

Source
expires_after_seconds

The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.

Source
expires_after_seconds=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expires_after_seconds Object to be assigned

Source
financial_connections
Source
financial_connections=(new_value : Stripe::LinkedAccountOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] financial_connections Object to be assigned

Source
fpx=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] fpx Object to be assigned

Source
funding_type

The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

Source
funding_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] funding_type Object to be assigned

Source
giropay
Source
giropay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] giropay Object to be assigned

Source
grabpay
Source
grabpay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] grabpay Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

ideal
Source
ideal=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ideal Object to be assigned

Source
installments
Source
installments=(new_value : Stripe::InstallmentsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] installments Object to be assigned

Source
interac_present
Source
interac_present=(new_value : Stripe::PaymentMethodOptionsParamInteracPresent | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interac_present Object to be assigned

Source
klarna
Source
klarna=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] klarna Object to be assigned

Source
konbini
Source
konbini=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] konbini Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
mandate_options
Source
mandate_options=(new_value : Stripe::MandateOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] mandate_options Object to be assigned

Source
mobilepay
Source
mobilepay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] mobilepay Object to be assigned

Source
multibanco
Source
multibanco=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] multibanco Object to be assigned

Source
network_options
Source
network_options=(new_value : Stripe::NetworkOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network_options Object to be assigned

Source
oxxo
Source
oxxo=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] oxxo Object to be assigned

Source
p24=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] p24 Object to be assigned

Source
paynow
Source
paynow=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] paynow Object to be assigned

Source
paypal
Source
paypal=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] paypal Object to be assigned

Source
pix=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] pix Object to be assigned

Source
preferred_locale

Preferred locale of the PayPal checkout page that the customer is redirected to.

Source
preferred_locale=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] preferred_locale Object to be assigned

Source
promptpay
Source
promptpay=(new_value : Stripe::PaymentMethodOptionsParamPromptpay | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] promptpay Object to be assigned

Source
reference

The order reference that will be displayed to customers in the Swish application. Defaults to the id of the Payment Intent.

Source
reference=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] reference Object to be assigned

Source
request_three_d_secure

We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.

Source
request_three_d_secure=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_three_d_secure Object to be assigned

Source
requestor_challenge_indicator

The challenge indicator (threeDSRequestorChallengeInd) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.

Source
requestor_challenge_indicator=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] requestor_challenge_indicator Object to be assigned

Source
revolut_pay
Source
revolut_pay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] revolut_pay Object to be assigned

Source
risk_correlation_id

The risk correlation ID for an on-session payment using a saved PayPal payment method.

Source
risk_correlation_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] risk_correlation_id Object to be assigned

Source
sepa_debit
Source
sepa_debit=(new_value : Stripe::SetupIntentPaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] sepa_debit Object to be assigned

Source
setup_future_usage

Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method 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 the payment method to a Customer after the transaction completes. If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead. When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

Source
setup_future_usage=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] setup_future_usage Object to be assigned

Source
sofort
Source
sofort=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] sofort Object to be assigned

Source
statement_descriptor_suffix_kana

Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.

Source
statement_descriptor_suffix_kana=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor_suffix_kana Object to be assigned

Source
statement_descriptor_suffix_kanji

Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.

Source
statement_descriptor_suffix_kanji=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor_suffix_kanji Object to be assigned

Source
swish
Source
swish=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] swish Object to be assigned

Source
tos_shown_and_accepted

Confirm that the payer has accepted the P24 terms and conditions.

Source
tos_shown_and_accepted=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tos_shown_and_accepted Object to be assigned

Source
transaction_id

For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).

Source
transaction_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transaction_id Object to be assigned

Source
twint
Source
twint=(new_value : Stripe::PaymentMethodOptionsParamTwint | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] twint Object to be assigned

Source
us_bank_account
Source
us_bank_account=(new_value : Stripe::SetupIntentPaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] us_bank_account Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source
verification_method

Verification method for the intent

Source
verification_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification_method Object to be assigned

Source
version

The version of 3D Secure that was performed.

Source
version=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] version Object to be assigned

Source
wechat_pay
Source
wechat_pay=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] wechat_pay Object to be assigned

Source
zip=(new_value : Stripe::PaymentMethodOptionsParamZip | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] zip Object to be assigned

Source