TransferAmount Property

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

Syntax

ANSI (Cross Platform)
char* GetTransferAmount();
int SetTransferAmount(const char* lpszTransferAmount); Unicode (Windows) LPWSTR GetTransferAmount();
INT SetTransferAmount(LPCWSTR lpszTransferAmount);
@property (nonatomic,readwrite,assign,getter=transferAmount,setter=setTransferAmount:) NSString* transferAmount;
- (NSString*)transferAmount;
- (void)setTransferAmount:(NSString*)newTransferAmount;
#define PID_BANKTRANSFER_TRANSFERAMOUNT 39

IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_BankTransfer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_BankTransfer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

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 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.

This property is not available at design time.

Data Type

String

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