BillPayment Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TiboBillPayment

Remarks

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

To use the BillPayment component, 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

FIId Property (BillPayment Component)

Financial institution identifier.

Syntax

__property String FIId = { read=FFIId, write=FSetFIId };

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 Component)

Financial institution organization name.

Syntax

__property String FIOrganization = { read=FFIOrganization, write=FSetFIOrganization };

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 Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (BillPayment Component)

This property determines the type of firewall to connect through.

Syntax

__property TiboBillPaymentFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TiboBillPaymentFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (BillPayment Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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 component raises an exception.

Data Type

String

FirewallPassword Property (BillPayment Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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 component raises an exception.

Data Type

String

FirewallPort Property (BillPayment Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

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 Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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 component raises an exception.

Data Type

String

FIUrl Property (BillPayment Component)

Financial institution URL.

Syntax

__property String FIUrl = { read=FFIUrl, write=FSetFIUrl };

Default Value

""

Remarks

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

Data Type

String

LostSync Property (BillPayment Component)

Whether the token in the synchronization request is older.

Syntax

__property bool LostSync = { read=FLostSync };

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 Component)

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

Syntax

__property String OFXAccessKey = { read=FOFXAccessKey, write=FSetOFXAccessKey };

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 component 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 component 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 component). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (BillPayment Component)

OFX application identifier.

Syntax

__property String OFXAppId = { read=FOFXAppId, write=FSetOFXAppId };

Default Value

""

Remarks

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

Data Type

String

OFXAppVersion Property (BillPayment Component)

OFX application version.

Syntax

__property String OFXAppVersion = { read=FOFXAppVersion, write=FSetOFXAppVersion };

Default Value

""

Remarks

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

Data Type

String

OFXPassword Property (BillPayment Component)

User's password.

Syntax

__property String OFXPassword = { read=FOFXPassword, write=FSetOFXPassword };

Default Value

""

Remarks

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

Data Type

String

OFXRequest Property (BillPayment Component)

The current OFX request aggregate.

Syntax

__property String OFXRequest = { read=FOFXRequest };

Default Value

""

Remarks

Polling OFXRequest will cause the component 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 Component)

The current OFX response aggregate.

Syntax

__property String OFXResponse = { read=FOFXResponse, write=FSetOFXResponse };

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 Component)

User's id.

Syntax

__property String OFXUser = { read=FOFXUser, write=FSetOFXUser };

Default Value

""

Remarks

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

Data Type

String

OFXVersion Property (BillPayment Component)

OFX API version.

Syntax

__property String OFXVersion = { read=FOFXVersion, write=FSetOFXVersion };

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 Component)

User's account number with the payee.

Syntax

__property String PayeeAccount = { read=FPayeeAccount, write=FSetPayeeAccount };

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 Component)

Payee's address line 1.

Syntax

__property String PayeeAddr1 = { read=FPayeeAddr1, write=FSetPayeeAddr1 };

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 Component)

Payee's address line 2.

Syntax

__property String PayeeAddr2 = { read=FPayeeAddr2, write=FSetPayeeAddr2 };

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 Component)

Payee's address line 3.

Syntax

__property String PayeeAddr3 = { read=FPayeeAddr3, write=FSetPayeeAddr3 };

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 Component)

Wrapper for payee details.

Syntax

__property String PayeeAggregate = { read=FPayeeAggregate, write=FSetPayeeAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Payee's city.

Syntax

__property String PayeeCity = { read=FPayeeCity, write=FSetPayeeCity };

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 Component)

Payee's country.

Syntax

__property String PayeeCountry = { read=FPayeeCountry, write=FSetPayeeCountry };

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 Component)

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

Syntax

__property String PayeeDaysToPay = { read=FPayeeDaysToPay };

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 Component)

Server-assigned payee identifier.

Syntax

__property String PayeeId = { read=FPayeeId, write=FSetPayeeId };

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 Component)

Scope of the payee Id .

Syntax

__property String PayeeIdScope = { read=FPayeeIdScope };

Default Value

""

Remarks

Scope of the payee PayeeId.

Possible values are:

This property is read-only.

Data Type

String

PayeeListId Property (BillPayment Component)

Server-assigned payee list record ID for this payee.

Syntax

__property String PayeeListId = { read=FPayeeListId, write=FSetPayeeListId };

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 Component)

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

