Interface PaymentMethod

Export

PaymentMethod

Hierarchy

  • PaymentMethod

Properties

ach_debit? billing_details? card? card_present? chargeable created_at customer_id? eft_debit? expires_at? id metadata? nick_name? terminal_reader? type updated_at

Properties

Optional ach_debit

ach_debit?: AchDebitDetails

If this is a ach_debit PaymentMethod, this hash contains details about the ACH Debit bank account.

Memberof

PaymentMethod

Optional billing_details

billing_details?: PaymentMethodBillingDetails

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. (e.g. it is required for ach_debit and Apple Pay)

Memberof

PaymentMethod

Optional card

card?: CardDetails

If this is a card PaymentMethod, this hash contains the user's card details.

Memberof

PaymentMethod

Optional card_present

card_present?: CardDetails

Memberof

PaymentMethod

chargeable

chargeable: boolean

Indicates whether or not the payment method can be used to make a charge. When a payment method is created via Tilled.js, a payment method is only capable of being used once (i.e. single-use) unless it is attached to a customer, in which case it becomes reusable.

Memberof

PaymentMethod

created_at

created_at: string

Time at which the object was created.

Memberof

PaymentMethod

Optional customer_id

customer_id?: string

The ID of the Customer to which this PaymentMethod is saved.

Memberof

PaymentMethod

Optional eft_debit

eft_debit?: EftDebitDetails

If this is a eft_debit PaymentMethod, this hash contains details about the EFT Debit bank account.

Memberof

PaymentMethod

Optional expires_at

expires_at?: string

The time at which this PaymentMethod expires and is no longer available. PaymentMethods are created using a token generated by Tilled.js representing the details of a payment method (e.g. card or bank details). This token is a single-use token with an expiration date. Use /payment-methods/{id}/attach to make this PaymentMethod reusable.

Memberof

PaymentMethod

id

id: string

Unique identifier for the object.

Memberof

PaymentMethod

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.

Memberof

PaymentMethod

Type declaration

  • [key: string]: string

Optional nick_name

nick_name?: string

A customer provided name for the PaymentMethod.

Memberof

PaymentMethod

Optional terminal_reader

terminal_reader?: TerminalReader

If the payment method type is "card_present" then we return the terminal_reader object.

Memberof

PaymentMethod

type

type: PaymentMethodType

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Memberof

PaymentMethod

updated_at

updated_at: string

Time at which the object was last updated.

Memberof

PaymentMethod

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc