Class: OrderPaymentCapture

Request~OrderPaymentCapture(clientnullable, orderPaymentnullable)

Handles API Request OrderPayment_Capture. Scope: Store.

Constructor

new OrderPaymentCapture(clientnullable, orderPaymentnullable)

OrderPaymentCapture Constructor.

OrderPaymentCapture Constructor.

Parameters:
Name Type Attributes Default Description
client Client <nullable>
orderPayment OrderPayment <nullable>
 null
Source:
See:

Methods

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getAmount() → {number}

Get Amount.

Get Amount.

Source:
Returns:
Type
number

getOrderPaymentId() → {number}

Get OrderPayment_ID.

Get OrderPayment_ID.

Source:
Returns:
Type
number

setAmount(amount) → {OrderPaymentCapture}

Set Amount.

Set Amount.

Parameters:
Name Type Description
amount number
Source:
Returns:
Type
OrderPaymentCapture

setOrderPaymentId(orderPaymentId) → {OrderPaymentCapture}

Set OrderPayment_ID.

Set OrderPayment_ID.

Parameters:
Name Type Description
orderPaymentId number
Source:
Returns:
Type
OrderPaymentCapture

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object