Syntax

__property String PayeeName = { read=FPayeeName, write=FSetPayeeName };

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 Component)

Payee's phone.

Syntax

__property String PayeePhone = { read=FPayeePhone, write=FSetPayeePhone };

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 Component)

Payee's postal code.

Syntax

__property String PayeePostalCode = { read=FPayeePostalCode, write=FSetPayeePostalCode };

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 Component)

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

__property String PayeeState = { read=FPayeeState, write=FSetPayeeState };

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 Component)

Wrapper for a payment details.

Syntax

__property String PaymentAggregate = { read=FPaymentAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Payment amount.

Syntax

__property String PaymentAmount = { read=FPaymentAmount, write=FSetPaymentAmount };

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 component 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 component 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 Component)

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

Syntax

__property String PaymentBillRef = { read=FPaymentBillRef, write=FSetPaymentBillRef };

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 Component)

Check number assigned by the server to this payment.

Syntax

__property String PaymentCheckNumber = { read=FPaymentCheckNumber };

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 Component)

Default currency code for this transaction.

Syntax

__property String PaymentCurrencyCode = { read=FPaymentCurrencyCode };

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 Component)

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

Syntax

__property String PaymentDateDue = { read=FPaymentDateDue, write=FSetPaymentDateDue };

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 Component)

Payment processing date.

Syntax

__property String PaymentDateProcessed = { read=FPaymentDateProcessed };

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 Component)

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

Syntax

__property String PaymentFromAccountId = { read=FPaymentFromAccountId, write=FSetPaymentFromAccountId };

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 Component)

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

Syntax

__property TiboBillPaymentPaymentFromAccountTypes PaymentFromAccountType = { read=FPaymentFromAccountType, write=FSetPaymentFromAccountType };

enum TiboBillPaymentPaymentFromAccountTypes {
  atChecking=0,
  atSavings=1,
  atMoneyMarket=2,
  atLineOfCredit=3,
  atCreditCard=4
};

Default Value

atChecking

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 Component)

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

Syntax

__property String PaymentFromBankId = { read=FPaymentFromBankId, write=FSetPaymentFromBankId };

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 Component)

Transaction Id assigned by the server to the payment.

Syntax

__property String PaymentId = { read=FPaymentId, write=FSetPaymentId };

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 Component)

Memo attached to this payment from the customer to payee.

Syntax

__property String PaymentMemo = { read=FPaymentMemo, write=FSetPaymentMemo };

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 Component)

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

Syntax

__property String PaymentPayeeAccount = { read=FPaymentPayeeAccount };

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 Component)

Wrapper for the payee details this payment was sent to.

Syntax

__property String PaymentPayeeAggregate = { read=FPaymentPayeeAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

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

Syntax

__property String PaymentPayeeId = { read=FPaymentPayeeId };

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 Component)

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

Syntax

__property String PaymentPayeeListId = { read=FPaymentPayeeListId };

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 Component)

Payment processing status.

Syntax

__property String PaymentStatus = { read=FPaymentStatus };

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 Component)

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

Syntax

__property String PaymentToAccountId = { read=FPaymentToAccountId, write=FSetPaymentToAccountId };

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 Component)

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

Syntax

__property TiboBillPaymentPaymentToAccountTypes PaymentToAccountType = { read=FPaymentToAccountType, write=FSetPaymentToAccountType };

enum TiboBillPaymentPaymentToAccountTypes {
  atChecking=0,
  atSavings=1,
  atMoneyMarket=2,
  atLineOfCredit=3,
  atCreditCard=4
};

Default Value

atChecking

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 Component)

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

Syntax

__property String PaymentToBankId = { read=FPaymentToBankId, write=FSetPaymentToBankId };

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 Component)

Transaction type performed on the payment being synchronized.

Syntax

