new module:models/OrderPaymentInstrumentRequest()
Constructs a new OrderPaymentInstrumentRequest.
Document representing an order payment instrument request.
Members
(inner) amount :Number
The payment transaction amount.
Type:
- Number
(inner) bank_routing_number :String
The bank routing number.
Type:
- String
(inner) create_customer_payment_instrument :Boolean
A flag indicating whether a related customer payment instrument should be created. The CustomerPaymentInstrument is only created when the OrderPaymentInstrument was authorized successfully.
Type:
- Boolean
(inner) customer_payment_instrument_id :String
The id of a customer payment instrument.
Type:
- String
(inner) gift_certificate_code :String
The gift certificate code.
Type:
- String
(inner) payment_bank_account :module:models/PaymentBankAccountRequest
The payment bank account request data.
Type:
(inner) payment_card :module:models/OrderPaymentCardRequest
The payment card.
Type:
(inner) payment_method_id :String
The payment method id. Optional if a customer payment instrument id is specified.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:models/OrderPaymentInstrumentRequest}
Constructs a OrderPaymentInstrumentRequest 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/OrderPaymentInstrumentRequest | Optional instance to populate. |
Returns:
The populated OrderPaymentInstrumentRequest instance.