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 to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Defined Under Namespace

Classes: AcssDebit, Affirm, AfterpayClearpay, Alipay, Alma, AmazonPay, AuBecsDebit, BacsDebit, Bancontact, Billie, BillingDetails, Bizum, Blik, Boleto, Card, CardPresent, Cashapp, Crypto, Custom, CustomerBalance, Eps, Fpx, GiftCard, Giropay, Gopay, Grabpay, IdBankTransfer, Ideal, InteracPresent, KakaoPay, Klarna, Konbini, KrCard, Link, MbWay, Mobilepay, Multibanco, NaverPay, NzBankAccount, Oxxo, P24, PayByBank, Payco, Paynow, Paypal, Paypay, Payto, Pix, Promptpay, Qris, RadarOptions, Rechnung, Redaction, RevolutPay, SamsungPay, Satispay, Scalapay, SepaDebit, Shopeepay, Sofort, StripeBalance, Sunbit, Swish, Tamara, Twint, Upi, UsBankAccount, Vipps, 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?, field_encodings, #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



1692
1693
1694
 
# File 'lib/stripe/resources/payment_method.rb', line 1692

def acss_debit
  @acss_debit
end

#affirm ⇒ Object (readonly)

Attribute for field affirm



1694
1695
1696
 
# File 'lib/stripe/resources/payment_method.rb', line 1694

def affirm
  @affirm
end

#afterpay_clearpay ⇒ Object (readonly)

Attribute for field afterpay_clearpay



1696
1697
1698
 
# File 'lib/stripe/resources/payment_method.rb', line 1696

def afterpay_clearpay
  @afterpay_clearpay
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



1698
1699
1700
 
# File 'lib/stripe/resources/payment_method.rb', line 1698

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



1700
1701
1702
 
# File 'lib/stripe/resources/payment_method.rb', line 1700

def allow_redisplay
  @allow_redisplay
end

#alma ⇒ Object (readonly)

Attribute for field alma



1702
1703
1704
 
# File 'lib/stripe/resources/payment_method.rb', line 1702

def alma
  @alma
end

#amazon_pay ⇒ Object (readonly)

Attribute for field amazon_pay



1704
1705
1706
 
# File 'lib/stripe/resources/payment_method.rb', line 1704

def amazon_pay
  @amazon_pay
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



1706
1707
1708
 
# File 'lib/stripe/resources/payment_method.rb', line 1706

def au_becs_debit
  @au_becs_debit
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



1708
1709
1710
 
# File 'lib/stripe/resources/payment_method.rb', line 1708

def bacs_debit
  @bacs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



1710
1711
1712
 
# File 'lib/stripe/resources/payment_method.rb', line 1710

def bancontact
  @bancontact
end

#billie ⇒ Object (readonly)

Attribute for field billie



1712
1713
1714
 
# File 'lib/stripe/resources/payment_method.rb', line 1712

def billie
  @billie
end

#billing_details ⇒ Object (readonly)

Attribute for field billing_details



1714
1715
1716
 
# File 'lib/stripe/resources/payment_method.rb', line 1714

def billing_details
  @billing_details
end

#bizum ⇒ Object (readonly)

Attribute for field bizum



1716
1717
1718
 
# File 'lib/stripe/resources/payment_method.rb', line 1716

def bizum
  @bizum
end

#blik ⇒ Object (readonly)

Attribute for field blik



1718
1719
1720
 
# File 'lib/stripe/resources/payment_method.rb', line 1718

def blik
  @blik
end

#boleto ⇒ Object (readonly)

Attribute for field boleto



1720
1721
1722
 
# File 'lib/stripe/resources/payment_method.rb', line 1720

def boleto
  @boleto
end

#card ⇒ Object (readonly)

Attribute for field card



1722
1723
1724
 
# File 'lib/stripe/resources/payment_method.rb', line 1722

def card
  @card
end

#card_present ⇒ Object (readonly)

Attribute for field card_present



1724
1725
1726
 
# File 'lib/stripe/resources/payment_method.rb', line 1724

def card_present
  @card_present
end

#cashapp ⇒ Object (readonly)

Attribute for field cashapp



1726
1727
1728
 
# File 'lib/stripe/resources/payment_method.rb', line 1726

def cashapp
  @cashapp
end

#created ⇒ Object (readonly)

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



1728
1729
1730
 
# File 'lib/stripe/resources/payment_method.rb', line 1728

def created
  @created
end

#crypto ⇒ Object (readonly)

Attribute for field crypto



1730
1731
1732
 
# File 'lib/stripe/resources/payment_method.rb', line 1730

def crypto
  @crypto
end

#custom ⇒ Object (readonly)

Attribute for field custom



1732
1733
1734
 
# File 'lib/stripe/resources/payment_method.rb', line 1732

