Interface PaymentIntentCreateParams

Export

PaymentIntentCreateParams

Hierarchy

  • PaymentIntentCreateParams

Properties

amount capture_method? confirm? currency level3? metadata? occurrence_type? payment_method_id? payment_method_types platform_fee_amount? statement_descriptor_suffix?

Properties

amount

amount: number

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00)

Memberof

PaymentIntentCreateParams

Optional capture_method

capture_method?: PaymentIntentCreateParamsCaptureMethod

Controls when the funds will be captured from the customer’s account. automatic (Default) Tilled automatically captures funds when the customer authorizes the payment. manual Place a hold on funds when the customer authorizes the payment, but don't capture the funds until later.

Memberof

PaymentIntentCreateParams

Optional confirm

confirm?: boolean

Set to 'true' to attempt to confirm this PaymentIntent immediately. This parameter defaults to false.

Memberof

PaymentIntentCreateParams

currency

currency: PaymentIntentCreateParamsCurrency

Three-letter ISO currency code, in lowercase.

Memberof

PaymentIntentCreateParams

Optional level3

level3?: Level3

Level 2 and Level 3 (L2/L3) credit card processing refers to certain B2B card transactions for which the merchant might be eligible for lower credit card interchange rates. The lower rates may be available for merchants who provide more detailed information when processing card-not-present transactions.

Memberof

PaymentIntentCreateParams

Optional metadata

metadata?: {
    [key: string]: string;
}

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. Individual keys can be unset by posting an empty value (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

PaymentIntentCreateParams

Type declaration

  • [key: string]: string

Optional occurrence_type

occurrence_type?: PaymentIntentCreateParamsOccurrenceType

Used to identify authorization requests that use stored credentials to improve authorization rates and reduce fraud. consumer_ad_hoc Ad hoc consumer-initiated request merchant_ad_hoc Unscheduled merchant-initiated request merchant_recurring Scheduled, merchant-initiated recurring request

Memberof

PaymentIntentCreateParams

Optional payment_method_id

payment_method_id?: string

ID of the PaymentMethod to attach to this PaymentIntent.

Memberof

PaymentIntentCreateParams

payment_method_types

payment_method_types: PaymentIntentCreateParamsPaymentMethodTypes[]

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

Memberof

PaymentIntentCreateParams

Optional platform_fee_amount

platform_fee_amount?: number

The amount of the platform fee (if any) that will be requested to be applied to the payment and transferred to the partner account. The amount of the fee collected will be capped at the total payment amount.

Memberof

PaymentIntentCreateParams

Optional statement_descriptor_suffix

statement_descriptor_suffix?: string

Provides information about a payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 20 characters for the concatenated descriptor.

Memberof

PaymentIntentCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc