BillPayment Bean

Properties   Methods   Events   Configuration 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

InEBank.Billpayment

Remarks

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

To use the BillPayment bean, 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 (FromBankId, FromAccountId, and FromAccountType fields to the values corresponding to the account from which you wish to pay the bill, Amount to the desired amount, DateDue to the date payment has to be processed);
• set Payee (by providing either Id or: payee full information (via Aggregate or by setting each payee field such as Name, Addr1, Phone, ListId (if assigned by the server) and Account 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 Id, Status and DateProcessed fields 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 Id and ListId 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 Amount or DateDue 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 Name and Id. 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.