transfer_amount Property

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

Syntax

def get_transfer_amount() -> str: ...
def set_transfer_amount(value: str) -> None: ...

transfer_amount = property(get_transfer_amount, set_transfer_amount)

Default Value

""

Remarks

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 on_transfer_funds or on_modify_transfer methods are called),

It is returned in the server response for each payment being synchronized (when the on_synchronize_transfers 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.