class

Stripe::PaymentMethod

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

PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: Payment Methods and More Payment Scenarios.

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [acss_debit, affirm, afterpay_clearpay, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, card_present, cashapp, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, klarna, konbini, link, mobilepay, multibanco, oxxo, p24, paynow, paypal, pix, promptpay, revolut_pay, sepa_debit, sofort, swish, twint, us_bank_account, wechat_pay, zip]."

ERROR_MESSAGE_FOR_ALLOW_REDISPLAY = "invalid value for \"allow_redisplay\", must be one of [always, limited, unspecified]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [payment_method]."

MAX_LENGTH_FOR_ID = 5000

VALID_VALUES_FOR__TYPE = String.static_array("acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "card_present", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip")

VALID_VALUES_FOR_ALLOW_REDISPLAY = String.static_array("always", "limited", "unspecified")

VALID_VALUES_FOR_OBJECT = String.static_array("payment_method")

Constructors

new(pull : JSON::PullParser)

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

new(*, billing_details : Stripe::BillingDetails | Nil = nil, created : Int64 | Nil = nil, customer : Stripe::ConfirmationTokensResourcePaymentMethodPreviewCustomer | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, _type : String | Nil = nil, acss_debit : Stripe::PaymentMethodAcssDebit | Nil = nil, affirm : JSON::Any | Nil = nil, afterpay_clearpay : JSON::Any | Nil = nil, alipay : JSON::Any | Nil = nil, allow_redisplay : String | Nil = nil, amazon_pay : JSON::Any | Nil = nil, au_becs_debit : Stripe::PaymentMethodAuBecsDebit | Nil = nil, bacs_debit : Stripe::PaymentMethodBacsDebit | Nil = nil, bancontact : JSON::Any | Nil = nil, blik : JSON::Any | Nil = nil, boleto : Stripe::PaymentMethodBoleto | Nil = nil, card : Stripe::PaymentMethodCard | Nil = nil, card_present2 : Stripe::PaymentMethodCardPresent | Nil = nil, cashapp : Stripe::PaymentMethodCashapp | Nil = nil, customer_balance : JSON::Any | Nil = nil, eps : Stripe::PaymentMethodEps | Nil = nil, fpx : Stripe::PaymentMethodFpx | Nil = nil, giropay : JSON::Any | Nil = nil, grabpay : JSON::Any | Nil = nil, ideal : Stripe::PaymentMethodIdeal | Nil = nil, interac_present : Stripe::PaymentMethodInteracPresent | Nil = nil, klarna : Stripe::PaymentMethodKlarna | Nil = nil, konbini : JSON::Any | Nil = nil, link : Stripe::PaymentMethodLink | Nil = nil, mobilepay : JSON::Any | Nil = nil, multibanco : JSON::Any | Nil = nil, oxxo : JSON::Any | Nil = nil, p24 : Stripe::PaymentMethodP24 | Nil = nil, paynow : JSON::Any | Nil = nil, paypal : Stripe::PaymentMethodPaypal | Nil = nil, pix : JSON::Any | Nil = nil, promptpay : JSON::Any | Nil = nil, radar_options : Stripe::RadarRadarOptions | Nil = nil, revolut_pay : JSON::Any | Nil = nil, sepa_debit : Stripe::PaymentMethodSepaDebit | Nil = nil, sofort : Stripe::PaymentMethodSofort | Nil = nil, swish : JSON::Any | Nil = nil, twint : JSON::Any | Nil = nil, us_bank_account : Stripe::PaymentMethodUsBankAccount | Nil = nil, wechat_pay : JSON::Any | Nil = nil, zip : JSON::Any | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

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

_type

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

_type=(new_value : String | Nil)

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

acss_debit

acss_debit=(new_value : Stripe::PaymentMethodAcssDebit | Nil)

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

affirm

affirm=(new_value : JSON::Any | Nil)

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

afterpay_clearpay

afterpay_clearpay=(new_value : JSON::Any | Nil)

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

alipay

alipay=(new_value : JSON::Any | Nil)

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

allow_redisplay

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

allow_redisplay=(new_value : String | Nil)

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

amazon_pay

amazon_pay=(new_value : JSON::Any | Nil)

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

au_becs_debit

au_becs_debit=(new_value : Stripe::PaymentMethodAuBecsDebit | Nil)

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

bacs_debit

bacs_debit=(new_value : Stripe::PaymentMethodBacsDebit | Nil)

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

bancontact

bancontact=(new_value : JSON::Any | Nil)

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

billing_details

billing_details=(new_value : Stripe::BillingDetails | Nil)

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

blik

blik=(new_value : JSON::Any | Nil)

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

boleto

boleto=(new_value : Stripe::PaymentMethodBoleto | Nil)

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

card

card=(new_value : Stripe::PaymentMethodCard | Nil)

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

card_present

card_present=(new_value : Stripe::PaymentMethodCardPresent | Nil)

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

cashapp

cashapp=(new_value : Stripe::PaymentMethodCashapp | Nil)

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

created

Time at which the object was created. Measured in seconds since the Unix epoch.

created=(new_value : Int64 | Nil)

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

customer

customer=(new_value : Stripe::ConfirmationTokensResourcePaymentMethodPreviewCustomer | Nil)

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

customer_balance

customer_balance=(new_value : JSON::Any | Nil)

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

eps

eps=(new_value : Stripe::PaymentMethodEps | Nil)

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

fpx

fpx=(new_value : Stripe::PaymentMethodFpx | Nil)

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

giropay

giropay=(new_value : JSON::Any | Nil)

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

grabpay

grabpay=(new_value : JSON::Any | Nil)

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

hash(hasher)

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

id

Unique identifier for the object.

id=(new_value : String | Nil)

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

ideal

ideal=(new_value : Stripe::PaymentMethodIdeal | Nil)

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

interac_present

interac_present=(new_value : Stripe::PaymentMethodInteracPresent | Nil)

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

klarna

klarna=(new_value : Stripe::PaymentMethodKlarna | Nil)

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

konbini

konbini=(new_value : JSON::Any | Nil)

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

link

link=(new_value : Stripe::PaymentMethodLink | Nil)

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

list_invalid_properties

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

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

livemode=(new_value : Bool | Nil)

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

metadata

metadata=(new_value : Hash(String, String) | Nil)

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

mobilepay

mobilepay=(new_value : JSON::Any | Nil)

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

multibanco

multibanco=(new_value : JSON::Any | Nil)

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

object

String representing the object's type. Objects of the same type share the same value.

object=(new_value : String | Nil)

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

oxxo

oxxo=(new_value : JSON::Any | Nil)

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

p24

p24=(new_value : Stripe::PaymentMethodP24 | Nil)

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

paynow

paynow=(new_value : JSON::Any | Nil)

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

paypal

paypal=(new_value : Stripe::PaymentMethodPaypal | Nil)

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

pix

pix=(new_value : JSON::Any | Nil)

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

promptpay

promptpay=(new_value : JSON::Any | Nil)

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

radar_options

radar_options=(new_value : Stripe::RadarRadarOptions | Nil)

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

revolut_pay

revolut_pay=(new_value : JSON::Any | Nil)

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

sepa_debit

sepa_debit=(new_value : Stripe::PaymentMethodSepaDebit | Nil)

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

sofort

sofort=(new_value : Stripe::PaymentMethodSofort | Nil)

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

swish

swish=(new_value : JSON::Any | Nil)

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

twint

twint=(new_value : JSON::Any | Nil)

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

us_bank_account

us_bank_account=(new_value : Stripe::PaymentMethodUsBankAccount | Nil)

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

valid?

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

wechat_pay

wechat_pay=(new_value : JSON::Any | Nil)

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

zip

zip=(new_value : JSON::Any | Nil)

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