capacitor-stripe-terminal
    Preparing search index...

    Interface CreatePaymentIntentParams

    Parameters used to create a PaymentIntent on the device.

    interface CreatePaymentIntentParams {
        amount: number;
        applicationFeeAmount?: number;
        captureMethod?: CaptureMethod;
        currency: string;
        customer?: string;
        description?: string;
        metadata?: Record<string, string>;
        onBehalfOf?: string;
        paymentMethodTypes?: PaymentMethodType[];
        receiptEmail?: string;
        setupFutureUsage?: "off_session" | "on_session";
        statementDescriptor?: string;
        statementDescriptorSuffix?: string;
        transferDataDestination?: string;
        transferGroup?: string;
    }
    Index
    amount: number

    The amount of the payment, provided in the currency's smallest unit.

    applicationFeeAmount?: number

    The amount of the application fee collected, provided in the currency's smallest unit.

    captureMethod?: CaptureMethod

    When to capture the funds.

    'automatic'
    
    currency: string

    Three-letter ISO currency code, in lowercase.

    customer?: string

    The ID of the customer this payment is for.

    description?: string

    An arbitrary string attached to the object, displayed alongside the payment in the Stripe dashboard.

    metadata?: Record<string, string>

    Set of key-value pairs attached to the object.

    onBehalfOf?: string

    The Stripe account ID for which this payment is intended.

    paymentMethodTypes?: PaymentMethodType[]

    The payment method types this PaymentIntent may use.

    ['cardPresent']
    
    receiptEmail?: string

    Email address that the receipt for the resulting payment will be sent to.

    setupFutureUsage?: "off_session" | "on_session"

    Indicates that you intend to make future payments with this PaymentIntent's payment method.

    statementDescriptor?: string

    Extra information that will appear on your customer's statement.

    statementDescriptorSuffix?: string

    Extra dynamic information concatenated with statementDescriptor on your customer's statement.

    transferDataDestination?: string

    The account where funds from the payment will be transferred to upon payment success.

    transferGroup?: string

    A string that identifies the resulting payment as part of a group.