Mayson Monorepo Documentation
    Preparing search index...

    Interface PaymentMethod

    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.

    interface PaymentMethod {
        id: string;
        object: "payment_method";
        acss_debit?: Stripe.PaymentMethod.AcssDebit;
        affirm?: Stripe.PaymentMethod.Affirm;
        afterpay_clearpay?: Stripe.PaymentMethod.AfterpayClearpay;
        alipay?: Stripe.PaymentMethod.Alipay;
        allow_redisplay?: Stripe.PaymentMethod.AllowRedisplay;
        alma?: Stripe.PaymentMethod.Alma;
        amazon_pay?: Stripe.PaymentMethod.AmazonPay;
        au_becs_debit?: Stripe.PaymentMethod.AuBecsDebit;
        bacs_debit?: Stripe.PaymentMethod.BacsDebit;
        bancontact?: Stripe.PaymentMethod.Bancontact;
        billie?: Stripe.PaymentMethod.Billie;
        billing_details: Stripe.PaymentMethod.BillingDetails;
        blik?: Stripe.PaymentMethod.Blik;
        boleto?: Stripe.PaymentMethod.Boleto;
        card?: Stripe.PaymentMethod.Card;
        card_present?: Stripe.PaymentMethod.CardPresent;
        cashapp?: Stripe.PaymentMethod.Cashapp;
        created: number;
        crypto?: Stripe.PaymentMethod.Crypto;
        custom?: Stripe.PaymentMethod.Custom;
        customer: string | Stripe.Customer;
        customer_account: string;
        customer_balance?: Stripe.PaymentMethod.CustomerBalance;
        eps?: Stripe.PaymentMethod.Eps;
        fpx?: Stripe.PaymentMethod.Fpx;
        giropay?: Stripe.PaymentMethod.Giropay;
        grabpay?: Stripe.PaymentMethod.Grabpay;
        ideal?: Stripe.PaymentMethod.Ideal;
        interac_present?: Stripe.PaymentMethod.InteracPresent;
        kakao_pay?: Stripe.PaymentMethod.KakaoPay;
        klarna?: Stripe.PaymentMethod.Klarna;
        konbini?: Stripe.PaymentMethod.Konbini;
        kr_card?: Stripe.PaymentMethod.KrCard;
        link?: Stripe.PaymentMethod.Link;
        livemode: boolean;
        mb_way?: Stripe.PaymentMethod.MbWay;
        metadata: Metadata;
        mobilepay?: Stripe.PaymentMethod.Mobilepay;
        multibanco?: Stripe.PaymentMethod.Multibanco;
        naver_pay?: Stripe.PaymentMethod.NaverPay;
        nz_bank_account?: Stripe.PaymentMethod.NzBankAccount;
        oxxo?: Stripe.PaymentMethod.Oxxo;
        p24?: Stripe.PaymentMethod.P24;
        pay_by_bank?: Stripe.PaymentMethod.PayByBank;
        payco?: Stripe.PaymentMethod.Payco;
        paynow?: Stripe.PaymentMethod.Paynow;
        paypal?: Stripe.PaymentMethod.Paypal;
        payto?: Stripe.PaymentMethod.Payto;
        pix?: Stripe.PaymentMethod.Pix;
        promptpay?: Stripe.PaymentMethod.Promptpay;
        radar_options?: Stripe.PaymentMethod.RadarOptions;
        revolut_pay?: Stripe.PaymentMethod.RevolutPay;
        samsung_pay?: Stripe.PaymentMethod.SamsungPay;
        satispay?: Stripe.PaymentMethod.Satispay;
        sepa_debit?: Stripe.PaymentMethod.SepaDebit;
        sofort?: Stripe.PaymentMethod.Sofort;
        swish?: Stripe.PaymentMethod.Swish;
        twint?: Stripe.PaymentMethod.Twint;
        type: Stripe.PaymentMethod.Type;
        us_bank_account?: Stripe.PaymentMethod.UsBankAccount;
        wechat_pay?: Stripe.PaymentMethod.WechatPay;
        zip?: Stripe.PaymentMethod.Zip;
    }
    Index

    Properties

    id object acss_debit? affirm? afterpay_clearpay? alipay? allow_redisplay? alma? amazon_pay? au_becs_debit? bacs_debit? bancontact? billie? billing_details blik? boleto? card? card_present? cashapp? created crypto? custom? customer customer_account customer_balance? eps? fpx? giropay? grabpay? ideal? interac_present? kakao_pay? klarna? konbini? kr_card? link? livemode mb_way? metadata mobilepay? multibanco? naver_pay? nz_bank_account? oxxo? p24? pay_by_bank? payco? paynow? paypal? payto? pix? promptpay? radar_options? revolut_pay? samsung_pay? satispay? sepa_debit? sofort? swish? twint? type us_bank_account? wechat_pay? zip?

    Properties

    id: string

    Unique identifier for the object.

    object: "payment_method"

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

    acss_debit?: Stripe.PaymentMethod.AcssDebit
    affirm?: Stripe.PaymentMethod.Affirm
    afterpay_clearpay?: Stripe.PaymentMethod.AfterpayClearpay
    alipay?: Stripe.PaymentMethod.Alipay
    allow_redisplay?: Stripe.PaymentMethod.AllowRedisplay

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

    alma?: Stripe.PaymentMethod.Alma
    amazon_pay?: Stripe.PaymentMethod.AmazonPay
    au_becs_debit?: Stripe.PaymentMethod.AuBecsDebit
    bacs_debit?: Stripe.PaymentMethod.BacsDebit
    bancontact?: Stripe.PaymentMethod.Bancontact
    billie?: Stripe.PaymentMethod.Billie
    billing_details: Stripe.PaymentMethod.BillingDetails
    blik?: Stripe.PaymentMethod.Blik
    boleto?: Stripe.PaymentMethod.Boleto
    card?: Stripe.PaymentMethod.Card
    card_present?: Stripe.PaymentMethod.CardPresent
    cashapp?: Stripe.PaymentMethod.Cashapp
    created: number

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

    crypto?: Stripe.PaymentMethod.Crypto
    custom?: Stripe.PaymentMethod.Custom
    customer: string | Stripe.Customer

    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.

    customer_account: string
    customer_balance?: Stripe.PaymentMethod.CustomerBalance
    eps?: Stripe.PaymentMethod.Eps
    fpx?: Stripe.PaymentMethod.Fpx
    giropay?: Stripe.PaymentMethod.Giropay
    grabpay?: Stripe.PaymentMethod.Grabpay
    ideal?: Stripe.PaymentMethod.Ideal
    interac_present?: Stripe.PaymentMethod.InteracPresent
    kakao_pay?: Stripe.PaymentMethod.KakaoPay
    klarna?: Stripe.PaymentMethod.Klarna
    konbini?: Stripe.PaymentMethod.Konbini
    kr_card?: Stripe.PaymentMethod.KrCard
    link?: Stripe.PaymentMethod.Link
    livemode: boolean

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

    mb_way?: Stripe.PaymentMethod.MbWay
    metadata: Metadata

    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.

    mobilepay?: Stripe.PaymentMethod.Mobilepay
    multibanco?: Stripe.PaymentMethod.Multibanco
    naver_pay?: Stripe.PaymentMethod.NaverPay
    nz_bank_account?: Stripe.PaymentMethod.NzBankAccount
    oxxo?: Stripe.PaymentMethod.Oxxo
    p24?: Stripe.PaymentMethod.P24
    pay_by_bank?: Stripe.PaymentMethod.PayByBank
    payco?: Stripe.PaymentMethod.Payco
    paynow?: Stripe.PaymentMethod.Paynow
    paypal?: Stripe.PaymentMethod.Paypal
    payto?: Stripe.PaymentMethod.Payto
    pix?: Stripe.PaymentMethod.Pix
    promptpay?: Stripe.PaymentMethod.Promptpay
    radar_options?: Stripe.PaymentMethod.RadarOptions

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

    revolut_pay?: Stripe.PaymentMethod.RevolutPay
    samsung_pay?: Stripe.PaymentMethod.SamsungPay
    satispay?: Stripe.PaymentMethod.Satispay
    sepa_debit?: Stripe.PaymentMethod.SepaDebit
    sofort?: Stripe.PaymentMethod.Sofort
    swish?: Stripe.PaymentMethod.Swish
    twint?: Stripe.PaymentMethod.Twint
    type: Stripe.PaymentMethod.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.

    us_bank_account?: Stripe.PaymentMethod.UsBankAccount
    wechat_pay?: Stripe.PaymentMethod.WechatPay
    zip?: Stripe.PaymentMethod.Zip

    Settings

    Member Visibility

    On This Page

    Properties