E-Banking Integrator BillPayment Component : BillPayment OCX, BillPayment .NET Component, BillPayment Class, BillPayment Bean, BillPayment Object

Available in: OFX | QUICKBOOKS

BillPayment Component [E-Banking Integrator V3]

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 OFX Specification 1.x and 2.x.

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

set Payment (Payment, Payment, and Payment properties to the values corresponding to the account from which you wish to pay the bill, Payment to the desired amount, Payment to the date payment has to be processed);
set Payee (by providing either Payee or: payee full information (via Payee or by setting each payee property such as Payee, Payee, Payee, Payee (if assigned by the server) and Payee 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 Payment, Payment and Payment 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 Payee and Payee 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 Payment or Payment 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 Payee and Payee. 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.


FIId	Financial institution identifier.
FIOrganization	Financial institution organization name.
Firewall	A set of properties related to firewall access.
FIUrl	Financial institution URL.
LostSync	Whether the token in the synchronization request is older.
OFXAccessKey	Access key value received after a MFA authentication in a previous signon.
OFXAppId	OFX application identifier.
OFXAppVersion	OFX application version.
OFXPassword	User's password.
OFXRequest	The current OFX request aggregate.
OFXResponse	The current OFX response aggregate.
OFXUser	User's id.
OFXVersion	OFX API version
Payee	Identifies the payee to be added, modified or paid to.
Payment	Identifies the payment to be scheduled or modified.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
SyncPayees	A list of payees being synchronized.
SyncPayments	A list of bill payments being synchronized.
Timeout	A timeout for the component.

Method List

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


AddPayee	Add a payee to server's payee list.
CancelPayment	Cancels a scheduled bill payment.
Config	Sets or retrieves a configuration setting.
DeletePayee	Deletes a payee identified by ListId from the server payee list.
GetStatus	Obtains the current processing status of a payment.
ModifyPayee	Modifies a payee identified by ListId that already exists in the payee list.
ModifyPayment	Modifies a scheduled payment.
PayBill	Pays a bill to a given payee.
Reset	Reset the internal state of the component and all properties to their default values.
SynchronizePayees	Synchronizes payees on the client side with payees on record on the server side.
SynchronizePayments	Synchronizes bills paid on the client side with paid bills on record on the server side.

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.


ConnectionStatus	Fired to indicate changes in connection state.
Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
SyncPayees	Fired for each payee included in the synchronization response.
SyncPayments	Fired for each payment transaction included in the synchronization response.

Configuration Settings

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


CurrencyFormat	The format to be used for returning currency values
OFXDateFormat	The date format as required by OFX FI server
DateFormat	The format to be used for input and output dates
NewPassword	New password for the current OFX user
OFXLog	Log file for the OFX transaction
ServerMessage	Server message if a warning or other information returned
ClientUId	Unique ID identifying OFX Client
UserCred1A	Additional user credential required by server
UserCred2A	Additional user credential required by server
AuthToken	Authentication token required for this signon session only
AcceptEncoding	Used to tell the server which types of content encodings the client supports
AllowHTTPCompression	This property enables HTTP compression for receiving data
Authorization	The Authorization string to be sent to the server
EncodeURL	If set to true the URL will be encoded by the component
GetOn302Redirect	If set to true the component will perform a GET on the new location
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document
KeepAlive	Determines whether the HTTP connection is closed after completion of the request
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
ProxyAuthorization	The authorization string to be sent to the proxy server
ProxyAuthScheme	The authorization scheme to be used for the proxy
ProxyPassword	A password if authentication is to be used for the proxy
ProxyPort	Port for the proxy server (default 80)
ProxyServer	Name or IP address of a proxy server (optional)
ProxyUser	A user name if authentication is to be used for the proxy
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component
UsePlatformHTTPClient	Whether or not to use the platform HTTP client
UserAgent	Information about the user agent (browser)
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making HTTP requests through WinInet
MaxLineLength	The maximum amount of data to accumulate when no EOL is found
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHost	Name or IP address of firewall (optional)
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall
FirewallPort	The TCP port for the FirewallHost;
FirewallUser	A user name if authentication is to be used connecting through a firewall
FirewallType	Determines the type of firewall to connect through
TcpNoDelay	Whether or not to delay when sending packets
ReuseSSLSession	Determines if the SSL session is reused
SSLCipherStrength	The minimum cipher strength used for bulk encryption
SSLEnabledProtocols	Used to enable/disable the supported security protocols
SSLProvider	The name of the security provider to use
SSLSecurityFlags	Flags that control certificate verification
OpenSSLCADir	The path to a directory containing CA certificates
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application
OpenSSLCipherList	A string that controls the ciphers to be used by SSL
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG)
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts
FirewallData	Used to send extra data to the firewall
InBufferSize	The size in bytes of the incoming queue of the socket
OutBufferSize	The size in bytes of the outgoing queue of the socket
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only)