Mayson Monorepo Documentation
    Preparing search index...

    Source objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

    Stripe doesn't recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.

    Related guides: Sources API and Sources & Customers.

    interface Source {
        id: string;
        object: "source";
        ach_credit_transfer?: Stripe.Source.AchCreditTransfer;
        ach_debit?: Stripe.Source.AchDebit;
        acss_debit?: Stripe.Source.AcssDebit;
        alipay?: Stripe.Source.Alipay;
        allow_redisplay: Stripe.Source.AllowRedisplay;
        amount: number;
        au_becs_debit?: Stripe.Source.AuBecsDebit;
        bancontact?: Stripe.Source.Bancontact;
        card?: Stripe.Source.Card;
        card_present?: Stripe.Source.CardPresent;
        client_secret: string;
        code_verification?: CodeVerification;
        created: number;
        currency: string;
        customer?: string;
        eps?: Stripe.Source.Eps;
        flow: string;
        giropay?: Stripe.Source.Giropay;
        ideal?: Stripe.Source.Ideal;
        klarna?: Stripe.Source.Klarna;
        livemode: boolean;
        metadata: Metadata;
        multibanco?: Stripe.Source.Multibanco;
        owner: Stripe.Source.Owner;
        p24?: Stripe.Source.P24;
        receiver?: Stripe.Source.Receiver;
        redirect?: Stripe.Source.Redirect;
        sepa_credit_transfer?: Stripe.Source.SepaCreditTransfer;
        sepa_debit?: Stripe.Source.SepaDebit;
        sofort?: Stripe.Source.Sofort;
        source_order?: Stripe.Source.SourceOrder;
        statement_descriptor: string;
        status: string;
        three_d_secure?: Stripe.Source.ThreeDSecure;
        type: Stripe.Source.Type;
        usage: string;
        wechat?: Stripe.Source.Wechat;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "source"

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

    ach_credit_transfer?: Stripe.Source.AchCreditTransfer
    ach_debit?: Stripe.Source.AchDebit
    acss_debit?: Stripe.Source.AcssDebit
    allow_redisplay: Stripe.Source.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”.

    amount: number

    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.

    au_becs_debit?: Stripe.Source.AuBecsDebit
    bancontact?: Stripe.Source.Bancontact
    card_present?: Stripe.Source.CardPresent
    client_secret: string

    The client secret of the source. Used for client-side retrieval using a publishable key.

    code_verification?: CodeVerification
    created: number

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

    currency: string

    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.

    customer?: string

    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.

    flow: string

    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.

    livemode: boolean

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

    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.

    multibanco?: Stripe.Source.Multibanco

    Information about the owner of the payment instrument that may be used or required by particular source types.

    sepa_credit_transfer?: Stripe.Source.SepaCreditTransfer
    sepa_debit?: Stripe.Source.SepaDebit
    source_order?: Stripe.Source.SourceOrder
    statement_descriptor: string

    Extra information about a source. This will appear on your customer's statement every time you charge the source.

    status: string

    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.

    three_d_secure?: Stripe.Source.ThreeDSecure

    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

    usage: string

    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.