__property String PaymentTxType = { read=FPaymentTxType };

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 Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (BillPayment Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (BillPayment Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Byte Array

SSLCertStorePassword Property (BillPayment Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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 Component)

This is the type of certificate store for this certificate.

Syntax

__property TiboBillPaymentSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TiboBillPaymentSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (BillPayment Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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 Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TiboBillPaymentSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TiboBillPaymentSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (BillPayment Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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

Byte Array

SyncPayeeCount Property (BillPayment Component)

The number of records in the SyncPayee arrays.

Syntax

__property int SyncPayeeCount = { read=FSyncPayeeCount };

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 Component)

User's account number with the payee.

Syntax

__property String SyncPayeeAccount[int SyncPayeeIndex] = { read=FSyncPayeeAccount };

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 Component)

Payee's address line 1.

Syntax

__property String SyncPayeeAddr1[int SyncPayeeIndex] = { read=FSyncPayeeAddr1 };

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 Component)

Payee's address line 2.

Syntax

__property String SyncPayeeAddr2[int SyncPayeeIndex] = { read=FSyncPayeeAddr2 };

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 Component)

Payee's address line 3.

Syntax

__property String SyncPayeeAddr3[int SyncPayeeIndex] = { read=FSyncPayeeAddr3 };

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 Component)

Wrapper for payee details.

Syntax

__property String SyncPayeeAggregate[int SyncPayeeIndex] = { read=FSyncPayeeAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Payee's city.

Syntax

__property String SyncPayeeCity[int SyncPayeeIndex] = { read=FSyncPayeeCity };

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 Component)

Payee's country.

Syntax

__property String SyncPayeeCountry[int SyncPayeeIndex] = { read=FSyncPayeeCountry };

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 Component)

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

Syntax

__property String SyncPayeeDaysToPay[int SyncPayeeIndex] = { read=FSyncPayeeDaysToPay };

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 Component)

Server-assigned payee identifier.

Syntax

__property String SyncPayeeId[int SyncPayeeIndex] = { read=FSyncPayeeId };

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 Component)

Scope of the payee Id .

Syntax

__property String SyncPayeeIdScope[int SyncPayeeIndex] = { read=FSyncPayeeIdScope };

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 Component)

Server-assigned payee list record ID for this payee.

Syntax

__property String SyncPayeeListId[int SyncPayeeIndex] = { read=FSyncPayeeListId };

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 Component)

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

Syntax

__property String SyncPayeeName[int SyncPayeeIndex] = { read=FSyncPayeeName };

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 Component)

Payee's phone.

Syntax

__property String SyncPayeePhone[int SyncPayeeIndex] = { read=FSyncPayeePhone };

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 Component)

Payee's postal code.

Syntax

__property String SyncPayeePostalCode[int SyncPayeeIndex] = { read=FSyncPayeePostalCode };

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 Component)

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

__property String SyncPayeeState[int SyncPayeeIndex] = { read=FSyncPayeeState };

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 Component)

Transaction type performed on the payee being synchronized.

Syntax

__property String SyncPayeeTxType[int SyncPayeeIndex] = { read=FSyncPayeeTxType };

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 Component)

The number of records in the SyncPayment arrays.

Syntax

__property int SyncPaymentCount = { read=FSyncPaymentCount };

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 Component)

Wrapper for a payment details.

Syntax

__property String SyncPaymentAggregate[int SyncPaymentIndex] = { read=FSyncPaymentAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Payment amount.

Syntax

__property String SyncPaymentAmount[int SyncPaymentIndex] = { read=FSyncPaymentAmount };

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 component 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 component 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 Component)

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

Syntax

__property String SyncPaymentBillRef[int SyncPaymentIndex] = { read=FSyncPaymentBillRef };

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 Component)

Check number assigned by the server to this payment.

Syntax

__property String SyncPaymentCheckNumber[int SyncPaymentIndex] = { read=FSyncPaymentCheckNumber };

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 Component)

Default currency code for this transaction.

Syntax

__property String SyncPaymentCurrencyCode[int SyncPaymentIndex] = { read=FSyncPaymentCurrencyCode };

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 Component)

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

Syntax

__property String SyncPaymentDateDue[int SyncPaymentIndex] = { read=FSyncPaymentDateDue };

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 Component)

Payment processing date.

Syntax

__property String SyncPaymentDateProcessed[int SyncPaymentIndex] = { read=FSyncPaymentDateProcessed };

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 Component)

Transaction Id assigned by the server to the payment.

Syntax

__property String SyncPaymentId[int SyncPaymentIndex] = { read=FSyncPaymentId };

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 Component)

Memo attached to this payment from the customer to payee.

Syntax

__property String SyncPaymentMemo[int SyncPaymentIndex] = { read=FSyncPaymentMemo };

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 Component)

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

Syntax