def custom
  @custom
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.



1734
1735
1736
 
# File 'lib/stripe/resources/payment_method.rb', line 1734

def customer
  @customer
end

#customer_account ⇒ Object (readonly)

Attribute for field customer_account



1736
1737
1738
 
# File 'lib/stripe/resources/payment_method.rb', line 1736

def 
  @customer_account
end

#customer_balance ⇒ Object (readonly)

Attribute for field customer_balance



1738
1739
1740
 
# File 'lib/stripe/resources/payment_method.rb', line 1738

def customer_balance
  @customer_balance
end

#eps ⇒ Object (readonly)

Attribute for field eps



1740
1741
1742
 
# File 'lib/stripe/resources/payment_method.rb', line 1740

def eps
  @eps
end

#fpx ⇒ Object (readonly)

Attribute for field fpx



1742
1743
1744
 
# File 'lib/stripe/resources/payment_method.rb', line 1742

def fpx
  @fpx
end

#gift_card ⇒ Object (readonly)

Attribute for field gift_card



1744
1745
1746
 
# File 'lib/stripe/resources/payment_method.rb', line 1744

def gift_card
  @gift_card
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



1746
1747
1748
 
# File 'lib/stripe/resources/payment_method.rb', line 1746

def giropay
  @giropay
end

#gopay ⇒ Object (readonly)

Attribute for field gopay



1748
1749
1750
 
# File 'lib/stripe/resources/payment_method.rb', line 1748

def gopay
  @gopay
end

#grabpay ⇒ Object (readonly)

Attribute for field grabpay



1750
1751
1752
 
# File 'lib/stripe/resources/payment_method.rb', line 1750

def grabpay
  @grabpay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1752
1753
1754
 
# File 'lib/stripe/resources/payment_method.rb', line 1752

def id
  @id
end

#id_bank_transfer ⇒ Object (readonly)

Attribute for field id_bank_transfer



1754
1755
1756
 
# File 'lib/stripe/resources/payment_method.rb', line 1754

def id_bank_transfer
  @id_bank_transfer
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



1756
1757
1758
 
# File 'lib/stripe/resources/payment_method.rb', line 1756

def ideal
  @ideal
end

#interac_present ⇒ Object (readonly)

Attribute for field interac_present



1758
1759
1760
 
# File 'lib/stripe/resources/payment_method.rb', line 1758

def interac_present
  @interac_present
end

#kakao_pay ⇒ Object (readonly)

Attribute for field kakao_pay



1760
1761
1762
 
# File 'lib/stripe/resources/payment_method.rb', line 1760

def kakao_pay
  @kakao_pay
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



1762
1763
1764
 
# File 'lib/stripe/resources/payment_method.rb', line 1762

def klarna
  @klarna
end

#konbini ⇒ Object (readonly)

Attribute for field konbini



1764
1765
1766
 
# File 'lib/stripe/resources/payment_method.rb', line 1764

def konbini
  @konbini
end

#kr_card ⇒ Object (readonly)

Attribute for field kr_card



1766
1767
1768
 
# File 'lib/stripe/resources/payment_method.rb', line 1766

def kr_card
  @kr_card
end

#latest_active_mandate ⇒ Object (readonly)

The Mandate object of the most recently created Mandate associated with this payment method



1768
1769
1770
 
# File 'lib/stripe/resources/payment_method.rb', line 1768

def latest_active_mandate
  @latest_active_mandate
end

#link ⇒ Object (readonly)

Attribute for field link



1770
1771
1772
 
# File 'lib/stripe/resources/payment_method.rb', line 1770

def link
  @link
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



1772
1773
1774
 
# File 'lib/stripe/resources/payment_method.rb', line 1772

def livemode
  @livemode
end

#mb_way ⇒ Object (readonly)

Attribute for field mb_way



1774
1775
1776
 
# File 'lib/stripe/resources/payment_method.rb', line 1774

def mb_way
  @mb_way
end

#metadata ⇒ Object (readonly)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



1776
1777
1778
 
# File 'lib/stripe/resources/payment_method.rb', line 1776

def metadata
  @metadata
end

#mobilepay ⇒ Object (readonly)

Attribute for field mobilepay



1778
1779
1780
 
# File 'lib/stripe/resources/payment_method.rb', line 1778

def mobilepay
  @mobilepay
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



1780
1781
1782
 
# File 'lib/stripe/resources/payment_method.rb', line 1780

def multibanco
  @multibanco
end

#naver_pay ⇒ Object (readonly)

Attribute for field naver_pay



1782
1783
1784
 
# File 'lib/stripe/resources/payment_method.rb', line 1782

def naver_pay
  @naver_pay
end

#nz_bank_account ⇒ Object (readonly)

Attribute for field nz_bank_account



1784
1785
1786
 
