Class: Stripe::PaymentMethod

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/payment_method.rb

Overview

PaymentMethod objects represent your customer’s payment instruments. You can use them with [PaymentIntents](stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: [Payment Methods](stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](stripe.com/docs/payments/more-payment-scenarios).

Defined Under Namespace

Classes: AcssDebit, Affirm, AfterpayClearpay, Alipay, Alma, AmazonPay, AuBecsDebit, BacsDebit, Bancontact, Billie, BillingDetails, Blik, Boleto, Card, CardPresent, Cashapp, Crypto, CustomerBalance, Eps, Fpx, Giropay, Grabpay, Ideal, InteracPresent, KakaoPay, Klarna, Konbini, KrCard, Link, MbWay, Mobilepay, Multibanco, NaverPay, NzBankAccount, Oxxo, P24, PayByBank, Payco, Paynow, Paypal, Pix, Promptpay, RadarOptions, RevolutPay, SamsungPay, Satispay, SepaDebit, Sofort, Swish, Twint, UsBankAccount, WechatPay, Zip

Constant Summary collapse

OBJECT_NAME = 
"payment_method"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#acss_debit ⇒ Object (readonly)

Attribute for field acss_debit



1360
1361
1362
 
# File 'lib/stripe/resources/payment_method.rb', line 1360

def acss_debit
  @acss_debit
end

#affirm ⇒ Object (readonly)

Attribute for field affirm



1362
1363
1364
 
# File 'lib/stripe/resources/payment_method.rb', line 1362

def affirm
  @affirm
end

#afterpay_clearpay ⇒ Object (readonly)

Attribute for field afterpay_clearpay



1364
1365
1366
 
# File 'lib/stripe/resources/payment_method.rb', line 1364

def afterpay_clearpay
  @afterpay_clearpay
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



1366
1367
1368
 
# File 'lib/stripe/resources/payment_method.rb', line 1366

def alipay
  @alipay
end

#allow_redisplay ⇒ Object (readonly)

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”.



1368
1369
1370
 
# File 'lib/stripe/resources/payment_method.rb', line 1368

def allow_redisplay
  @allow_redisplay
end

#alma ⇒ Object (readonly)

Attribute for field alma



1370
1371
1372
 
# File 'lib/stripe/resources/payment_method.rb', line 1370

def alma
  @alma
end

#amazon_pay ⇒ Object (readonly)

Attribute for field amazon_pay



1372
1373
1374
 
# File 'lib/stripe/resources/payment_method.rb', line 1372

def amazon_pay
  @amazon_pay
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



1374
1375
1376
 
# File 'lib/stripe/resources/payment_method.rb', line 1374

def au_becs_debit
  @au_becs_debit
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



1376
1377
1378
 
# File 'lib/stripe/resources/payment_method.rb', line 1376

def bacs_debit
  @bacs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



1378
1379
1380
 
# File 'lib/stripe/resources/payment_method.rb', line 1378

def bancontact
  @bancontact
end

#billie ⇒ Object (readonly)

Attribute for field billie



1380
1381
1382
 
# File 'lib/stripe/resources/payment_method.rb', line 1380

def billie
  @billie
end

#billing_details ⇒ Object (readonly)

Attribute for field billing_details



1382
1383
1384
 
# File 'lib/stripe/resources/payment_method.rb', line 1382

def billing_details
  @billing_details
end

#blik ⇒ Object (readonly)

Attribute for field blik



1384
1385
1386
 
# File 'lib/stripe/resources/payment_method.rb', line 1384

def blik
  @blik
end

#boleto ⇒ Object (readonly)

Attribute for field boleto



1386
1387
1388
 
# File 'lib/stripe/resources/payment_method.rb', line 1386

def boleto
  @boleto
end

#card ⇒ Object (readonly)

Attribute for field card



1388
1389
1390
 
# File 'lib/stripe/resources/payment_method.rb', line 1388

def card
  @card
end

#card_present ⇒ Object (readonly)

Attribute for field card_present



1390
1391
1392
 
# File 'lib/stripe/resources/payment_method.rb', line 1390

def card_present
  @card_present
end

#cashapp ⇒ Object (readonly)

Attribute for field cashapp



1392
1393
1394
 
# File 'lib/stripe/resources/payment_method.rb', line 1392

def cashapp
  @cashapp
end

#created ⇒ Object (readonly)

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



1394
1395
1396
 
# File 'lib/stripe/resources/payment_method.rb', line 1394

def created
  @created
end

#crypto ⇒ Object (readonly)

Attribute for field crypto



1396
1397
1398
 
# File 'lib/stripe/resources/payment_method.rb', line 1396

def crypto
  @crypto
end

#customer ⇒ Object (readonly)

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.



1398
1399
1400
 
# File 'lib/stripe/resources/payment_method.rb', line 1398

def customer
  @customer
end

#customer_balance ⇒ Object (readonly)

Attribute for field customer_balance



1400
1401
1402
 
# File 'lib/stripe/resources/payment_method.rb', line 1400

def customer_balance
  @customer_balance
end

#eps ⇒ Object (readonly)

Attribute for field eps



1402
1403
1404
 
# File 'lib/stripe/resources/payment_method.rb', line 1402

def eps
  @eps
end

#fpx ⇒ Object (readonly)

Attribute for field fpx



1404
1405
1406
 
# File 'lib/stripe/resources/payment_method.rb', line 1404

def fpx
  @fpx
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



1406
1407
1408
 
# File 'lib/stripe/resources/payment_method.rb', line 1406

def giropay
  @giropay
end

#grabpay ⇒ Object (readonly)

Attribute for field grabpay



1408
1409
1410
 
# File 'lib/stripe/resources/payment_method.rb', line 1408

def grabpay
  @grabpay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1410
1411
1412
 
# File 'lib/stripe/resources/payment_method.rb', line 1410

def id
  @id
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



1412
1413
1414
 
# File 'lib/stripe/resources/payment_method.rb', line 1412

def ideal
  @ideal
end

#interac_present ⇒ Object (readonly)

Attribute for field interac_present



1414
1415
1416
 
# File 'lib/stripe/resources/payment_method.rb', line 1414

def interac_present
  @interac_present
end

#kakao_pay ⇒ Object (readonly)

Attribute for field kakao_pay



1416
1417
1418
 
# File 'lib/stripe/resources/payment_method.rb', line 1416

def kakao_pay
  @kakao_pay
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



1418
1419
1420
 
# File 'lib/stripe/resources/payment_method.rb', line 1418

def klarna
  @klarna
end

#konbini ⇒ Object (readonly)

Attribute for field konbini



1420
1421
1422
 
# File 'lib/stripe/resources/payment_method.rb', line 1420

def konbini
  @konbini
end

#kr_card ⇒ Object (readonly)

Attribute for field kr_card



1422
1423
1424
 
# File 'lib/stripe/resources/payment_method.rb', line 1422

def kr_card
  @kr_card
end

#link ⇒ Object (readonly)

Attribute for field link



1424
1425
1426
 
# File 'lib/stripe/resources/payment_method.rb', line 1424

def link
  @link
end

#livemode ⇒ Object (readonly)

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



1426
1427
1428
 
# File 'lib/stripe/resources/payment_method.rb', line 1426

def livemode
  @livemode
end

#mb_way ⇒ Object (readonly)

Attribute for field mb_way



1428
1429
1430
 
# File 'lib/stripe/resources/payment_method.rb', line 1428

def mb_way
  @mb_way
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](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.



1430
1431
1432
 
# File 'lib/stripe/resources/payment_method.rb', line 1430

def metadata
  @metadata
end

#mobilepay ⇒ Object (readonly)

Attribute for field mobilepay



1432
1433
1434
 
# File 'lib/stripe/resources/payment_method.rb', line 1432

def mobilepay
  @mobilepay
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



1434
1435
1436
 
# File 'lib/stripe/resources/payment_method.rb', line 1434

def multibanco
  @multibanco
end

#naver_pay ⇒ Object (readonly)

Attribute for field naver_pay



1436
1437
1438
 
# File 'lib/stripe/resources/payment_method.rb', line 1436

def naver_pay
  @naver_pay
end

#nz_bank_account ⇒ Object (readonly)

Attribute for field nz_bank_account



1438
1439
1440
 
# File 'lib/stripe/resources/payment_method.rb', line 1438

def 
  @nz_bank_account
end

#object ⇒ Object (readonly)

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



1440
1441
1442
 
# File 'lib/stripe/resources/payment_method.rb', line 1440

def object
  @object
end

#oxxo ⇒ Object (readonly)

Attribute for field oxxo



1442
1443
1444
 
# File 'lib/stripe/resources/payment_method.rb', line 1442

def oxxo
  @oxxo
end

#p24 ⇒ Object (readonly)

Attribute for field p24



1444
1445
1446
 
# File 'lib/stripe/resources/payment_method.rb', line 1444

def p24
  @p24
end

#pay_by_bank ⇒ Object (readonly)

Attribute for field pay_by_bank



1446
1447
1448
 
# File 'lib/stripe/resources/payment_method.rb', line 1446

def pay_by_bank
  @pay_by_bank
end

#payco ⇒ Object (readonly)

Attribute for field payco



1448
1449
1450
 
# File 'lib/stripe/resources/payment_method.rb', line 1448

def payco
  @payco
end

#paynow ⇒ Object (readonly)

Attribute for field paynow



1450
1451
1452
 
# File 'lib/stripe/resources/payment_method.rb', line 1450

def paynow
  @paynow
end

#paypal ⇒ Object (readonly)

Attribute for field paypal



1452
1453
1454
 
# File 'lib/stripe/resources/payment_method.rb', line 1452

def paypal
  @paypal
end

#pix ⇒ Object (readonly)

Attribute for field pix



1454
1455
1456
 
# File 'lib/stripe/resources/payment_method.rb', line 1454

def pix
  @pix
end

#promptpay ⇒ Object (readonly)

Attribute for field promptpay



1456
1457
1458
 
# File 'lib/stripe/resources/payment_method.rb', line 1456

def promptpay
  @promptpay
end

#radar_options ⇒ Object (readonly)

Options to configure Radar. See [Radar Session](stripe.com/docs/radar/radar-session) for more information.



1458
1459
1460
 
# File 'lib/stripe/resources/payment_method.rb', line 1458

def radar_options
  @radar_options
end

#revolut_pay ⇒ Object (readonly)

Attribute for field revolut_pay



1460
1461
1462
 
# File 'lib/stripe/resources/payment_method.rb', line 1460

def revolut_pay
  @revolut_pay
end

#samsung_pay ⇒ Object (readonly)

Attribute for field samsung_pay



1462
1463
1464
 
# File 'lib/stripe/resources/payment_method.rb', line 1462

def samsung_pay
  @samsung_pay
end

#satispay ⇒ Object (readonly)

Attribute for field satispay



1464
1465
1466
 
# File 'lib/stripe/resources/payment_method.rb', line 1464

def satispay
  @satispay
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



1466
1467
1468
 
# File 'lib/stripe/resources/payment_method.rb', line 1466

def sepa_debit
  @sepa_debit
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



1468
1469
1470
 
# File 'lib/stripe/resources/payment_method.rb', line 1468

def sofort
  @sofort
end

#swish ⇒ Object (readonly)

Attribute for field swish



1470
1471
1472
 
# File 'lib/stripe/resources/payment_method.rb', line 1470

def swish
  @swish
end

#twint ⇒ Object (readonly)

Attribute for field twint



1472
1473
1474
 
# File 'lib/stripe/resources/payment_method.rb', line 1472

def twint
  @twint
end

#type ⇒ Object (readonly)

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.



1474
1475
1476
 
# File 'lib/stripe/resources/payment_method.rb', line 1474

def type
  @type
end

#us_bank_account ⇒ Object (readonly)

Attribute for field us_bank_account



1476
1477
1478
 
# File 'lib/stripe/resources/payment_method.rb', line 1476

def 
  @us_bank_account
end

#wechat_pay ⇒ Object (readonly)

Attribute for field wechat_pay



1478
1479
1480
 
# File 'lib/stripe/resources/payment_method.rb', line 1478

def wechat_pay
  @wechat_pay
end

#zip ⇒ Object (readonly)

Attribute for field zip



1480
1481
1482
 
# File 'lib/stripe/resources/payment_method.rb', line 1480

def zip
  @zip
end

Class Method Details

.attach(payment_method, params = {}, opts = {}) ⇒ Object

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](docs.stripe.com/docs/api/setup_intents) or a PaymentIntent with [setup_future_usage](docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See [Optimizing cards for future payments](docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set [invoice_settings.default_payment_method](docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), on the Customer to the PaymentMethod’s ID.



1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/stripe/resources/payment_method.rb', line 1517

def self.attach(payment_method, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_methods/%<payment_method>s/attach", { payment_method: CGI.escape(payment_method) }),
    params: params,
    opts: opts
  )
end

.create(params = {}, opts = {}) ⇒ Object

Creates a PaymentMethod object. Read the [Stripe.js reference](docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href=“/docs/payments/save-and-reuse”>SetupIntent](docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.



1529
1530
1531
 
# File 'lib/stripe/resources/payment_method.rb', line 1529

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/payment_methods", params: params, opts: opts)
end

.detach(payment_method, params = {}, opts = {}) ⇒ Object

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.



1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'lib/stripe/resources/payment_method.rb', line 1544

def self.detach(payment_method, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_methods/%<payment_method>s/detach", { payment_method: CGI.escape(payment_method) }),
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



1626
1627
1628
 
# File 'lib/stripe/resources/payment_method.rb', line 1626

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
 
# File 'lib/stripe/resources/payment_method.rb', line 1568

def self.inner_class_types
  @inner_class_types = {
    acss_debit: AcssDebit,
    affirm: Affirm,
    afterpay_clearpay: AfterpayClearpay,
    alipay: Alipay,
    alma: Alma,
    amazon_pay: AmazonPay,
    au_becs_debit: AuBecsDebit,
    bacs_debit: BacsDebit,
    bancontact: Bancontact,
    billie: Billie,
    billing_details: BillingDetails,
    blik: Blik,
    boleto: Boleto,
    card: Card,
    card_present: CardPresent,
    cashapp: Cashapp,
    crypto: Crypto,
    customer_balance: CustomerBalance,
    eps: Eps,
    fpx: Fpx,
    giropay: Giropay,
    grabpay: Grabpay,
    ideal: Ideal,
    interac_present: InteracPresent,
    kakao_pay: KakaoPay,
    klarna: Klarna,
    konbini: Konbini,
    kr_card: KrCard,
    link: Link,
    mb_way: MbWay,
    mobilepay: Mobilepay,
    multibanco: Multibanco,
    naver_pay: NaverPay,
    nz_bank_account: NzBankAccount,
    oxxo: Oxxo,
    p24: P24,
    pay_by_bank: PayByBank,
    payco: Payco,
    paynow: Paynow,
    paypal: Paypal,
    pix: Pix,
    promptpay: Promptpay,
    radar_options: RadarOptions,
    revolut_pay: RevolutPay,
    samsung_pay: SamsungPay,
    satispay: Satispay,
    sepa_debit: SepaDebit,
    sofort: Sofort,
    swish: Swish,
    twint: Twint,
    us_bank_account: UsBankAccount,
    wechat_pay: WechatPay,
    zip: Zip,
  }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer’s PaymentMethods](docs.stripe.com/docs/api/payment_methods/customer_list) API instead.



1554
1555
1556
 
# File 'lib/stripe/resources/payment_method.rb', line 1554

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/payment_methods", params: params, opts: opts)
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/payment_method.rb', line 16

def self.object_name
  "payment_method"
end

.update(payment_method, params = {}, opts = {}) ⇒ Object

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.



1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/stripe/resources/payment_method.rb', line 1559

def self.update(payment_method, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_methods/%<payment_method>s", { payment_method: CGI.escape(payment_method) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#attach(params = {}, opts = {}) ⇒ Object

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](docs.stripe.com/docs/api/setup_intents) or a PaymentIntent with [setup_future_usage](docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See [Optimizing cards for future payments](docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set [invoice_settings.default_payment_method](docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), on the Customer to the PaymentMethod’s ID.



1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/stripe/resources/payment_method.rb', line 1495

def attach(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_methods/%<payment_method>s/attach", { payment_method: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#detach(params = {}, opts = {}) ⇒ Object

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.



1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/stripe/resources/payment_method.rb', line 1534

def detach(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_methods/%<payment_method>s/detach", { payment_method: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end