Mayson Monorepo Documentation
    Preparing search index...

    Interface PaymentMethodConfiguration

    PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.

    There are two types of PaymentMethodConfigurations. Which is used depends on the charge type:

    Direct configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.

    Child configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.

    Child configurations have a parent that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account's associated child configuration. Parent configurations are managed in the dashboard and are not available in this API.

    Related guides:

    interface PaymentMethodConfiguration {
        id: string;
        object: "payment_method_configuration";
        acss_debit?: Stripe.PaymentMethodConfiguration.AcssDebit;
        active: boolean;
        affirm?: Stripe.PaymentMethodConfiguration.Affirm;
        afterpay_clearpay?: Stripe.PaymentMethodConfiguration.AfterpayClearpay;
        alipay?: Stripe.PaymentMethodConfiguration.Alipay;
        alma?: Stripe.PaymentMethodConfiguration.Alma;
        amazon_pay?: Stripe.PaymentMethodConfiguration.AmazonPay;
        apple_pay?: Stripe.PaymentMethodConfiguration.ApplePay;
        application: string;
        au_becs_debit?: Stripe.PaymentMethodConfiguration.AuBecsDebit;
        bacs_debit?: Stripe.PaymentMethodConfiguration.BacsDebit;
        bancontact?: Stripe.PaymentMethodConfiguration.Bancontact;
        billie?: Stripe.PaymentMethodConfiguration.Billie;
        blik?: Stripe.PaymentMethodConfiguration.Blik;
        boleto?: Stripe.PaymentMethodConfiguration.Boleto;
        card?: Stripe.PaymentMethodConfiguration.Card;
        cartes_bancaires?: Stripe.PaymentMethodConfiguration.CartesBancaires;
        cashapp?: Stripe.PaymentMethodConfiguration.Cashapp;
        crypto?: Stripe.PaymentMethodConfiguration.Crypto;
        customer_balance?: Stripe.PaymentMethodConfiguration.CustomerBalance;
        eps?: Stripe.PaymentMethodConfiguration.Eps;
        fpx?: Stripe.PaymentMethodConfiguration.Fpx;
        giropay?: Stripe.PaymentMethodConfiguration.Giropay;
        google_pay?: Stripe.PaymentMethodConfiguration.GooglePay;
        grabpay?: Stripe.PaymentMethodConfiguration.Grabpay;
        ideal?: Stripe.PaymentMethodConfiguration.Ideal;
        is_default: boolean;
        jcb?: Stripe.PaymentMethodConfiguration.Jcb;
        kakao_pay?: Stripe.PaymentMethodConfiguration.KakaoPay;
        klarna?: Stripe.PaymentMethodConfiguration.Klarna;
        konbini?: Stripe.PaymentMethodConfiguration.Konbini;
        kr_card?: Stripe.PaymentMethodConfiguration.KrCard;
        link?: Stripe.PaymentMethodConfiguration.Link;
        livemode: boolean;
        mb_way?: Stripe.PaymentMethodConfiguration.MbWay;
        mobilepay?: Stripe.PaymentMethodConfiguration.Mobilepay;
        multibanco?: Stripe.PaymentMethodConfiguration.Multibanco;
        name: string;
        naver_pay?: Stripe.PaymentMethodConfiguration.NaverPay;
        nz_bank_account?: Stripe.PaymentMethodConfiguration.NzBankAccount;
        oxxo?: Stripe.PaymentMethodConfiguration.Oxxo;
        p24?: Stripe.PaymentMethodConfiguration.P24;
        parent: string;
        pay_by_bank?: Stripe.PaymentMethodConfiguration.PayByBank;
        payco?: Stripe.PaymentMethodConfiguration.Payco;
        paynow?: Stripe.PaymentMethodConfiguration.Paynow;
        paypal?: Stripe.PaymentMethodConfiguration.Paypal;
        payto?: Stripe.PaymentMethodConfiguration.Payto;
        pix?: Stripe.PaymentMethodConfiguration.Pix;
        promptpay?: Stripe.PaymentMethodConfiguration.Promptpay;
        revolut_pay?: Stripe.PaymentMethodConfiguration.RevolutPay;
        samsung_pay?: Stripe.PaymentMethodConfiguration.SamsungPay;
        satispay?: Stripe.PaymentMethodConfiguration.Satispay;
        sepa_debit?: Stripe.PaymentMethodConfiguration.SepaDebit;
        sofort?: Stripe.PaymentMethodConfiguration.Sofort;
        swish?: Stripe.PaymentMethodConfiguration.Swish;
        twint?: Stripe.PaymentMethodConfiguration.Twint;
        us_bank_account?: Stripe.PaymentMethodConfiguration.UsBankAccount;
        wechat_pay?: Stripe.PaymentMethodConfiguration.WechatPay;
        zip?: Stripe.PaymentMethodConfiguration.Zip;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "payment_method_configuration"

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

    active: boolean

    Whether the configuration can be used for new payments.

    application: string

    For child configs, the Connect application associated with the configuration.

    is_default: boolean

    The default configuration is used whenever a payment method configuration is not specified.

    livemode: boolean

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

    name: string

    The configuration's name.

    parent: string

    For child configs, the configuration's parent configuration.