Interface PaymentMethodCreateParams

Export

PaymentMethodCreateParams

Hierarchy

  • PaymentMethodCreateParams

Properties

ach_debit? billing_details? card? eft_debit? metadata? nick_name? payment_token? terminal_reader_id? type

Properties

Optional ach_debit

ach_debit?: PaymentMethodCreateParamsAchDebit

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

Memberof

PaymentMethodCreateParams

Optional billing_details

billing_details?: PaymentMethodCreateParamsBillingDetails

Billing information associated with the PaymentMethod that may be used or required by most types of payment methods.

Memberof

PaymentMethodCreateParams

Optional card

card?: PaymentMethodCreateParamsCard

If this is a card PaymentMethod, this hash contains the user's card details. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Tilled.js instead of interacting with this API directly.

Memberof

PaymentMethodCreateParams

Optional eft_debit

eft_debit?: PaymentMethodCreateParamsEftDebit

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

Memberof

PaymentMethodCreateParams

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

PaymentMethodCreateParams

Type declaration

  • [key: string]: string

Optional nick_name

nick_name?: string

A customer provided name for the PaymentMethod.

Memberof

PaymentMethodCreateParams

Optional payment_token

payment_token?: string

A token generated by Tilled.js representing the details of a payment method (e.g. card or bank details)

Memberof

PaymentMethodCreateParams

Optional terminal_reader_id

terminal_reader_id?: string

Required if this is a card_present PaymentMethod, this is the id of terminal reader you want to use to collect card information. Starts with a prefix term_

Memberof

PaymentMethodCreateParams

type

type: PaymentMethodCreateParamsType

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. If the selected type is card_present, then terminal_reader_id is required.

Memberof

PaymentMethodCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc