Interface PaymentIntent

Export

PaymentIntent

Hierarchy

  • PaymentIntent

Properties

account_id: string

ID of the Tilled account for which the funds of this PaymentIntent are intended.

Memberof

PaymentIntent

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 or 100 to charge ¥100, a zero-decimal currency).

Memberof

PaymentIntent

amount_capturable: number

Amount that can be captured from this PaymentIntent.

Memberof

PaymentIntent

amount_received: number

Amount that was collected by this PaymentIntent.

Memberof

PaymentIntent

canceled_at?: string

Populated when status is canceled, this is the time at which the PaymentIntent was canceled.

Memberof

PaymentIntent

cancellation_reason?: PaymentIntentCancellationReason

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Tilled internally (automatic).

Memberof

PaymentIntent

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

PaymentIntent

charges: Charge[]

Charges that were created by this PaymentIntent, if any. At most, this list will only contain one successful charge.

Memberof

PaymentIntent

client_secret: string

The client secret of this PaymentIntent. The client secret, along with a publishable key, can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

Memberof

PaymentIntent

created_at: string

Time at which the object was created.

Memberof

PaymentIntent

Three-letter ISO currency code, in lowercase.

Memberof

PaymentIntent

customer?: Customer

The Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent.

Memberof

PaymentIntent

id: string

Unique identifier for the object.

Memberof

PaymentIntent

last_payment_error?: PaymentIntentError

The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

Memberof

PaymentIntent

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

PaymentIntent

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.

Memberof

PaymentIntent

Type declaration

  • [key: string]: string
occurrence_type?: PaymentIntentOccurrenceType

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

PaymentIntent

payment_method?: PaymentMethod

The PaymentMethod used in this PaymentIntent.

Memberof

PaymentIntent

payment_method_types: PaymentIntentPaymentMethodTypes[]

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

Memberof

PaymentIntent

platform_fee_amount?: number

The amount of the 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 a the total payment amount.

Memberof

PaymentIntent

statement_descriptor_suffix?: string

Provides information about a card 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 22 characters for the concatenated descriptor

Memberof

PaymentIntent

Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded.

Memberof

PaymentIntent

subscription_id?: string

ID of the subscription related to this PaymentIntent (if any).

Memberof

PaymentIntent

updated_at: string

Time at which the object was updated.

Memberof

PaymentIntent

Generated using TypeDoc