# File 'lib/stripe/resources/payment_method.rb', line 1784

def 
  @nz_bank_account
end

#object ⇒ Object (readonly)

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



1786
1787
1788
 
# File 'lib/stripe/resources/payment_method.rb', line 1786

def object
  @object
end

#oxxo ⇒ Object (readonly)

Attribute for field oxxo



1788
1789
1790
 
# File 'lib/stripe/resources/payment_method.rb', line 1788

def oxxo
  @oxxo
end

#p24 ⇒ Object (readonly)

Attribute for field p24



1790
1791
1792
 
# File 'lib/stripe/resources/payment_method.rb', line 1790

def p24
  @p24
end

#pay_by_bank ⇒ Object (readonly)

Attribute for field pay_by_bank



1792
1793
1794
 
# File 'lib/stripe/resources/payment_method.rb', line 1792

def pay_by_bank
  @pay_by_bank
end

#payco ⇒ Object (readonly)

Attribute for field payco



1794
1795
1796
 
# File 'lib/stripe/resources/payment_method.rb', line 1794

def payco
  @payco
end

#paynow ⇒ Object (readonly)

Attribute for field paynow



1796
1797
1798
 
# File 'lib/stripe/resources/payment_method.rb', line 1796

def paynow
  @paynow
end

#paypal ⇒ Object (readonly)

Attribute for field paypal



1798
1799
1800
 
# File 'lib/stripe/resources/payment_method.rb', line 1798

def paypal
  @paypal
end

#paypay ⇒ Object (readonly)

Attribute for field paypay



1800
1801
1802
 
# File 'lib/stripe/resources/payment_method.rb', line 1800

def paypay
  @paypay
end

#payto ⇒ Object (readonly)

Attribute for field payto



1802
1803
1804
 
# File 'lib/stripe/resources/payment_method.rb', line 1802

def payto
  @payto
end

#pix ⇒ Object (readonly)

Attribute for field pix



1804
1805
1806
 
# File 'lib/stripe/resources/payment_method.rb', line 1804

def pix
  @pix
end

#promptpay ⇒ Object (readonly)

Attribute for field promptpay



1806
1807
1808
 
# File 'lib/stripe/resources/payment_method.rb', line 1806

def promptpay
  @promptpay
end

#qris ⇒ Object (readonly)

Attribute for field qris



1808
1809
1810
 
# File 'lib/stripe/resources/payment_method.rb', line 1808

def qris
  @qris
end

#radar_options ⇒ Object (readonly)

Options to configure Radar. See Radar Session for more information.



1810
1811
1812
 
# File 'lib/stripe/resources/payment_method.rb', line 1810

def radar_options
  @radar_options
end

#rechnung ⇒ Object (readonly)

Attribute for field rechnung



1812
1813
1814
 
# File 'lib/stripe/resources/payment_method.rb', line 1812

def rechnung
  @rechnung
end

#redaction ⇒ Object (readonly)

Redaction status of this PaymentMethod. If the PaymentMethod is not redacted, this field will be null.



1814
1815
1816
 
# File 'lib/stripe/resources/payment_method.rb', line 1814

def redaction
  @redaction
end

#revolut_pay ⇒ Object (readonly)

Attribute for field revolut_pay



1816
1817
1818
 
# File 'lib/stripe/resources/payment_method.rb', line 1816

def revolut_pay
  @revolut_pay
end

#samsung_pay ⇒ Object (readonly)

Attribute for field samsung_pay



1818
1819
1820
 
# File 'lib/stripe/resources/payment_method.rb', line 1818

def samsung_pay
  @samsung_pay
end

#satispay ⇒ Object (readonly)

Attribute for field satispay



1820
1821
1822
 
# File 'lib/stripe/resources/payment_method.rb', line 1820

def satispay
  @satispay
end

#scalapay ⇒ Object (readonly)

Attribute for field scalapay



1822
1823
1824
 
# File 'lib/stripe/resources/payment_method.rb', line 1822

def scalapay
  @scalapay
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



1824
1825
1826
 
# File 'lib/stripe/resources/payment_method.rb', line 1824

def sepa_debit
  @sepa_debit
end

#shared_payment_granted_token ⇒ Object (readonly)

ID of the shared payment granted token used in the creation of this PaymentMethod.



1826
1827
1828
 
# File 'lib/stripe/resources/payment_method.rb', line 1826

def shared_payment_granted_token
  @shared_payment_granted_token
end

#shopeepay ⇒ Object (readonly)

Attribute for field shopeepay



1828
1829
1830
 
# File 'lib/stripe/resources/payment_method.rb', line 1828

def shopeepay
  @shopeepay
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



1830
1831
1832
 
# File 'lib/stripe/resources/payment_method.rb', line 1830

def sofort
  @sofort
end

#stripe_balance ⇒ Object (readonly)

Attribute for field stripe_balance



1832
1833
1834
 
# File 'lib/stripe/resources/payment_method.rb', line 1832

def stripe_balance
  @stripe_balance
end

#sunbit ⇒ Object (readonly)

Attribute for field sunbit



1834
1835
1836
 
# File 'lib/stripe/resources/payment_method.rb', line 1834

def sunbit
  @sunbit
end

#swish ⇒ Object (readonly)

Attribute for field swish



1836
1837
1838
 
# File 'lib/stripe/resources/payment_method.rb', line 1836

def swish
  @swish
end

#tamara ⇒ Object (readonly)

Attribute for field tamara



1838
1839
1840
 
# File 'lib/stripe/resources/payment_method.rb', line 1838

def tamara
  @tamara
end

#twint ⇒ Object (readonly)

Attribute for field twint



1840
1841
1842
 
# File 'lib/stripe/resources/payment_method.rb', line 1840

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.



1842
1843
1844
 
# File 'lib/stripe/resources/payment_method.rb', line 1842

def type
  @type
end

#upi ⇒ Object (readonly)

Attribute for field upi



1844
1845
1846
 
# File 'lib/stripe/resources/payment_method.rb', line 1844

def upi
  @upi
end

#us_bank_account ⇒ Object (readonly)

Attribute for field us_bank_account



1846
1847
1848
 
# File 'lib/stripe/resources/payment_method.rb', line 1846

def 
  @us_bank_account
end

#vipps ⇒ Object (readonly)

Attribute for field vipps



1848
1849
1850
 
# File 'lib/stripe/resources/payment_method.rb', line 1848

def vipps
  @vipps
end

#wechat_pay ⇒ Object (readonly)

Attribute for field wechat_pay



1850
1851
1852
 
# File 'lib/stripe/resources/payment_method.rb', line 1850

def wechat_pay
  @wechat_pay
end

#zip ⇒ Object (readonly)

Attribute for field zip



1852
1853
1854
 
# File 'lib/stripe/resources/payment_method.rb', line 1852

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 or a PaymentIntent with 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 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, on the Customer to the PaymentMethod's ID.



1889
1890
1891
1892
1893
1894
1895
1896
 
# File 'lib/stripe/resources/payment_method.rb', line 1889

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

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

Retrieves a PaymentMethod's Balance.



1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/stripe/resources/payment_method.rb', line 1909

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

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

Creates a PaymentMethod object. Read the Stripe.js reference 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 SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.



1921
1922
1923
 
# File 'lib/stripe/resources/payment_method.rb', line 1921

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. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.



1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'lib/stripe/resources/payment_method.rb', line 1936

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 



2035
2036
2037
 
# File 'lib/stripe/resources/payment_method.rb', line 2035

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/stripe/resources/payment_method.rb', line 1960

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,
    bizum: Bizum,
    blik: Blik,
    boleto: Boleto,
    card: Card,
    card_present: CardPresent,
    cashapp: Cashapp,
    crypto: Crypto,
    custom: Custom,
    customer_balance: CustomerBalance,
    eps: Eps,
    fpx: Fpx,
    gift_card: GiftCard,
    giropay: Giropay,
    gopay: Gopay,
    grabpay: Grabpay,
    id_bank_transfer: IdBankTransfer,
    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,
    paypay: Paypay,
    payto: Payto,
    pix: Pix,
    promptpay: Promptpay,
    qris: Qris,
    radar_options: RadarOptions,
    rechnung: Rechnung,
    redaction: Redaction,
    revolut_pay: RevolutPay,
    samsung_pay: SamsungPay,
    satispay: Satispay,
    scalapay: Scalapay,
    sepa_debit: SepaDebit,
    shopeepay: Shopeepay,
    sofort: Sofort,
    stripe_balance: StripeBalance,
    sunbit: Sunbit,
    swish: Swish,
    tamara: Tamara,
    twint: Twint,
    upi: Upi,
    us_bank_account: UsBankAccount,
    vipps: Vipps,
    wechat_pay: WechatPay,
    zip: Zip,
  }
end

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

Returns a list of all PaymentMethods.



1946
1947
1948
 
# File 'lib/stripe/resources/payment_method.rb', line 1946

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.



1951
1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/stripe/resources/payment_method.rb', line 1951

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 or a PaymentIntent with 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 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, on the Customer to the PaymentMethod's ID.



1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'lib/stripe/resources/payment_method.rb', line 1867

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

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

Retrieves a PaymentMethod's Balance.



1899
1900
1901
1902
1903
1904
1905
1906
 
# File 'lib/stripe/resources/payment_method.rb', line 1899

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

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

Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.



1926
1927
1928
1929
1930
1931
1932
1933
 
# File 'lib/stripe/resources/payment_method.rb', line 1926

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