SettlementAmount Property

The amount that the customer will be charged.

Object Oriented Interface

public function getSettlementAmount();
public function setSettlementAmount($value);

Procedural Interface

inpaydirect_fdmsdetailrecord_get($res, 20 );
inpaydirect_fdmsdetailrecord_set($res, 20, $value );

Default Value

'0'

Remarks

This field contains the final settlement amount of the transaction. In most cases, this is the TransactionAmount from the original authorization request. However, you may settle a lesser amount (ie: Partial shipment or backordered stock). If using the Restaurant IndustryType, you may also increase the SettlementAmount by adding any Gratuity (if present).

This field must always be greater than zero.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String