PaymentAmount Property

Payment amount.

Object Oriented Interface

public function getPaymentAmount();
public function setPaymentAmount($value);

Procedural Interface

ipworksofx_billpayment_get($res, 35 );
ipworksofx_billpayment_set($res, 35, $value );

Default Value

''

Remarks

Payment amount. This is to be provided when sending a bill payment request.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

This property is not available at design time.

Data Type

String