Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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 FromBankId, FromAccountId, and FromAccountType properties to the values corresponding to the account from which you wish to pay the bill, Amount to the desired amount, DueDate to the date payment has to be processed, provide 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.

When the response returns, the PaymentId, PaymentStatus and PaymentDate properties will be populated, indicating the status of your payment. If your FI supports assigning id to payees, an id and list id to that payer might be returned in the server response. These values will be stored in PayeeId and PayeeListId properties.

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 Amount or DueDate of the payment can be modified. To accomplish this, 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 reporting the date the server actually processed a payment, or 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.

Bil payments are subject to synchronization which can be done by calling the SyncPayments method.

Method List

Event List

Configuration Settings