__property String SyncPaymentPayeeAccount[int SyncPaymentIndex] = { read=FSyncPaymentPayeeAccount };

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.

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

SyncPaymentPayeeAggregate Property (BillPayment Component)

Wrapper for the payee details this payment was sent to.

Syntax

__property String SyncPaymentPayeeAggregate[int SyncPaymentIndex] = { read=FSyncPaymentPayeeAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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

SyncPaymentPayeeId Property (BillPayment Component)

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

Syntax

__property String SyncPaymentPayeeId[int SyncPaymentIndex] = { read=FSyncPaymentPayeeId };

Default Value

""

Remarks

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

The SyncPaymentPayeeId 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 SyncPaymentPayeeAggregate or SyncPaymentPayeeId can be returned in the response, but not both.

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

SyncPaymentPayeeListId Property (BillPayment Component)

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

Syntax

__property String SyncPaymentPayeeListId[int SyncPaymentIndex] = { read=FSyncPaymentPayeeListId };

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 SyncPaymentPayeeId, the SyncPaymentPayeeListId 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 SyncPaymentPayeeId 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.

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

SyncPaymentStatus Property (BillPayment Component)

Payment processing status.

Syntax

__property String SyncPaymentStatus[int SyncPaymentIndex] = { read=FSyncPaymentStatus };

Default Value

""

Remarks

Payment processing status.

The possible values of this property are as follows:

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

SyncPaymentTxType Property (BillPayment Component)

Transaction type performed on the payment being synchronized.

Syntax

__property String SyncPaymentTxType[int SyncPaymentIndex] = { read=FSyncPaymentTxType };

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:

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

Timeout Property (BillPayment Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

AddPayee Method (BillPayment Component)

Add a payee to server's payee list.

Syntax

void __fastcall AddPayee();

Remarks

This function generates the Signon and Add Payee request, submits it to the financial institution via HTTP, receives the response, and parses it.

The following properties can be set when this method is called:

Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:

CancelPayment Method (BillPayment Component)

Cancels a scheduled bill payment.

Syntax

void __fastcall CancelPayment(String PaymentId);

Remarks

This function generates the Signon and Payment Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the payment to be canceled. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in PaymentId).

The following properties should be set when this method is called:

Upon successful response, the server will return the PaymentId which echoes the PaymentId.

Config Method (BillPayment Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DeletePayee Method (BillPayment Component)

Deletes a payee identified by ListId from the server payee list.

Syntax

void __fastcall DeletePayee(String ListId);

Remarks

This function generates the Signon and Delete Payee request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The ListId parameter identifies the payee to be deleted. This is the id returned by the server at the time the payee was added to the payee list (that was stored in PayeeListId).

The following properties should be set when this method is called:

Upon successful response, the server will return the PayeeListId that echoes the ListId input parameter.

GetStatus Method (BillPayment Component)

Obtains the current processing status of a payment.

Syntax

void __fastcall GetStatus(String PaymentId);

Remarks

The PaymentId parameter identifies the payment you want to obtain the status for. This is the id returned by the server at the time the payment was scheduled (that was stored in PaymentId).

The following properties should be set when this method is called:

Upon successful response, the server will return the following:

ModifyPayee Method (BillPayment Component)

Modifies a payee identified by ListId that already exists in the payee list.

Syntax

void __fastcall ModifyPayee(String PayeeListId);

Remarks

This function generates the Signon and Payee Modification request, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

When modifying a payee by calling the ModifyPayee method, the user must specify the changed and unchanged payee information (i.e., all the properties that were specified when the payee was first added to the server list).

The ListId parameter identifies the payee to be modified. This is the id returned by the server at the time the payee was added to the payee list.

The response normally just echoes the values passed in the request. However, when a change had already occurred in the server to the payee information (for example a change in the payee's lead time, indicated by PayeeDaysToPay), the response will include this information as well.

If the response indicates either that a payee now has a payee ID (a non-empty PayeeId is returned in the response) or no longer has one (an empty PayeeId is returned), then the user now becomes aware that this ID cannot be used as an appropriate form of designating the payee in any future payment requests to that payee.

ModifyPayment Method (BillPayment Component)

Modifies a scheduled payment.

Syntax

void __fastcall ModifyPayment(String PaymentId);

Remarks

This function generates the Signon and Payment Modification request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the targeted payment to be modified. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in PaymentId).

Between the time the client schedules a payment and the time the server processes the payment, the client may request changes (if the server allows it) to certain parameters of that payment. For example, the PaymentAmount or PaymentDateDue of the payment can be modified. This can be done by calling the ModifyPayment method. The request must specify the full contents of the payment request, including both modified and unmodified data.

The user should provide all the fields that were specified when the payment to be modified was created (when the PayBill method was called) and the PayeeListId if this was assigned. All data can be modified except the PayeeName and PayeeId.

The response normally just echoes the values passed in the request. However, if the status of a scheduled payment changes in any way, the user should expect to receive modification responses when synchronizing with the server by calling Synchronize method. For example, when a server completes a payment, the status of the payment goes from pending to posted. This status change will be included in the server response.

Please check your FI profile to see if they provide this service (bill payment modification).

PayBill Method (BillPayment Component)

Pays a bill to a given payee.

Syntax

void __fastcall PayBill();

Remarks

This function generates the Signon and Bill Payment request page, submits it to the financial institution via HTTP, receives the response, and parses it.

The following properties can be set when this method is called:

Payee information can be provided in the request by either setting each Payee property, or by setting the PayeeAggregate property, the value of which can be retrieved after submitting a payee synchronization request (by calling the SynchronizePayees method).

Even when PayeeAggregate property has been set, the user can still set any payee field to values different from the ones that are populated via PayeeAggregate. When this happens, the server will consider this payment request as payee modification request as well. As result, that payee will be modified in the payment system accordingly.

Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:

Reset Method (BillPayment Component)

Reset the internal state of the component and all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

SynchronizePayees Method (BillPayment Component)

Synchronizes payees on the client side with payees on record on the server side.

Syntax

String __fastcall SynchronizePayees(String Token);

Remarks

Users of OFX Payments need to be able to obtain the current list of payees stored on the server that is configured for use in payments. In a "pay some" system, users are sometimes required to explicitly configure the payees to whom the system will make payments. This can be done by means of a telephone call to the payments provider or through other methods such as AddPayee or PayBill. It is only necessary to enter each payee once. In other systems, the payments provider can elect to store a list of all payees that the user has paid. This is a convenience to the client. It allows payees set up on one client to be accessible from a user's other clients. In this case, payee list synchronization provides a way for the payee to become accessible to the client software when the FI completes the setup.

The list can contain payees with or without payee IDs. An important function of the payee list is to communicate payee changes from the server to the client. This includes changes in processing date parameters and conversion of a payee to a standard payee.

Once added to the list, the payment system makes payments by the payee list ID. This makes it clear to a client when the user is adding to a payee list, and when he or she modifies an existing payee on the list. Although the messages make it clear whether a client is trying to add a new payee, a careful server will check for exact matches on payee adds and not create new payee list entries unnecessarily.

"Pay-any" systems can perform background processing that matches billing addresses with standard payees. When this occurs the server can update the relevant payee lists, and update the clients when they synchronize with the modified list data. Each payee entry in the list can also include a list of the user's accounts with that payee. This further reduces the data entry required by a user to make a payment, and facilitates the implementation of lightweight clients.

In order to accomplish these tasks, the user has to submit a synchronization request by calling SynchronizePayees method to insure that it has an accurate copy of the server data that is relevant to the client application. The intent of this request is to address the following scenarios in which the client might lose synchronization with the server:

• Payees relevant to the client's application state have been added, deleted, or modified by a second client. For example, a user might enter or change payees from more than one PC or application.
• A communications session between the client and server was interrupted or completed abnormally. As a result, the client does not have responses from the server indicating that all the payees were received and processed.

If this request is submitted for the first time to the server, the Token parameter has to be 0. In this case, servers should send all available history, allowing a new client (for example) to know about work done by other clients. If a user's account has never been used with OFX, the server returns no history.

Unless the synchronization is a refresh request (see below), in all subsequent requests, this has to be the previous value of Token this method returned (i.e., received for this type of synchronization request from the server). This will serve as the user's own endpoint. When the server supplies a response, it supplies a new endpoint (Token) as well. A token needs to be unique only within payments for the specified account.

A brand new client, or a client that lost synchronization, might want to learn about mot recent payee list by submitting a payee synchronization refresh (i.e., wants a set of changes, rather than asking the server to send everything it knows).

A client can request a refresh of current state by calling the SynchronizePayees method, where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you create a payee and then modify it three times, even if this history would have been available for a regular synchronization, on a synchronization refresh request the servers should only send a single add that reflects the current state.

If the response contains a list of payees, then the SyncPayees property will be populated and SyncPayees event will be fired for each payee. A single payee has a single PayeeId and/or PayeeListId, but it can undergo several state changes over its life and thus might have several entries in the token history.

SynchronizePayments Method (BillPayment Component)

Synchronizes bills paid on the client side with paid bills on record on the server side.

Syntax

String __fastcall SynchronizePayments(String Token);

Remarks

The bill payment synchronization request (as all other bill payment requests: add, modify, cancel) is applicable for bank accounts only and not for the credit card accounts.

Users of OFX Payments need to be able to obtain the current status of transactions previously sent to the server for processing. For example, once the user schedules a payment and the payment date has passed, the user might want to verify that the server made the payment as directed. Additionally, OFX allows for interactions with the server through multiple clients. This means, for example, that the user can perform some transactions from a home PC and others from an office computer with each session incorporating the activities performed on the other. In order to accomplish these tasks, the user has to submit a synchronization request by calling SynchronizePayments method to insure that it has an accurate copy of the server data that is relevant to the client application. The intent of this request is to address three scenarios in which the client might lose synchronization with the server:

• A transaction has changed its state based on processing actions on the server. For example, a scheduled payment has passed its due date and has been paid or rejected.
• Transactions relevant to the client's application state have been added, deleted, or modified by a second client. For example, a user might enter or change transactions from more than one PC or application.
• A communications session between the client and server was interrupted or completed abnormally. As a result the client does not have responses from the server indicating that all the transactions were received and processed.

If this request is submitted for the first time to the server, the Token parameter has to be 0. In this case, servers should send all available history, allowing a new client (for example) to know about work done by other clients. If a user's account has never been used with OFX, the server returns no history.

Unless the synchronization is a refresh request (see below), in all subsequent requests, this has to be the previous value of Token this method returned (i.e., received for this type of synchronization request from the server). This will serve as the user's own endpoint. When the server supplies a response, it supplies a new endpoint (Token) as well. A token needs to be unique only within payments for the specified account.

A brand new client, or a client that lost synchronization, might want to learn about in-progress payments by submitting a synchronization refresh of the payment requests (i.e., wants a set of changes, rather than asking the server to send everything it knows). It would almost certainly want to do a synchronization refresh of the recurring payment models, because these often live for months or years.

A client can request a refresh of current state by calling the SynchronizePayments where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you create a payment and then modify it three times, even if this history would have been available for a regular synchronization, on a synchronization refresh request the servers should only send a single add that reflects the current state.

The following properties have to be set when this method is called:

Upon a successful reply, if the response contains payment aggregates, then the SyncPayments property will be populated and SyncPayments event will be fired for each payment transaction. A single payment has a single PaymentId, but it can undergo several state changes over its life and thus might have several entries in the token history.

ConnectionStatus Event (BillPayment Component)

This event is fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TiboBillPaymentConnectionStatusEventParams;
typedef void __fastcall (__closure *TiboBillPaymentConnectionStatusEvent)(System::TObject* Sender, TiboBillPaymentConnectionStatusEventParams *e);
__property TiboBillPaymentConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Error Event (BillPayment Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiboBillPaymentErrorEventParams;
typedef void __fastcall (__closure *TiboBillPaymentErrorEvent)(System::TObject* Sender, TiboBillPaymentErrorEventParams *e);
__property TiboBillPaymentErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (BillPayment Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TiboBillPaymentSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TiboBillPaymentSSLServerAuthenticationEvent)(System::TObject* Sender, TiboBillPaymentSSLServerAuthenticationEventParams *e);
__property TiboBillPaymentSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (BillPayment Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TiboBillPaymentSSLStatusEventParams;
typedef void __fastcall (__closure *TiboBillPaymentSSLStatusEvent)(System::TObject* Sender, TiboBillPaymentSSLStatusEventParams *e);
__property TiboBillPaymentSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

SyncPayees Event (BillPayment Component)

Fired for each payee included in the synchronization response.

Syntax

typedef struct {
  String PayeeAggregate;
  String PayeeTxType;
  String PayeeId;
  String PayeeIdScope;
  String PayeeListId;
  String PayeeAccount;
  String PayeeName;
  String PayeeAddr1;
  String PayeeAddr2;
  String PayeeAddr3;
  String PayeeCity;
  String PayeeState;
  String PayeePostalCode;
  String PayeeCountry;
  String PayeePhone;
} TiboBillPaymentSyncPayeesEventParams;
typedef void __fastcall (__closure *TiboBillPaymentSyncPayeesEvent)(System::TObject* Sender, TiboBillPaymentSyncPayeesEventParams *e);
__property TiboBillPaymentSyncPayeesEvent OnSyncPayees = { read=FOnSyncPayees, write=FOnSyncPayees };

Remarks

When this event is fired for each payee included in the response (if any), the following are returned for each payee identified by PayeeListId:

• PayeeAggregate contains the complete aggregate for a payee.
• PayeeTxType indicates the payee transaction type, if this is added, modified or deleted (possible values: ADDED, MODIFIED, DELETED).
• PayeeId contains the server-assigned id of a payee.
• PayeeIdScope contains Scope of a payee ID in the payee list (GLOBAL, USER), where GLOBAL = payee ID valid across the entire payment system USER = payee ID valid with all FI accounts set up for the user's payments account.
• PayeeListId contains the list record id of a payee in the payee list.
• PayeeAccount contains the account the user has with a payee in the payee list.
• PayeeName contains the name of a payee in the payee list.
• PayeeAddr1 contains the street address (line 1) of a payee in the payee list.
• PayeeAddr2 contains the address line 2 of a payee in the payee list.
• PayeeAddr3 contains the address line 3 of a payee in the payee list.
• PayeeCity contains the city name of a payee in the payee list.
• PayeeState contains the state name of a payee in the payee list.
• PayeePostalCode contains the postal code of a payee in the payee list.
• PayeeCountry contains the country name of a payee in the payee list.
• PayeePhone contains the phone number of a payee in the payee list.

If what you need is not returned through this event parameters, you can always parse each PayeeAggregate using our OFXAggregate component.

SyncPayments Event (BillPayment Component)

Fired for each payment transaction included in the synchronization response.

Syntax

typedef struct {
  String PaymentAggregate;
  String PaymentTxType;
  String PaymentId;
  String PayeeId;
  String PayeeListId;
  String PayeeAccount;
  String PayeeAggregate;
  String PaymentAmount;
  String FromAccountId;
  String PaymentStatus;
  String PaymentDate;
} TiboBillPaymentSyncPaymentsEventParams;
typedef void __fastcall (__closure *TiboBillPaymentSyncPaymentsEvent)(System::TObject* Sender, TiboBillPaymentSyncPaymentsEventParams *e);
__property TiboBillPaymentSyncPaymentsEvent OnSyncPayments = { read=FOnSyncPayments, write=FOnSyncPayments };

Remarks

When this event is fired for each payment transaction included in the response (if any), the following are returned for each payment transaction identified by PaymentId:

• PaymentAggregate contains the aggregate for a payment transaction.
• PaymentTxType indicates the payment transaction type, if this is added, modified or canceled (possible values: ADDED, MODIFIED, CANCELLED).
• PaymentId contains the server id of a transaction in the list of payment transactions (if any) returned in the synchronization response.
• PayeeId contains the id of the payee the payment has been sent to.
• PayeeListId contains the list id of the payee the payment has been sent to.
• PayeeAccount contains the account the user has with the payee the payment has been sent to.
• PayeeAggregate contains the info aggregate (name and address details) of the payee the payment has been sent to.
• PaymentAmount contains the amount of a payment transaction.
• FromAccountId contains the account number a payment has been sent from.
• PaymentStatus contains the status of a payment transaction.
• PaymentDate contains the date of a payment transaction.

If what you need is not returned through this event, you can always parse each PaymentAggregate using our OFXAggregate component.

Config Settings (BillPayment Component)

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Trappable Errors (BillPayment Component)

OFX Errors

	2000   Required field missing from server response.
	2001   OFX server error. Description follows.
	2002   Invalid OFX response.
	2003   OFX response contains unknown element tags.

The component may also return one of the following error codes, which are inherited from other components.

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.