SyncTransferAmount Property

Amount of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getSyncTransferAmount($synctransferindex);

Procedural Interface

ipworksofx_banktransfer_get($res, 28 , $synctransferindex);

Default Value



Amount of the bank transfer being initiated, modified or synchronized.

This is required to be provided when initiating or modifying a transfer (i.e., when either TransferFunds or ModifyTransfer methods are called),

It is returned in the server response for each payment being synchronized (when the SynchronizeTransfers method is called).

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.

The $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

This property is read-only and not available at design time.

Data Type


Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 PHP Edition - Version 20.0 [Build 7941]