Mayson Monorepo Documentation
    Preparing search index...
    interface SourceCreateParams {
        amount?: number;
        currency?: string;
        customer?: string;
        expand?: string[];
        flow?: Stripe.SourceCreateParams.Flow;
        mandate?: Stripe.SourceCreateParams.Mandate;
        metadata?: MetadataParam;
        original_source?: string;
        owner?: Stripe.SourceCreateParams.Owner;
        receiver?: Stripe.SourceCreateParams.Receiver;
        redirect?: Stripe.SourceCreateParams.Redirect;
        source_order?: Stripe.SourceCreateParams.SourceOrder;
        statement_descriptor?: string;
        token?: string;
        type?: string;
        usage?: Stripe.SourceCreateParams.Usage;
    }
    Index

    Properties

    amount?: number

    Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources. Not supported for receiver type sources, where charge amount may not be specified until funds land.

    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.

    customer?: string

    The Customer to whom the original source is attached to. Must be set when the original source is not a Source (e.g., Card).

    expand?: string[]

    Specifies which fields in the response should be expanded.

    The authentication flow of the source to create. flow is one of redirect, receiver, code_verification, none. It is generally inferred unless a type supports multiple flows.

    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.

    metadata?: MetadataParam
    original_source?: string

    The source to share.

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

    Optional parameters for the receiver flow. Can be set only if the source is a receiver (flow is receiver).

    Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flow is redirect).

    Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

    statement_descriptor?: string

    An arbitrary string to be displayed on your customer's statement. As an example, if your website is RunClub and the item you're charging for is a race ticket, you may want to specify a statement_descriptor of RunClub 5K race ticket. While many payment types will display this information, some may not display it at all.

    token?: string

    An optional token used to create the source. When passed, token properties will override source parameters.

    type?: string

    The type of the source to create. Required unless customer and original_source are specified (see the Cloning card Sources guide)