BillPayment Class

Properties   Methods   Events   Config Settings   Errors  

The BillPayment control is a single class that supports the SignOn and Payment functions of Open Financial Exchange, as described by OFX Specification 1.x and 2.x.

Syntax

BillPayment

Remarks

Payment requests can be used to schedule individual payments and to modify or delete payments if necessary.

To use the BillPayment class, first provide OFXAppId, and OFXAppVersion properties, your FI information (by setting the FIOrganization, FIId and FIUrl properties), your login information (OFXUser, OFXPassword).

Next:

• set Payment (PaymentFromBankId, PaymentFromAccountId, and PaymentFromAccountType properties to the values corresponding to the account from which you wish to pay the bill, PaymentAmount to the desired amount, PaymentDateDue to the date payment has to be processed);
• set Payee (by providing either PayeeId or: payee full information (via PayeeAggregate or by setting each payee property such as PayeeName, PayeeAddr1, PayeePhone, PayeeListId (if assigned by the server) and PayeeAccount to your account id with that biller;

Finally, call the PayBill method. If the biller does not exist in the payee list, the payment request will also set up that payee adding it to your payee list.

Upon successful response, the PaymentId, PaymentStatus and PaymentDateProcessed properties will be populated indicating the status of your payment. If the payee didn't exist in your payee list, and if your FI supports assigning id to payees, the PayeeId and PayeeListId assigned to that payer might also be returned in the server response.

Between the time a payment is scheduled and the time the server processes the payment, the user can request changes to the parameters of that payment. For example, the PaymentAmount or PaymentDateDue of the payment can be modified. To modify a scheduled payment identified by PaymentId, the ModifyPayment method can be called where the PaymentId identifies the targeted payment. When this method is called, the full contents of the payment request must be specified, including both modified and unmodified data. All data can be modified except PayeeName and PayeeId. Depending on the server, the response might include the date on which server actually processed this payment, or if it failed due to insufficient funds.

To cancel a scheduled payment identified by PaymentId, the CancelPayment method must be called.

Obtaining the status for a payment identified by PaymentId can be done by calling the GetStatus method.

Bill payments are subject to synchronization which can be done by calling the SynchronizePayments method.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

FIId Property (BillPayment Class)

Financial institution identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIId();
int SetFIId(const char* lpszFIId);

Unicode (Windows)
LPWSTR GetFIId();
INT SetFIId(LPCWSTR lpszFIId);

char* inebank_billpayment_getfiid(void* lpObj);
int inebank_billpayment_setfiid(void* lpObj, const char* lpszFIId);

QString GetFIId();
int SetFIId(QString qsFIId);

Default Value

""

Remarks

FIId holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

Data Type

String

FIOrganization Property (BillPayment Class)

Financial institution organization name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIOrganization();
int SetFIOrganization(const char* lpszFIOrganization);

Unicode (Windows)
LPWSTR GetFIOrganization();
INT SetFIOrganization(LPCWSTR lpszFIOrganization);

char* inebank_billpayment_getfiorganization(void* lpObj);
int inebank_billpayment_setfiorganization(void* lpObj, const char* lpszFIOrganization);

QString GetFIOrganization();
int SetFIOrganization(QString qsFIOrganization);

Default Value

""

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique FIId that must also be used at signon.

Data Type

String

FirewallAutoDetect Property (BillPayment Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int inebank_billpayment_getfirewallautodetect(void* lpObj);
int inebank_billpayment_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (BillPayment Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int inebank_billpayment_getfirewalltype(void* lpObj);
int inebank_billpayment_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (BillPayment Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* inebank_billpayment_getfirewallhost(void* lpObj);
int inebank_billpayment_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (BillPayment Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* inebank_billpayment_getfirewallpassword(void* lpObj);
int inebank_billpayment_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (BillPayment Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int inebank_billpayment_getfirewallport(void* lpObj);
int inebank_billpayment_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (BillPayment Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* inebank_billpayment_getfirewalluser(void* lpObj);
int inebank_billpayment_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIUrl Property (BillPayment Class)

Financial institution URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIUrl();
int SetFIUrl(const char* lpszFIUrl);

Unicode (Windows)
LPWSTR GetFIUrl();
INT SetFIUrl(LPCWSTR lpszFIUrl);

char* inebank_billpayment_getfiurl(void* lpObj);
int inebank_billpayment_setfiurl(void* lpObj, const char* lpszFIUrl);

QString GetFIUrl();
int SetFIUrl(QString qsFIUrl);

Default Value

""

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

Data Type

String

LostSync Property (BillPayment Class)

Whether the token in the synchronization request is older.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLostSync();

Unicode (Windows)
BOOL GetLostSync();

int inebank_billpayment_getlostsync(void* lpObj);

bool GetLostSync();

Default Value

FALSE

Remarks

The LostSync will be returned in the server response after a synchronization request has been sent (when the Synchronize method was called). This indicates whether the Token in the synchronization request is older than the earliest entry in the server's history table. If True, some responses have been lost. Otherwise, the token in the synchronization request is newer than or matches a token in the server's history table.

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

Data Type

Boolean

OFXAccessKey Property (BillPayment Class)

Access key value received after a MFA authentication in a previous signon.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAccessKey();
int SetOFXAccessKey(const char* lpszOFXAccessKey);

Unicode (Windows)
LPWSTR GetOFXAccessKey();
INT SetOFXAccessKey(LPCWSTR lpszOFXAccessKey);

char* inebank_billpayment_getofxaccesskey(void* lpObj);
int inebank_billpayment_setofxaccesskey(void* lpObj, const char* lpszOFXAccessKey);

QString GetOFXAccessKey();
int SetOFXAccessKey(QString qsOFXAccessKey);

Default Value

""

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the SendChallengeAnswers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response (when the SendChallengeAnswers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the RequestChallengeQuestions method in FIProfile class). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (BillPayment Class)

OFX application identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppId();
int SetOFXAppId(const char* lpszOFXAppId);

Unicode (Windows)
LPWSTR GetOFXAppId();
INT SetOFXAppId(LPCWSTR lpszOFXAppId);

char* inebank_billpayment_getofxappid(void* lpObj);
int inebank_billpayment_setofxappid(void* lpObj, const char* lpszOFXAppId);

QString GetOFXAppId();
int SetOFXAppId(QString qsOFXAppId);

Default Value

""

Remarks

This is the unique identifier of the user's OFX application.

Data Type

String

OFXAppVersion Property (BillPayment Class)

OFX application version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppVersion();
int SetOFXAppVersion(const char* lpszOFXAppVersion);

Unicode (Windows)
LPWSTR GetOFXAppVersion();
INT SetOFXAppVersion(LPCWSTR lpszOFXAppVersion);

char* inebank_billpayment_getofxappversion(void* lpObj);
int inebank_billpayment_setofxappversion(void* lpObj, const char* lpszOFXAppVersion);

QString GetOFXAppVersion();
int SetOFXAppVersion(QString qsOFXAppVersion);

Default Value

""

Remarks

This is the version of the user's OFX application.

Data Type

String

OFXPassword Property (BillPayment Class)

User's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXPassword();
int SetOFXPassword(const char* lpszOFXPassword);

Unicode (Windows)
LPWSTR GetOFXPassword();
INT SetOFXPassword(LPCWSTR lpszOFXPassword);

char* inebank_billpayment_getofxpassword(void* lpObj);
int inebank_billpayment_setofxpassword(void* lpObj, const char* lpszOFXPassword);

QString GetOFXPassword();
int SetOFXPassword(QString qsOFXPassword);

Default Value

""

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXRequest Property (BillPayment Class)

The current OFX request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXRequest();

Unicode (Windows)
LPWSTR GetOFXRequest();

char* inebank_billpayment_getofxrequest(void* lpObj);

QString GetOFXRequest();

Default Value

""

Remarks

Polling OFXRequest will cause the class to generate and return an OFX request aggregate.

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

Data Type

String

OFXResponse Property (BillPayment Class)

The current OFX response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXResponse();
int SetOFXResponse(const char* lpszOFXResponse);

Unicode (Windows)
LPWSTR GetOFXResponse();
INT SetOFXResponse(LPCWSTR lpszOFXResponse);

char* inebank_billpayment_getofxresponse(void* lpObj);
int inebank_billpayment_setofxresponse(void* lpObj, const char* lpszOFXResponse);

QString GetOFXResponse();
int SetOFXResponse(QString qsOFXResponse);

Default Value

""

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to OFXResponse. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that ReadOFXDataFile does.

This property is not available at design time.

Data Type

String

OFXUser Property (BillPayment Class)

User's id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXUser();
int SetOFXUser(const char* lpszOFXUser);

Unicode (Windows)
LPWSTR GetOFXUser();
INT SetOFXUser(LPCWSTR lpszOFXUser);

char* inebank_billpayment_getofxuser(void* lpObj);
int inebank_billpayment_setofxuser(void* lpObj, const char* lpszOFXUser);

QString GetOFXUser();
int SetOFXUser(QString qsOFXUser);

Default Value

""

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXVersion Property (BillPayment Class)

OFX API version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXVersion();
int SetOFXVersion(const char* lpszOFXVersion);

Unicode (Windows)
LPWSTR GetOFXVersion();
INT SetOFXVersion(LPCWSTR lpszOFXVersion);

char* inebank_billpayment_getofxversion(void* lpObj);
int inebank_billpayment_setofxversion(void* lpObj, const char* lpszOFXVersion);

QString GetOFXVersion();
int SetOFXVersion(QString qsOFXVersion);

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the OFXVersion is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

Data Type

String

PayeeAccount Property (BillPayment Class)

User's account number with the payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeAccount();
int SetPayeeAccount(const char* lpszPayeeAccount);

Unicode (Windows)
LPWSTR GetPayeeAccount();
INT SetPayeeAccount(LPCWSTR lpszPayeeAccount);

char* inebank_billpayment_getpayeeaccount(void* lpObj);
int inebank_billpayment_setpayeeaccount(void* lpObj, const char* lpszPayeeAccount);

QString GetPayeeAccount();
int SetPayeeAccount(QString qsPayeeAccount);

Default Value

""

Remarks

User's account number with the payee. This string uniquely identifies the customer in the payee (biller) system.

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

Data Type

String

PayeeAddr1 Property (BillPayment Class)

Payee's address line 1.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeAddr1();
int SetPayeeAddr1(const char* lpszPayeeAddr1);

Unicode (Windows)
LPWSTR GetPayeeAddr1();
INT SetPayeeAddr1(LPCWSTR lpszPayeeAddr1);

char* inebank_billpayment_getpayeeaddr1(void* lpObj);
int inebank_billpayment_setpayeeaddr1(void* lpObj, const char* lpszPayeeAddr1);

QString GetPayeeAddr1();
int SetPayeeAddr1(QString qsPayeeAddr1);

Default Value

""

Remarks

Payee's address line 1.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Data Type

String

PayeeAddr2 Property (BillPayment Class)

Payee's address line 2.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeAddr2();
int SetPayeeAddr2(const char* lpszPayeeAddr2);

Unicode (Windows)
LPWSTR GetPayeeAddr2();
INT SetPayeeAddr2(LPCWSTR lpszPayeeAddr2);

char* inebank_billpayment_getpayeeaddr2(void* lpObj);
int inebank_billpayment_setpayeeaddr2(void* lpObj, const char* lpszPayeeAddr2);

QString GetPayeeAddr2();
int SetPayeeAddr2(QString qsPayeeAddr2);

Default Value

""

Remarks

Payee's address line 2.

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

Data Type

String

PayeeAddr3 Property (BillPayment Class)

Payee's address line 3.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeAddr3();
int SetPayeeAddr3(const char* lpszPayeeAddr3);

Unicode (Windows)
LPWSTR GetPayeeAddr3();
INT SetPayeeAddr3(LPCWSTR lpszPayeeAddr3);

char* inebank_billpayment_getpayeeaddr3(void* lpObj);
int inebank_billpayment_setpayeeaddr3(void* lpObj, const char* lpszPayeeAddr3);

QString GetPayeeAddr3();
int SetPayeeAddr3(QString qsPayeeAddr3);

Default Value

""

Remarks

Payee's address line 3.

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

Data Type

String

PayeeAggregate Property (BillPayment Class)

Wrapper for payee details.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeAggregate();
int SetPayeeAggregate(const char* lpszPayeeAggregate);

Unicode (Windows)
LPWSTR GetPayeeAggregate();
INT SetPayeeAggregate(LPCWSTR lpszPayeeAggregate);

char* inebank_billpayment_getpayeeaggregate(void* lpObj);
int inebank_billpayment_setpayeeaggregate(void* lpObj, const char* lpszPayeeAggregate);

QString GetPayeeAggregate();
int SetPayeeAggregate(QString qsPayeeAggregate);

Default Value

""

Remarks

Wrapper for payee details.

This string consists of all the payee's properties PayeeId, PayeeName, PayeeAddr1, PayeeAddr2, PayeeAddr3, PayeeCity, PayeeState, PayeePostalCode, PayeeCountry, PayeePhone, PayeeIdScope, PayeeDaysToPay, PayeeListId, PayeeAccount of the payee.

When the SynchronizePayees is called, the SyncPayees event is fired for each payee in the payee list. Among other payee data returned through this event's parameters, there is also a PayeeAggregate parameter.

When sending a payment request (by calling PayBill) to an existing payee in the list returned via the payee synchronization request, and when the PayeeId is unknown or not assigned, instead of setting all payee's properties, the user can set the PayeeAggregate to the value of PayeeAggregate returned for that payee from the SyncPayees event. When the PayeeAggregate is set to this value, all payee's properties are populated with the corresponding values in the aggregate.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

Data Type

String

PayeeCity Property (BillPayment Class)

Payee's city.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeCity();
int SetPayeeCity(const char* lpszPayeeCity);

Unicode (Windows)
LPWSTR GetPayeeCity();
INT SetPayeeCity(LPCWSTR lpszPayeeCity);

char* inebank_billpayment_getpayeecity(void* lpObj);
int inebank_billpayment_setpayeecity(void* lpObj, const char* lpszPayeeCity);

QString GetPayeeCity();
int SetPayeeCity(QString qsPayeeCity);

Default Value

""

Remarks

Payee's city.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Data Type

String

PayeeCountry Property (BillPayment Class)

Payee's country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeCountry();
int SetPayeeCountry(const char* lpszPayeeCountry);

Unicode (Windows)
LPWSTR GetPayeeCountry();
INT SetPayeeCountry(LPCWSTR lpszPayeeCountry);

char* inebank_billpayment_getpayeecountry(void* lpObj);
int inebank_billpayment_setpayeecountry(void* lpObj, const char* lpszPayeeCountry);

QString GetPayeeCountry();
int SetPayeeCountry(QString qsPayeeCountry);

Default Value

"USA"

Remarks

Payee's country. This is a 3 letter country code as representation of a country name (ISO/DIS-3166 3-letter country code standard).

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

Data Type

String

PayeeDaysToPay Property (BillPayment Class)

Minimum number of business days required to complete the payment transaction to this payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeDaysToPay();

Unicode (Windows)
LPWSTR GetPayeeDaysToPay();

char* inebank_billpayment_getpayeedaystopay(void* lpObj);

QString GetPayeeDaysToPay();

Default Value

""

Remarks

Minimum number of business days required to complete the payment transaction to this payee.

This property is read-only.

Data Type

String

PayeeId Property (BillPayment Class)

Server-assigned payee identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeId();
int SetPayeeId(const char* lpszPayeeId);

Unicode (Windows)
LPWSTR GetPayeeId();
INT SetPayeeId(LPCWSTR lpszPayeeId);

char* inebank_billpayment_getpayeeid(void* lpObj);
int inebank_billpayment_setpayeeid(void* lpObj, const char* lpszPayeeId);

QString GetPayeeId();
int SetPayeeId(QString qsPayeeId);

Default Value

""

Remarks

Server-assigned payee identifier.

The PayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either PayeeId or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the PayeeAggregate or payee details represented by required properties: PayeeName, PayeeAddr1, PayeeCity, PayeeState, PayeePostalCode, PayeePhone, and optional properties: PayeeAddr2, PayeeAddr3, PayeeCountry, PayeeAccount.

The PayeeId might be populated when: either a payment request (PayBill method is called) or an add payee request (AddPayee method is called) has been sent to the payment server, or when the PayeeAggregate has been set.

Data Type

String

PayeeIdScope Property (BillPayment Class)

Scope of the payee Id .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeIdScope();

Unicode (Windows)
LPWSTR GetPayeeIdScope();

char* inebank_billpayment_getpayeeidscope(void* lpObj);

QString GetPayeeIdScope();

Default Value

""

Remarks

Scope of the payee PayeeId.

Possible values are:

This property is read-only.

Data Type

String

PayeeListId Property (BillPayment Class)

Server-assigned payee list record ID for this payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeListId();
int SetPayeeListId(const char* lpszPayeeListId);

Unicode (Windows)
LPWSTR GetPayeeListId();
INT SetPayeeListId(LPCWSTR lpszPayeeListId);

char* inebank_billpayment_getpayeelistid(void* lpObj);
int inebank_billpayment_setpayeelistid(void* lpObj, const char* lpszPayeeListId);

QString GetPayeeListId();
int SetPayeeListId(QString qsPayeeListId);

Default Value

""

Remarks

Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a PayeeId, the PayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a PayeeId to this payee.

It is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

The value of PayeeListId is used as parameter when the ModifyPayee or DeletePayee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

Data Type

String

PayeeName Property (BillPayment Class)

Name of the payee to whom the given Id or ListId corresponds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeName();
int SetPayeeName(const char* lpszPayeeName);

Unicode (Windows)
LPWSTR GetPayeeName();
INT SetPayeeName(LPCWSTR lpszPayeeName);

char* inebank_billpayment_getpayeename(void* lpObj);
int inebank_billpayment_setpayeename(void* lpObj, const char* lpszPayeeName);

QString GetPayeeName();
int SetPayeeName(QString qsPayeeName);

Default Value

""

Remarks

Name of the payee to whom the given PayeeId or PayeeListId corresponds. This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

After sending payment or add/modify payee requests, if the returned PayeeIdScope is GLOBAL, the PayeeName will contain the standard payee name returned by the server.

Data Type

String

PayeePhone Property (BillPayment Class)

Payee's phone.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeePhone();
int SetPayeePhone(const char* lpszPayeePhone);

Unicode (Windows)
LPWSTR GetPayeePhone();
INT SetPayeePhone(LPCWSTR lpszPayeePhone);

char* inebank_billpayment_getpayeephone(void* lpObj);
int inebank_billpayment_setpayeephone(void* lpObj, const char* lpszPayeePhone);

QString GetPayeePhone();
int SetPayeePhone(QString qsPayeePhone);

Default Value

""

Remarks

Payee's phone.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Data Type

String

PayeePostalCode Property (BillPayment Class)

Payee's postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeePostalCode();
int SetPayeePostalCode(const char* lpszPayeePostalCode);

Unicode (Windows)
LPWSTR GetPayeePostalCode();
INT SetPayeePostalCode(LPCWSTR lpszPayeePostalCode);

char* inebank_billpayment_getpayeepostalcode(void* lpObj);
int inebank_billpayment_setpayeepostalcode(void* lpObj, const char* lpszPayeePostalCode);

QString GetPayeePostalCode();
int SetPayeePostalCode(QString qsPayeePostalCode);

Default Value

""

Remarks

Payee's postal code.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Data Type

String

PayeeState Property (BillPayment Class)

Payee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayeeState();
int SetPayeeState(const char* lpszPayeeState);

Unicode (Windows)
LPWSTR GetPayeeState();
INT SetPayeeState(LPCWSTR lpszPayeeState);

char* inebank_billpayment_getpayeestate(void* lpObj);
int inebank_billpayment_setpayeestate(void* lpObj, const char* lpszPayeeState);

QString GetPayeeState();
int SetPayeeState(QString qsPayeeState);

Default Value

""

Remarks

Payee's state

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Data Type

String

PaymentAggregate Property (BillPayment Class)

Wrapper for a payment details.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentAggregate();

Unicode (Windows)
LPWSTR GetPaymentAggregate();

char* inebank_billpayment_getpaymentaggregate(void* lpObj);

QString GetPaymentAggregate();

Default Value

""

Remarks

Wrapper for a payment details.

This string consists of all the payment's properties PaymentId, PaymentStatus, PaymentAmount, PaymentFromBankId, PaymentFromAccountId, PaymentFromAccountType, PaymentMemo, PaymentCheckNumber, etc..

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

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

Data Type

String

PaymentAmount Property (BillPayment Class)

Payment amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentAmount();
int SetPaymentAmount(const char* lpszPaymentAmount);

Unicode (Windows)
LPWSTR GetPaymentAmount();
INT SetPaymentAmount(LPCWSTR lpszPaymentAmount);

char* inebank_billpayment_getpaymentamount(void* lpObj);
int inebank_billpayment_setpaymentamount(void* lpObj, const char* lpszPaymentAmount);

QString GetPaymentAmount();
int SetPaymentAmount(QString qsPaymentAmount);

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

PaymentBillRef Property (BillPayment Class)

Biller-supplied reference information when paying a bill, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentBillRef();
int SetPaymentBillRef(const char* lpszPaymentBillRef);

Unicode (Windows)
LPWSTR GetPaymentBillRef();
INT SetPaymentBillRef(LPCWSTR lpszPaymentBillRef);

char* inebank_billpayment_getpaymentbillref(void* lpObj);
int inebank_billpayment_setpaymentbillref(void* lpObj, const char* lpszPaymentBillRef);

QString GetPaymentBillRef();
int SetPaymentBillRef(QString qsPaymentBillRef);

Default Value

""

Remarks

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

This property is not available at design time.

Data Type

String

PaymentCheckNumber Property (BillPayment Class)

Check number assigned by the server to this payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentCheckNumber();

Unicode (Windows)
LPWSTR GetPaymentCheckNumber();

char* inebank_billpayment_getpaymentchecknumber(void* lpObj);

QString GetPaymentCheckNumber();

Default Value

""

Remarks

Check number assigned by the server to this payment.

This will be returned in the server response (if available) when the request succeeds.

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

Data Type

String

PaymentCurrencyCode Property (BillPayment Class)

Default currency code for this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentCurrencyCode();

Unicode (Windows)
LPWSTR GetPaymentCurrencyCode();

char* inebank_billpayment_getpaymentcurrencycode(void* lpObj);

QString GetPaymentCurrencyCode();

Default Value

""

Remarks

Default currency code for this transaction.

This indicates the currency in which the payment will be carried out.

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

Data Type

String

PaymentDateDue Property (BillPayment Class)

Processing date requested by user for the payment to be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentDateDue();
int SetPaymentDateDue(const char* lpszPaymentDateDue);

Unicode (Windows)
LPWSTR GetPaymentDateDue();
INT SetPaymentDateDue(LPCWSTR lpszPaymentDateDue);

char* inebank_billpayment_getpaymentdatedue(void* lpObj);
int inebank_billpayment_setpaymentdatedue(void* lpObj, const char* lpszPaymentDateDue);

QString GetPaymentDateDue();
int SetPaymentDateDue(QString qsPaymentDateDue);

Default Value

""

Remarks

Processing date requested by user for the payment to be sent.

This is required to be provided in any bill payment or payment modification requests.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is not available at design time.

Data Type

String

PaymentDateProcessed Property (BillPayment Class)

Payment processing date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentDateProcessed();

Unicode (Windows)
LPWSTR GetPaymentDateProcessed();

char* inebank_billpayment_getpaymentdateprocessed(void* lpObj);

QString GetPaymentDateProcessed();

Default Value

""

Remarks

Payment processing date.

This indicates the date when the event described by PaymentStatus occurs.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

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

Data Type

String

PaymentFromAccountId Property (BillPayment Class)

Account number from which the money for this payment is drawn.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentFromAccountId();
int SetPaymentFromAccountId(const char* lpszPaymentFromAccountId);

Unicode (Windows)
LPWSTR GetPaymentFromAccountId();
INT SetPaymentFromAccountId(LPCWSTR lpszPaymentFromAccountId);

char* inebank_billpayment_getpaymentfromaccountid(void* lpObj);
int inebank_billpayment_setpaymentfromaccountid(void* lpObj, const char* lpszPaymentFromAccountId);

QString GetPaymentFromAccountId();
int SetPaymentFromAccountId(QString qsPaymentFromAccountId);

Default Value

""

Remarks

Account number from which the money for this payment is drawn.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with that bank.

It is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

If PaymentFromAccountType is set to CreditCard, the PaymentFromAccountId should be a credit card account number.

This property is not available at design time.

Data Type

String

PaymentFromAccountType Property (BillPayment Class)

Indicates the type of account from which the money for this payment is drawn.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPaymentFromAccountType();
int SetPaymentFromAccountType(int iPaymentFromAccountType);

Unicode (Windows)
INT GetPaymentFromAccountType();
INT SetPaymentFromAccountType(INT iPaymentFromAccountType);

AT_CHECKING(0), 
AT_SAVINGS(1), 
AT_MONEY_MARKET(2), 
AT_LINE_OF_CREDIT(3), 
AT_CREDIT_CARD(4)

int inebank_billpayment_getpaymentfromaccounttype(void* lpObj);
int inebank_billpayment_setpaymentfromaccounttype(void* lpObj, int iPaymentFromAccountType);

int GetPaymentFromAccountType();
int SetPaymentFromAccountType(int iPaymentFromAccountType);

Default Value

0

Remarks

Indicates the type of account from which the money for this payment is drawn.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

This property uses the following four values:

• atChecking (0)
• atSavings (1)
• atMoneyMarket (2)
• atLineOfCredit (3)

This property is not available at design time.

Data Type

Integer

PaymentFromBankId Property (BillPayment Class)

Number that identifies the bank where the money is to be withdrawn.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentFromBankId();
int SetPaymentFromBankId(const char* lpszPaymentFromBankId);

Unicode (Windows)
LPWSTR GetPaymentFromBankId();
INT SetPaymentFromBankId(LPCWSTR lpszPaymentFromBankId);

char* inebank_billpayment_getpaymentfrombankid(void* lpObj);
int inebank_billpayment_setpaymentfrombankid(void* lpObj, const char* lpszPaymentFromBankId);

QString GetPaymentFromBankId();
int SetPaymentFromBankId(QString qsPaymentFromBankId);

Default Value

""

Remarks

Number that identifies the bank where the money is to be withdrawn.

This is required to be provided when a bill payment request has been made.

This property is not available at design time.

Data Type

String

PaymentId Property (BillPayment Class)

Transaction Id assigned by the server to the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentId();
int SetPaymentId(const char* lpszPaymentId);

Unicode (Windows)
LPWSTR GetPaymentId();
INT SetPaymentId(LPCWSTR lpszPaymentId);

char* inebank_billpayment_getpaymentid(void* lpObj);
int inebank_billpayment_setpaymentid(void* lpObj, const char* lpszPaymentId);

QString GetPaymentId();
int SetPaymentId(QString qsPaymentId);

Default Value

""

Remarks

Transaction Id assigned by the server to the payment.

The PaymentId is returned after a bill payment request (when calling the PayBill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the ModifyPayment or CancelPayment methods are called).

This property is not available at design time.

Data Type

String

PaymentMemo Property (BillPayment Class)

Memo attached to this payment from the customer to payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentMemo();
int SetPaymentMemo(const char* lpszPaymentMemo);

Unicode (Windows)
LPWSTR GetPaymentMemo();
INT SetPaymentMemo(LPCWSTR lpszPaymentMemo);

char* inebank_billpayment_getpaymentmemo(void* lpObj);
int inebank_billpayment_setpaymentmemo(void* lpObj, const char* lpszPaymentMemo);

QString GetPaymentMemo();
int SetPaymentMemo(QString qsPaymentMemo);

Default Value

""

Remarks

Memo attached to this payment from the customer to payee.

This is optional when submitting a payment request.

This property is not available at design time.

Data Type

String

PaymentPayeeAccount Property (BillPayment Class)

User's account number with the payee this payment was sent to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentPayeeAccount();

Unicode (Windows)
LPWSTR GetPaymentPayeeAccount();

char* inebank_billpayment_getpaymentpayeeaccount(void* lpObj);

QString GetPaymentPayeeAccount();

Default Value

""

Remarks

User's account number with the payee this payment was sent to.

This string uniquely identifies the customer in the payee (biller) system.

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

Data Type

String

PaymentPayeeAggregate Property (BillPayment Class)

Wrapper for the payee details this payment was sent to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentPayeeAggregate();

Unicode (Windows)
LPWSTR GetPaymentPayeeAggregate();

char* inebank_billpayment_getpaymentpayeeaggregate(void* lpObj);

QString GetPaymentPayeeAggregate();

Default Value

""

Remarks

Wrapper for the payee details this payment was sent to.

This string consists of these payee's data: name, address, city, state, country, postal code, country and phone.

When the SynchronizePayments is called, the SyncPayments event is fired for each payment in the payment list. Among other payment data returned through this event's parameters, there is also a PayeeAggregate parameter.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

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

Data Type

String

PaymentPayeeId Property (BillPayment Class)

Server-assigned identifier to the payee this payment was sent to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentPayeeId();

Unicode (Windows)
LPWSTR GetPaymentPayeeId();

char* inebank_billpayment_getpaymentpayeeid(void* lpObj);

QString GetPaymentPayeeId();

Default Value

""

Remarks

Server-assigned identifier to the payee this payment was sent to.

The PaymentPayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either PaymentPayeeAggregate or PaymentPayeeId can be returned in the response, but not both.

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

Data Type

String

PaymentPayeeListId Property (BillPayment Class)

Server-assigned payee list record ID for the payee this payment was sent to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentPayeeListId();

Unicode (Windows)
LPWSTR GetPaymentPayeeListId();

char* inebank_billpayment_getpaymentpayeelistid(void* lpObj);

QString GetPaymentPayeeListId();

Default Value

""

Remarks

Server-assigned payee list record ID for the payee this payment was sent to.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a PaymentPayeeId, the PaymentPayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a PaymentPayeeId to this payee.

This is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

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

Data Type

String

PaymentStatus Property (BillPayment Class)

Payment processing status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentStatus();

Unicode (Windows)
LPWSTR GetPaymentStatus();

char* inebank_billpayment_getpaymentstatus(void* lpObj);

QString GetPaymentStatus();

Default Value

""

Remarks

Payment processing status.

The possible values of this property are as follows:

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

Data Type

String

PaymentToAccountId Property (BillPayment Class)

Account number to which the money for this payment is sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentToAccountId();
int SetPaymentToAccountId(const char* lpszPaymentToAccountId);

Unicode (Windows)
LPWSTR GetPaymentToAccountId();
INT SetPaymentToAccountId(LPCWSTR lpszPaymentToAccountId);

char* inebank_billpayment_getpaymenttoaccountid(void* lpObj);
int inebank_billpayment_setpaymenttoaccountid(void* lpObj, const char* lpszPaymentToAccountId);

QString GetPaymentToAccountId();
int SetPaymentToAccountId(QString qsPaymentToAccountId);

Default Value

""

Remarks

Account number to which the money for this payment is sent.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with this bank.

It is optional to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

If PaymentToAccountType is set to CreditCard, the PaymentToAccountId should be a credit card account number.

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via PayeeId.

This property is not available at design time.

Data Type

String

PaymentToAccountType Property (BillPayment Class)

Indicates the type of account to which this payment is sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPaymentToAccountType();
int SetPaymentToAccountType(int iPaymentToAccountType);

Unicode (Windows)
INT GetPaymentToAccountType();
INT SetPaymentToAccountType(INT iPaymentToAccountType);

AT_CHECKING(0), 
AT_SAVINGS(1), 
AT_MONEY_MARKET(2), 
AT_LINE_OF_CREDIT(3), 
AT_CREDIT_CARD(4)

int inebank_billpayment_getpaymenttoaccounttype(void* lpObj);
int inebank_billpayment_setpaymenttoaccounttype(void* lpObj, int iPaymentToAccountType);

int GetPaymentToAccountType();
int SetPaymentToAccountType(int iPaymentToAccountType);

Default Value

0

Remarks

Indicates the type of account to which this payment is sent.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

This property uses the following four values:

• atChecking (0)
• atSavings (1)
• atMoneyMarket (2)
• atLineOfCredit (3)

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via PayeeId.

This property is not available at design time.

Data Type

Integer

PaymentToBankId Property (BillPayment Class)

Number that identifies the bank where the money is to be deposited.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentToBankId();
int SetPaymentToBankId(const char* lpszPaymentToBankId);

Unicode (Windows)
LPWSTR GetPaymentToBankId();
INT SetPaymentToBankId(LPCWSTR lpszPaymentToBankId);

char* inebank_billpayment_getpaymenttobankid(void* lpObj);
int inebank_billpayment_setpaymenttobankid(void* lpObj, const char* lpszPaymentToBankId);

QString GetPaymentToBankId();
int SetPaymentToBankId(QString qsPaymentToBankId);

Default Value

""

Remarks

Number that identifies the bank where the money is to be deposited.

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via PayeeId.

This property is not available at design time.

Data Type

String

PaymentTxType Property (BillPayment Class)

Transaction type performed on the payment being synchronized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTxType();

Unicode (Windows)
LPWSTR GetPaymentTxType();

char* inebank_billpayment_getpaymenttxtype(void* lpObj);

QString GetPaymentTxType();

Default Value

""

Remarks

Transaction type performed on the payment being synchronized.

This is applicable to payment synchronization requests only. Possible values and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (BillPayment Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int inebank_billpayment_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inebank_billpayment_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (BillPayment Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int inebank_billpayment_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inebank_billpayment_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (BillPayment Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int inebank_billpayment_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inebank_billpayment_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (BillPayment Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* inebank_billpayment_getsslcertstorepassword(void* lpObj);
int inebank_billpayment_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (BillPayment Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int inebank_billpayment_getsslcertstoretype(void* lpObj);
int inebank_billpayment_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (BillPayment Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* inebank_billpayment_getsslcertsubject(void* lpObj);
int inebank_billpayment_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (BillPayment Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int inebank_billpayment_getsslprovider(void* lpObj);
int inebank_billpayment_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (BillPayment Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int inebank_billpayment_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

SyncPayeeCount Property (BillPayment Class)

The number of records in the SyncPayee arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSyncPayeeCount();

Unicode (Windows)
INT GetSyncPayeeCount();

int inebank_billpayment_getsyncpayeecount(void* lpObj);

int GetSyncPayeeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SyncPayeeAccount
• SyncPayeeAddr1
• SyncPayeeAddr2
• SyncPayeeAddr3
• SyncPayeeAggregate
• SyncPayeeCity
• SyncPayeeCountry
• SyncPayeeDaysToPay
• SyncPayeeId
• SyncPayeeIdScope
• SyncPayeeListId
• SyncPayeeName
• SyncPayeePhone
• SyncPayeePostalCode
• SyncPayeeState
• SyncPayeeTxType

The array indices start at 0 and end at SyncPayeeCount - 1.

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

Data Type

Integer

SyncPayeeAccount Property (BillPayment Class)

User's account number with the payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeAccount(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeAccount(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeaccount(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeAccount(int iSyncPayeeIndex);

Default Value

""

Remarks

User's account number with the payee. This string uniquely identifies the customer in the payee (biller) system.

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeAddr1 Property (BillPayment Class)

Payee's address line 1.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeAddr1(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeAddr1(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeaddr1(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeAddr1(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's address line 1.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeAddr2 Property (BillPayment Class)

Payee's address line 2.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeAddr2(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeAddr2(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeaddr2(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeAddr2(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's address line 2.

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeAddr3 Property (BillPayment Class)

Payee's address line 3.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeAddr3(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeAddr3(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeaddr3(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeAddr3(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's address line 3.

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeAggregate Property (BillPayment Class)

Wrapper for payee details.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeAggregate(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeAggregate(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeaggregate(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeAggregate(int iSyncPayeeIndex);

Default Value

""

Remarks

Wrapper for payee details.

This string consists of all the payee's properties SyncPayeeId, SyncPayeeName, SyncPayeeAddr1, SyncPayeeAddr2, SyncPayeeAddr3, SyncPayeeCity, SyncPayeeState, SyncPayeePostalCode, SyncPayeeCountry, SyncPayeePhone, SyncPayeeIdScope, SyncPayeeDaysToPay, SyncPayeeListId, SyncPayeeAccount of the payee.

When the SynchronizePayees is called, the SyncPayees event is fired for each payee in the payee list. Among other payee data returned through this event's parameters, there is also a PayeeAggregate parameter.

When sending a payment request (by calling PayBill) to an existing payee in the list returned via the payee synchronization request, and when the SyncPayeeId is unknown or not assigned, instead of setting all payee's properties, the user can set the SyncPayeeAggregate to the value of PayeeAggregate returned for that payee from the SyncPayees event. When the SyncPayeeAggregate is set to this value, all payee's properties are populated with the corresponding values in the aggregate.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeCity Property (BillPayment Class)

Payee's city.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeCity(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeCity(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeecity(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeCity(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's city.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeCountry Property (BillPayment Class)

Payee's country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeCountry(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeCountry(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeecountry(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeCountry(int iSyncPayeeIndex);

Default Value

"USA"

Remarks

Payee's country. This is a 3 letter country code as representation of a country name (ISO/DIS-3166 3-letter country code standard).

This is optional and applicable only when the PayeeId is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeDaysToPay Property (BillPayment Class)

Minimum number of business days required to complete the payment transaction to this payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeDaysToPay(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeDaysToPay(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeedaystopay(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeDaysToPay(int iSyncPayeeIndex);

Default Value

""

Remarks

Minimum number of business days required to complete the payment transaction to this payee.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeId Property (BillPayment Class)

Server-assigned payee identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeId(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeId(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeid(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeId(int iSyncPayeeIndex);

Default Value

""

Remarks

Server-assigned payee identifier.

The SyncPayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either SyncPayeeId or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the SyncPayeeAggregate or payee details represented by required properties: SyncPayeeName, SyncPayeeAddr1, SyncPayeeCity, SyncPayeeState, SyncPayeePostalCode, SyncPayeePhone, and optional properties: SyncPayeeAddr2, SyncPayeeAddr3, SyncPayeeCountry, SyncPayeeAccount.

The SyncPayeeId might be populated when: either a payment request (PayBill method is called) or an add payee request (AddPayee method is called) has been sent to the payment server, or when the SyncPayeeAggregate has been set.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeIdScope Property (BillPayment Class)

Scope of the payee Id .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeIdScope(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeIdScope(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeeidscope(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeIdScope(int iSyncPayeeIndex);

Default Value

""

Remarks

Scope of the payee SyncPayeeId.

Possible values are:

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeListId Property (BillPayment Class)

Server-assigned payee list record ID for this payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeListId(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeListId(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeelistid(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeListId(int iSyncPayeeIndex);

Default Value

""

Remarks

Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a SyncPayeeId, the SyncPayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a SyncPayeeId to this payee.

It is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

The value of SyncPayeeListId is used as parameter when the ModifyPayee or DeletePayee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeName Property (BillPayment Class)

Name of the payee to whom the given Id or ListId corresponds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeName(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeName(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeename(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeName(int iSyncPayeeIndex);

Default Value

""

Remarks

Name of the payee to whom the given SyncPayeeId or SyncPayeeListId corresponds. This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

After sending payment or add/modify payee requests, if the returned SyncPayeeIdScope is GLOBAL, the SyncPayeeName will contain the standard payee name returned by the server.

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeePhone Property (BillPayment Class)

Payee's phone.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeePhone(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeePhone(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeephone(void* lpObj, int syncpayeeindex);

QString GetSyncPayeePhone(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's phone.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeePostalCode Property (BillPayment Class)

Payee's postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeePostalCode(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeePostalCode(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeepostalcode(void* lpObj, int syncpayeeindex);

QString GetSyncPayeePostalCode(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's postal code.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeState Property (BillPayment Class)

Payee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeState(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeState(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeestate(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeState(int iSyncPayeeIndex);

Default Value

""

Remarks

Payee's state

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPayeeTxType Property (BillPayment Class)

Transaction type performed on the payee being synchronized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPayeeTxType(int iSyncPayeeIndex);

Unicode (Windows)
LPWSTR GetSyncPayeeTxType(INT iSyncPayeeIndex);

char* inebank_billpayment_getsyncpayeetxtype(void* lpObj, int syncpayeeindex);

QString GetSyncPayeeTxType(int iSyncPayeeIndex);

Default Value

""

Remarks

Transaction type performed on the payee being synchronized.

This is applicable to payee synchronization requests only. Possible values and their meanings are as follows:

The SyncPayeeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPayeeCount property.

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

Data Type

String

SyncPaymentCount Property (BillPayment Class)

The number of records in the SyncPayment arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSyncPaymentCount();

Unicode (Windows)
INT GetSyncPaymentCount();

int inebank_billpayment_getsyncpaymentcount(void* lpObj);

int GetSyncPaymentCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SyncPaymentAggregate
• SyncPaymentAmount
• SyncPaymentBillRef
• SyncPaymentCheckNumber
• SyncPaymentCurrencyCode
• SyncPaymentDateDue
• SyncPaymentDateProcessed
• SyncPaymentId
• SyncPaymentMemo
• SyncPaymentPayeeAccount
• SyncPaymentPayeeAggregate
• SyncPaymentPayeeId
• SyncPaymentPayeeListId
• SyncPaymentStatus
• SyncPaymentTxType

The array indices start at 0 and end at SyncPaymentCount - 1.

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

Data Type

Integer

SyncPaymentAggregate Property (BillPayment Class)

Wrapper for a payment details.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentAggregate(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentAggregate(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentaggregate(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentAggregate(int iSyncPaymentIndex);

Default Value

""

Remarks

Wrapper for a payment details.

This string consists of all the payment's properties SyncPaymentId, SyncPaymentStatus, SyncPaymentAmount, SyncPaymentFromBankId, SyncPaymentFromAccountId, SyncPaymentFromAccountType, SyncPaymentMemo, SyncPaymentCheckNumber, etc..

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentAmount Property (BillPayment Class)

Payment amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentAmount(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentAmount(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentamount(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentAmount(int iSyncPaymentIndex);

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.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentBillRef Property (BillPayment Class)

Biller-supplied reference information when paying a bill, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentBillRef(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentBillRef(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentbillref(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentBillRef(int iSyncPaymentIndex);

Default Value

""

Remarks

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentCheckNumber Property (BillPayment Class)

Check number assigned by the server to this payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentCheckNumber(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentCheckNumber(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentchecknumber(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentCheckNumber(int iSyncPaymentIndex);

Default Value

""

Remarks

Check number assigned by the server to this payment.

This will be returned in the server response (if available) when the request succeeds.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentCurrencyCode Property (BillPayment Class)

Default currency code for this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentCurrencyCode(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentCurrencyCode(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentcurrencycode(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentCurrencyCode(int iSyncPaymentIndex);

Default Value

""

Remarks

Default currency code for this transaction.

This indicates the currency in which the payment will be carried out.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentDateDue Property (BillPayment Class)

Processing date requested by user for the payment to be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentDateDue(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentDateDue(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentdatedue(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentDateDue(int iSyncPaymentIndex);

Default Value

""

Remarks

Processing date requested by user for the payment to be sent.

This is required to be provided in any bill payment or payment modification requests.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentDateProcessed Property (BillPayment Class)

Payment processing date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentDateProcessed(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentDateProcessed(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentdateprocessed(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentDateProcessed(int iSyncPaymentIndex);

Default Value

""

Remarks

Payment processing date.

This indicates the date when the event described by SyncPaymentStatus occurs.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentId Property (BillPayment Class)

Transaction Id assigned by the server to the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentId(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentId(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentid(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentId(int iSyncPaymentIndex);

Default Value

""

Remarks

Transaction Id assigned by the server to the payment.

The SyncPaymentId is returned after a bill payment request (when calling the PayBill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the ModifyPayment or CancelPayment methods are called).

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentMemo Property (BillPayment Class)

Memo attached to this payment from the customer to payee.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSyncPaymentMemo(int iSyncPaymentIndex);

Unicode (Windows)
LPWSTR GetSyncPaymentMemo(INT iSyncPaymentIndex);

char* inebank_billpayment_getsyncpaymentmemo(void* lpObj, int syncpaymentindex);

QString GetSyncPaymentMemo(int iSyncPaymentIndex);

Default Value

""

Remarks

Memo attached to this payment from the customer to payee.

This is optional when submitting a payment request.

The SyncPaymentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String

SyncPaymentPayeeAccount Property (BillPayment Class)

User's account number with the payee this payment was sent to.

Syntax

• C++
• C
• Qt