Class: module:models/PaymentMethod

module:models/PaymentMethod(id)

new module:models/PaymentMethod(id)

Constructs a new PaymentMethod. Document representing a payment method.

Parameters:
Name Type Description
id String

The id of the payment method or card.

Source:

Members

(inner) cards :Array.<module:models/PaymentCardSpec>

The sorted array of payment cards (included only when the system payment method is CREDIT_CARD).

Type:
Source:

(inner) description :String

The localized description of the payment method or card.

Type:
  • String
Source:

(inner) id :String

The id of the payment method or card.

Type:
  • String
Source:

(inner) image :String

The URL to the image that represents the payment method or card.

Type:
  • String
Source:

(inner) name :String

The localized name of the payment method or card.

Type:
  • String
Source:

(inner) payment_processor_id :String

The payment processor ID.

Type:
  • String
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/PaymentMethod}

Constructs a PaymentMethod from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/PaymentMethod

Optional instance to populate.

Source:
Returns:

The populated PaymentMethod instance.

Type
module:models/PaymentMethod