capacitor-stripe-terminal
    Preparing search index...

    Interface PaymentIntent

    A PaymentIntent tracks the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

    A PaymentIntent transitions through multiple statuses throughout its lifetime and ultimately creates at most one successful charge.

    interface PaymentIntent {
        amount: number;
        amountCapturable?: number | null;
        amountDetails?: AmountDetails;
        amountReceived?: number | null;
        amountRequested?: number | null;
        amountTip?: number;
        applicationFeeAmount?: number | null;
        canceledAt?: number | null;
        cancellationReason?: string | null;
        captureMethod?: string | null;
        charges: Charge[];
        clientSecret?: string | null;
        confirmationMethod?: string | null;
        created: number;
        currency: string;
        customer?: string | null;
        description?: string | null;
        id: string;
        livemode?: boolean;
        metadata: { [key: string]: string };
        onBehalfOf?: string | null;
        paymentMethod: string | PaymentMethod | null;
        paymentMethodId?: string | null;
        paymentMethodTypes?: PaymentMethodType[];
        receiptEmail?: string | null;
        setupFutureUsage?: string | null;
        statementDescriptor?: string;
        statementDescriptorSuffix?: string;
        status: PaymentIntentStatus;
        stripeId: string;
        transferGroup?: string | null;
    }
    Index
    amount: number

    The amount to be collected by this PaymentIntent, provided in the currency’s smallest unit.

    amountCapturable?: number | null

    The amount that can be captured with a later capture call, provided in the currency's smallest unit.

    amountDetails?: AmountDetails

    Details about items included in the amount after confirmation.

    amountReceived?: number | null

    The amount received by the merchant, provided in the currency's smallest unit.

    amountRequested?: number | null

    The amount originally requested, provided in the currency's smallest unit.

    amountTip?: number

    Indicates how much the user intends to tip in addition to the amount by at confirmation time. This is only non-null in the PaymentIntent instance returned during collect when using updatePaymentIntent set to true in the CollectConfig.

    After processPaymentIntent the amount will have this tip amount added to it and the amountDetails will contain the breakdown of how much of the amount was a tip.

    applicationFeeAmount?: number | null

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

    canceledAt?: number | null

    When the intent was canceled, in seconds since the Unix epoch.

    cancellationReason?: string | null

    The reason the intent was canceled.

    captureMethod?: string | null

    When the funds will be captured, e.g. automatic or manual.

    charges: Charge[]

    Charges that were created by this PaymentIntent, if any.

    clientSecret?: string | null

    The client secret of this PaymentIntent.

    confirmationMethod?: string | null

    How the PaymentIntent is confirmed.

    created: number

    When the intent was created.

    currency: string

    The currency of the payment.

    customer?: string | null

    The ID of the customer this intent belongs to.

    description?: string | null

    An arbitrary string attached to the intent.

    id: string

    The unique identifier for the intent.

    livemode?: boolean

    Whether the intent exists in live mode.

    metadata: { [key: string]: string }

    Set of key-value pairs attached to the object.

    onBehalfOf?: string | null

    The Stripe account ID this payment is on behalf of.

    paymentMethod: string | PaymentMethod | null

    The payment method to be used in this PaymentIntent. Only valid in the intent returned during collectPaymentMethod when using the updatePaymentIntent option in the CollectConfig.

    paymentMethodId?: string | null

    The ID of the payment method attached to this intent.

    paymentMethodTypes?: PaymentMethodType[]

    The payment method types this intent may use.

    receiptEmail?: string | null

    The email the receipt for the resulting payment will be sent to.

    setupFutureUsage?: string | null

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

    statementDescriptor?: string

    Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.

    statementDescriptorSuffix?: string

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on your customer’s statement when this PaymentIntent succeeds in creating a charge.

    The status of the PaymentIntent.

    stripeId: string

    The unique identifier for the intent.

    Use id instead. This will be removed in v6.

    transferGroup?: string | null

    A string identifying the resulting payment as part of a group.