BillPayment Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

InEBank_BillPayment

Procedural Interface

 inebank_billpayment_open();
 inebank_billpayment_close($res);
 inebank_billpayment_register_callback($res, $id, $function);
 inebank_billpayment_get_last_error($res);
 inebank_billpayment_get_last_error_code($res);
 inebank_billpayment_set($res, $id, $index, $value);
 inebank_billpayment_get($res, $id, $index);
 inebank_billpayment_do_addpayee($res);
 inebank_billpayment_do_cancelpayment($res, $paymentid);
 inebank_billpayment_do_config($res, $configurationstring);
 inebank_billpayment_do_deletepayee($res, $listid);
 inebank_billpayment_do_getstatus($res, $paymentid);
 inebank_billpayment_do_modifypayee($res, $payeelistid);
 inebank_billpayment_do_modifypayment($res, $paymentid);
 inebank_billpayment_do_paybill($res);
 inebank_billpayment_do_reset($res);
 inebank_billpayment_do_synchronizepayees($res, $token);
 inebank_billpayment_do_synchronizepayments($res, $token);

Remarks

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

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

Next:

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

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

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

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

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

FIId Property (InEBank_BillPayment Class)

Financial institution identifier.

Object Oriented Interface

public function getFIId();
public function setFIId($value);

Procedural Interface

inebank_billpayment_get($res, 1 );
inebank_billpayment_set($res, 1, $value );

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 (InEBank_BillPayment Class)

Financial institution organization name.

Object Oriented Interface

public function getFIOrganization();
public function setFIOrganization($value);

Procedural Interface

inebank_billpayment_get($res, 2 );
inebank_billpayment_set($res, 2, $value );

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 (InEBank_BillPayment Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

inebank_billpayment_get($res, 3 );
inebank_billpayment_set($res, 3, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (InEBank_BillPayment Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

inebank_billpayment_get($res, 4 );
inebank_billpayment_set($res, 4, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (InEBank_BillPayment Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

inebank_billpayment_get($res, 5 );
inebank_billpayment_set($res, 5, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (InEBank_BillPayment Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

inebank_billpayment_get($res, 6 );
inebank_billpayment_set($res, 6, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (InEBank_BillPayment Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

inebank_billpayment_get($res, 7 );
inebank_billpayment_set($res, 7, $value );

Default Value

0

Remarks

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 (InEBank_BillPayment Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

inebank_billpayment_get($res, 8 );
inebank_billpayment_set($res, 8, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIUrl Property (InEBank_BillPayment Class)

Financial institution URL.

Object Oriented Interface

public function getFIUrl();
public function setFIUrl($value);

Procedural Interface

inebank_billpayment_get($res, 9 );
inebank_billpayment_set($res, 9, $value );

Default Value

''

Remarks

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

Data Type

String

LostSync Property (InEBank_BillPayment Class)

Whether the token in the synchronization request is older.

Object Oriented Interface

public function getLostSync();

Procedural Interface

inebank_billpayment_get($res, 10 );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getOFXAccessKey();
public function setOFXAccessKey($value);

Procedural Interface

inebank_billpayment_get($res, 11 );
inebank_billpayment_set($res, 11, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

OFXAppId Property (InEBank_BillPayment Class)

OFX application identifier.

Object Oriented Interface

public function getOFXAppId();
public function setOFXAppId($value);

Procedural Interface

inebank_billpayment_get($res, 12 );
inebank_billpayment_set($res, 12, $value );

Default Value

''

Remarks

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

Data Type

String

OFXAppVersion Property (InEBank_BillPayment Class)

OFX application version.

Object Oriented Interface

public function getOFXAppVersion();
public function setOFXAppVersion($value);

Procedural Interface

inebank_billpayment_get($res, 13 );
inebank_billpayment_set($res, 13, $value );

Default Value

''

Remarks

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

Data Type

String

OFXPassword Property (InEBank_BillPayment Class)

User's password.

Object Oriented Interface

public function getOFXPassword();
public function setOFXPassword($value);

Procedural Interface

inebank_billpayment_get($res, 14 );
inebank_billpayment_set($res, 14, $value );

Default Value

''

Remarks

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

Data Type

String

OFXRequest Property (InEBank_BillPayment Class)

The current OFX request aggregate.

Object Oriented Interface

public function getOFXRequest();

Procedural Interface

inebank_billpayment_get($res, 15 );

Default Value

''

Remarks

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

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

Data Type

String

OFXResponse Property (InEBank_BillPayment Class)

The current OFX response aggregate.

Object Oriented Interface

public function getOFXResponse();
public function setOFXResponse($value);

Procedural Interface

inebank_billpayment_get($res, 16 );
inebank_billpayment_set($res, 16, $value );

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 (InEBank_BillPayment Class)

User's id.

Object Oriented Interface

public function getOFXUser();
public function setOFXUser($value);

Procedural Interface

inebank_billpayment_get($res, 17 );
inebank_billpayment_set($res, 17, $value );

Default Value

''

Remarks

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

Data Type

String

OFXVersion Property (InEBank_BillPayment Class)

OFX API version.

Object Oriented Interface

public function getOFXVersion();
public function setOFXVersion($value);

Procedural Interface

inebank_billpayment_get($res, 18 );
inebank_billpayment_set($res, 18, $value );

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 (InEBank_BillPayment Class)

User's account number with the payee.

Object Oriented Interface

public function getPayeeAccount();
public function setPayeeAccount($value);

Procedural Interface

inebank_billpayment_get($res, 19 );
inebank_billpayment_set($res, 19, $value );

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 (InEBank_BillPayment Class)

Payee's address line 1.

Object Oriented Interface

public function getPayeeAddr1();
public function setPayeeAddr1($value);

Procedural Interface

inebank_billpayment_get($res, 20 );
inebank_billpayment_set($res, 20, $value );

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 (InEBank_BillPayment Class)

Payee's address line 2.

Object Oriented Interface

public function getPayeeAddr2();
public function setPayeeAddr2($value);

Procedural Interface

inebank_billpayment_get($res, 21 );
inebank_billpayment_set($res, 21, $value );

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 (InEBank_BillPayment Class)

Payee's address line 3.

Object Oriented Interface

public function getPayeeAddr3();
public function setPayeeAddr3($value);

Procedural Interface

inebank_billpayment_get($res, 22 );
inebank_billpayment_set($res, 22, $value );

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 (InEBank_BillPayment Class)

Wrapper for payee details.

Object Oriented Interface

public function getPayeeAggregate();
public function setPayeeAggregate($value);

Procedural Interface

inebank_billpayment_get($res, 23 );
inebank_billpayment_set($res, 23, $value );

Default Value

''

Remarks

Wrapper for payee details.

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

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

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

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

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

Data Type

String

PayeeCity Property (InEBank_BillPayment Class)

Payee's city.

Object Oriented Interface

public function getPayeeCity();
public function setPayeeCity($value);

Procedural Interface

inebank_billpayment_get($res, 24 );
inebank_billpayment_set($res, 24, $value );

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 (InEBank_BillPayment Class)

Payee's country.

Object Oriented Interface

public function getPayeeCountry();
public function setPayeeCountry($value);

Procedural Interface

inebank_billpayment_get($res, 25 );
inebank_billpayment_set($res, 25, $value );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPayeeDaysToPay();

Procedural Interface

inebank_billpayment_get($res, 26 );

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 (InEBank_BillPayment Class)

Server-assigned payee identifier.

Object Oriented Interface

public function getPayeeId();
public function setPayeeId($value);

Procedural Interface

inebank_billpayment_get($res, 27 );
inebank_billpayment_set($res, 27, $value );

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 (InEBank_BillPayment Class)

Scope of the payee Id .

Object Oriented Interface

public function getPayeeIdScope();

Procedural Interface

inebank_billpayment_get($res, 28 );

Default Value

''

Remarks

Scope of the payee PayeeId.

Possible values are:

This property is read-only.

Data Type

String

PayeeListId Property (InEBank_BillPayment Class)

Server-assigned payee list record ID for this payee.

Object Oriented Interface

public function getPayeeListId();
public function setPayeeListId($value);

Procedural Interface

inebank_billpayment_get($res, 29 );
inebank_billpayment_set($res, 29, $value );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPayeeName();
public function setPayeeName($value);

Procedural Interface

inebank_billpayment_get($res, 30 );
inebank_billpayment_set($res, 30, $value );

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 (InEBank_BillPayment Class)

Payee's phone.

Object Oriented Interface

public function getPayeePhone();
public function setPayeePhone($value);

Procedural Interface

inebank_billpayment_get($res, 31 );
inebank_billpayment_set($res, 31, $value );

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 (InEBank_BillPayment Class)

Payee's postal code.

Object Oriented Interface

public function getPayeePostalCode();
public function setPayeePostalCode($value);

Procedural Interface

inebank_billpayment_get($res, 32 );
inebank_billpayment_set($res, 32, $value );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPayeeState();
public function setPayeeState($value);

Procedural Interface

inebank_billpayment_get($res, 33 );
inebank_billpayment_set($res, 33, $value );

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 (InEBank_BillPayment Class)

Wrapper for a payment details.

Object Oriented Interface

public function getPaymentAggregate();

Procedural Interface

inebank_billpayment_get($res, 35 );

Default Value

''

Remarks

Wrapper for a payment details.

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

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

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

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

Data Type

String

PaymentAmount Property (InEBank_BillPayment Class)

Payment amount.

Object Oriented Interface

public function getPaymentAmount();
public function setPaymentAmount($value);

Procedural Interface

inebank_billpayment_get($res, 36 );
inebank_billpayment_set($res, 36, $value );

Default Value

''

Remarks

Payment amount. This is to be provided when sending a bill payment request.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

This property is not available at design time.

Data Type

String

PaymentBillRef Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentBillRef();
public function setPaymentBillRef($value);

Procedural Interface

inebank_billpayment_get($res, 37 );
inebank_billpayment_set($res, 37, $value );

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 (InEBank_BillPayment Class)

Check number assigned by the server to this payment.

Object Oriented Interface

public function getPaymentCheckNumber();

Procedural Interface

inebank_billpayment_get($res, 38 );

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 (InEBank_BillPayment Class)

Default currency code for this transaction.

Object Oriented Interface

public function getPaymentCurrencyCode();

Procedural Interface

inebank_billpayment_get($res, 39 );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentDateDue();
public function setPaymentDateDue($value);

Procedural Interface

inebank_billpayment_get($res, 40 );
inebank_billpayment_set($res, 40, $value );

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 (InEBank_BillPayment Class)

Payment processing date.

Object Oriented Interface

public function getPaymentDateProcessed();

Procedural Interface

inebank_billpayment_get($res, 41 );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentFromAccountId();
public function setPaymentFromAccountId($value);

Procedural Interface

inebank_billpayment_get($res, 42 );
inebank_billpayment_set($res, 42, $value );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentFromAccountType();
public function setPaymentFromAccountType($value);

Procedural Interface

inebank_billpayment_get($res, 43 );
inebank_billpayment_set($res, 43, $value );

Default Value

0

Remarks

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

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

This property uses the following four values:

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

This property is not available at design time.

Data Type

Integer

PaymentFromBankId Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentFromBankId();
public function setPaymentFromBankId($value);

Procedural Interface

inebank_billpayment_get($res, 44 );
inebank_billpayment_set($res, 44, $value );

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 (InEBank_BillPayment Class)

Transaction Id assigned by the server to the payment.

Object Oriented Interface

public function getPaymentId();
public function setPaymentId($value);

Procedural Interface

inebank_billpayment_get($res, 45 );
inebank_billpayment_set($res, 45, $value );

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 (InEBank_BillPayment Class)

Memo attached to this payment from the customer to payee.

Object Oriented Interface

public function getPaymentMemo();
public function setPaymentMemo($value);

Procedural Interface

inebank_billpayment_get($res, 46 );
inebank_billpayment_set($res, 46, $value );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentPayeeAccount();

Procedural Interface

inebank_billpayment_get($res, 47 );

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 (InEBank_BillPayment Class)

Wrapper for the payee details this payment was sent to.

Object Oriented Interface

public function getPaymentPayeeAggregate();

Procedural Interface

inebank_billpayment_get($res, 48 );

Default Value

''

Remarks

Wrapper for the payee details this payment was sent to.

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

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

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

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

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

Data Type

String

PaymentPayeeId Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentPayeeId();

Procedural Interface

inebank_billpayment_get($res, 49 );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentPayeeListId();

Procedural Interface

inebank_billpayment_get($res, 50 );

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 (InEBank_BillPayment Class)

Payment processing status.

Object Oriented Interface

public function getPaymentStatus();

Procedural Interface

inebank_billpayment_get($res, 51 );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentToAccountId();
public function setPaymentToAccountId($value);

Procedural Interface

inebank_billpayment_get($res, 52 );
inebank_billpayment_set($res, 52, $value );

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentToAccountType();
public function setPaymentToAccountType($value);

Procedural Interface

inebank_billpayment_get($res, 53 );
inebank_billpayment_set($res, 53, $value );

Default Value

0

Remarks

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

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

This property uses the following four values:

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

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

This property is not available at design time.

Data Type

Integer

PaymentToBankId Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getPaymentToBankId();
public function setPaymentToBankId($value);

Procedural Interface

inebank_billpayment_get($res, 54 );
inebank_billpayment_set($res, 54, $value );

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 (InEBank_BillPayment Class)

Transaction type performed on the payment being synchronized.

Object Oriented Interface

public function getPaymentTxType();

Procedural Interface

inebank_billpayment_get($res, 55 );

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

SSLAcceptServerCertEffectiveDate Property (InEBank_BillPayment Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

inebank_billpayment_get($res, 56 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (InEBank_BillPayment Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

inebank_billpayment_get($res, 57 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (InEBank_BillPayment Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

inebank_billpayment_get($res, 58 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (InEBank_BillPayment Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

inebank_billpayment_get($res, 59 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (InEBank_BillPayment Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

inebank_billpayment_get($res, 60 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (InEBank_BillPayment Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

inebank_billpayment_get($res, 61 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (InEBank_BillPayment Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

inebank_billpayment_get($res, 62 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (InEBank_BillPayment Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

inebank_billpayment_get($res, 63 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (InEBank_BillPayment Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

inebank_billpayment_get($res, 64 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (InEBank_BillPayment Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

inebank_billpayment_get($res, 65 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (InEBank_BillPayment Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

inebank_billpayment_get($res, 66 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (InEBank_BillPayment Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

inebank_billpayment_get($res, 67 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (InEBank_BillPayment Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

inebank_billpayment_get($res, 68 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (InEBank_BillPayment Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

inebank_billpayment_get($res, 69 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (InEBank_BillPayment Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

inebank_billpayment_get($res, 70 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (InEBank_BillPayment Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

inebank_billpayment_get($res, 71 );
inebank_billpayment_set($res, 71, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

inebank_billpayment_get($res, 72 );
inebank_billpayment_set($res, 72, $value );

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

SSLAcceptServerCertStoreType Property (InEBank_BillPayment Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

inebank_billpayment_get($res, 73 );
inebank_billpayment_set($res, 73, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (InEBank_BillPayment Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

inebank_billpayment_get($res, 74 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (InEBank_BillPayment Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

inebank_billpayment_get($res, 75 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (InEBank_BillPayment Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

inebank_billpayment_get($res, 76 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (InEBank_BillPayment Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

inebank_billpayment_get($res, 77 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (InEBank_BillPayment Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

inebank_billpayment_get($res, 78 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (InEBank_BillPayment Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

inebank_billpayment_get($res, 79 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (InEBank_BillPayment Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

inebank_billpayment_get($res, 80 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (InEBank_BillPayment Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

inebank_billpayment_get($res, 81 );
inebank_billpayment_set($res, 81, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (InEBank_BillPayment Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inebank_billpayment_get($res, 82 );
inebank_billpayment_set($res, 82, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (InEBank_BillPayment Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

inebank_billpayment_get($res, 83 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (InEBank_BillPayment Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

inebank_billpayment_get($res, 84 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (InEBank_BillPayment Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

inebank_billpayment_get($res, 85 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (InEBank_BillPayment Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

inebank_billpayment_get($res, 86 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (InEBank_BillPayment Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

inebank_billpayment_get($res, 87 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (InEBank_BillPayment Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

inebank_billpayment_get($res, 88 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (InEBank_BillPayment Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

inebank_billpayment_get($res, 89 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (InEBank_BillPayment Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

inebank_billpayment_get($res, 90 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (InEBank_BillPayment Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

inebank_billpayment_get($res, 91 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (InEBank_BillPayment Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

inebank_billpayment_get($res, 92 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (InEBank_BillPayment Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

inebank_billpayment_get($res, 93 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (InEBank_BillPayment Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

inebank_billpayment_get($res, 94 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (InEBank_BillPayment Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

inebank_billpayment_get($res, 95 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (InEBank_BillPayment Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

inebank_billpayment_get($res, 96 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (InEBank_BillPayment Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

inebank_billpayment_get($res, 97 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (InEBank_BillPayment Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

inebank_billpayment_get($res, 98 );
inebank_billpayment_set($res, 98, $value );

Default Value

'MY'

Remarks

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

inebank_billpayment_get($res, 99 );
inebank_billpayment_set($res, 99, $value );

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 (InEBank_BillPayment Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

inebank_billpayment_get($res, 100 );
inebank_billpayment_set($res, 100, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (InEBank_BillPayment Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

inebank_billpayment_get($res, 101 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (InEBank_BillPayment Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

inebank_billpayment_get($res, 102 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (InEBank_BillPayment Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

inebank_billpayment_get($res, 103 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (InEBank_BillPayment Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

inebank_billpayment_get($res, 104 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (InEBank_BillPayment Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

inebank_billpayment_get($res, 105 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (InEBank_BillPayment Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

inebank_billpayment_get($res, 106 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (InEBank_BillPayment Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

inebank_billpayment_get($res, 107 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (InEBank_BillPayment Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

inebank_billpayment_get($res, 108 );
inebank_billpayment_set($res, 108, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

Data Type

String

SSLCertEncoded Property (InEBank_BillPayment Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

inebank_billpayment_get($res, 109 );
inebank_billpayment_set($res, 109, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (InEBank_BillPayment Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

inebank_billpayment_get($res, 110 );
inebank_billpayment_set($res, 110, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (InEBank_BillPayment Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

inebank_billpayment_get($res, 111 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (InEBank_BillPayment Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

inebank_billpayment_get($res, 112 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (InEBank_BillPayment Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

inebank_billpayment_get($res, 113 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (InEBank_BillPayment Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

inebank_billpayment_get($res, 114 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (InEBank_BillPayment Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

inebank_billpayment_get($res, 115 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (InEBank_BillPayment Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

inebank_billpayment_get($res, 116 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (InEBank_BillPayment Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

inebank_billpayment_get($res, 117 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (InEBank_BillPayment Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

inebank_billpayment_get($res, 118 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (InEBank_BillPayment Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

inebank_billpayment_get($res, 119 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (InEBank_BillPayment Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

inebank_billpayment_get($res, 120 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (InEBank_BillPayment Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

inebank_billpayment_get($res, 121 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (InEBank_BillPayment Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

inebank_billpayment_get($res, 122 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (InEBank_BillPayment Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

inebank_billpayment_get($res, 123 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (InEBank_BillPayment Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

inebank_billpayment_get($res, 124 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (InEBank_BillPayment Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

inebank_billpayment_get($res, 125 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (InEBank_BillPayment Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

inebank_billpayment_get($res, 126 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

inebank_billpayment_get($res, 127 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (InEBank_BillPayment Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

inebank_billpayment_get($res, 128 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (InEBank_BillPayment Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

inebank_billpayment_get($res, 129 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (InEBank_BillPayment Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

inebank_billpayment_get($res, 130 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (InEBank_BillPayment Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

inebank_billpayment_get($res, 131 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (InEBank_BillPayment Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

inebank_billpayment_get($res, 132 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (InEBank_BillPayment Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

inebank_billpayment_get($res, 133 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (InEBank_BillPayment Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

inebank_billpayment_get($res, 134 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (InEBank_BillPayment Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

inebank_billpayment_get($res, 135 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (InEBank_BillPayment Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

inebank_billpayment_get($res, 136 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (InEBank_BillPayment Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inebank_billpayment_get($res, 137 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

SyncPayeeCount Property (InEBank_BillPayment Class)

The number of records in the SyncPayee arrays.

Object Oriented Interface

public function getSyncPayeeCount();

Procedural Interface

inebank_billpayment_get($res, 138 );

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 (InEBank_BillPayment Class)

User's account number with the payee.

Object Oriented Interface

public function getSyncPayeeAccount($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 139 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Payee's address line 1.

Object Oriented Interface

public function getSyncPayeeAddr1($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 140 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Payee's address line 2.

Object Oriented Interface

public function getSyncPayeeAddr2($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 141 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Payee's address line 3.

Object Oriented Interface

public function getSyncPayeeAddr3($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 142 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Wrapper for payee details.

Object Oriented Interface

public function getSyncPayeeAggregate($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 143 , $syncpayeeindex);

Default Value

''

Remarks

Wrapper for payee details.

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

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

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

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

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

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

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

Data Type

String

SyncPayeeCity Property (InEBank_BillPayment Class)

Payee's city.

Object Oriented Interface

public function getSyncPayeeCity($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 144 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Payee's country.

Object Oriented Interface

public function getSyncPayeeCountry($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 145 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPayeeDaysToPay($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 146 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Server-assigned payee identifier.

Object Oriented Interface

public function getSyncPayeeId($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 147 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Scope of the payee Id .

Object Oriented Interface

public function getSyncPayeeIdScope($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 148 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Server-assigned payee list record ID for this payee.

Object Oriented Interface

public function getSyncPayeeListId($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 149 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPayeeName($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 150 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Payee's phone.

Object Oriented Interface

public function getSyncPayeePhone($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 151 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Payee's postal code.

Object Oriented Interface

public function getSyncPayeePostalCode($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 152 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPayeeState($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 153 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

Transaction type performed on the payee being synchronized.

Object Oriented Interface

public function getSyncPayeeTxType($syncpayeeindex);

Procedural Interface

inebank_billpayment_get($res, 154 , $syncpayeeindex);

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 (InEBank_BillPayment Class)

The number of records in the SyncPayment arrays.

Object Oriented Interface

public function getSyncPaymentCount();

Procedural Interface

inebank_billpayment_get($res, 155 );

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 (InEBank_BillPayment Class)

Wrapper for a payment details.

Object Oriented Interface

public function getSyncPaymentAggregate($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 156 , $syncpaymentindex);

Default Value

''

Remarks

Wrapper for a payment details.

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

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

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

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

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

Data Type

String

SyncPaymentAmount Property (InEBank_BillPayment Class)

Payment amount.

Object Oriented Interface

public function getSyncPaymentAmount($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 157 , $syncpaymentindex);

Default Value

''

Remarks

Payment amount. This is to be provided when sending a bill payment request.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

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

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

Data Type

String

SyncPaymentBillRef Property (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPaymentBillRef($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 158 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Check number assigned by the server to this payment.

Object Oriented Interface

public function getSyncPaymentCheckNumber($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 159 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Default currency code for this transaction.

Object Oriented Interface

public function getSyncPaymentCurrencyCode($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 160 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPaymentDateDue($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 161 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Payment processing date.

Object Oriented Interface

public function getSyncPaymentDateProcessed($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 162 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Transaction Id assigned by the server to the payment.

Object Oriented Interface

public function getSyncPaymentId($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 166 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Memo attached to this payment from the customer to payee.

Object Oriented Interface

public function getSyncPaymentMemo($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 167 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPaymentPayeeAccount($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 168 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Wrapper for the payee details this payment was sent to.

Object Oriented Interface

public function getSyncPaymentPayeeAggregate($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 169 , $syncpaymentindex);

Default Value

''

Remarks

Wrapper for the payee details this payment was sent to.

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

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

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

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

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPaymentPayeeId($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 170 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function getSyncPaymentPayeeListId($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 171 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Payment processing status.

Object Oriented Interface

public function getSyncPaymentStatus($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 172 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

Transaction type performed on the payment being synchronized.

Object Oriented Interface

public function getSyncPaymentTxType($syncpaymentindex);

Procedural Interface

inebank_billpayment_get($res, 176 , $syncpaymentindex);

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 (InEBank_BillPayment Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

inebank_billpayment_get($res, 177 );
inebank_billpayment_set($res, 177, $value );

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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 (InEBank_BillPayment Class)

Add a payee to server's payee list.

Object Oriented Interface

public function doAddPayee();

Procedural Interface

inebank_billpayment_do_addpayee($res);

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 (InEBank_BillPayment Class)

Cancels a scheduled bill payment.

Object Oriented Interface

public function doCancelPayment($paymentid);

Procedural Interface

inebank_billpayment_do_cancelpayment($res, $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 (InEBank_BillPayment Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inebank_billpayment_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function doDeletePayee($listid);

Procedural Interface

inebank_billpayment_do_deletepayee($res, $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 (InEBank_BillPayment Class)

Obtains the current processing status of a payment.

Object Oriented Interface

public function doGetStatus($paymentid);

Procedural Interface

inebank_billpayment_do_getstatus($res, $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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function doModifyPayee($payeelistid);

Procedural Interface

inebank_billpayment_do_modifypayee($res, $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 (InEBank_BillPayment Class)

Modifies a scheduled payment.

Object Oriented Interface

public function doModifyPayment($paymentid);

Procedural Interface

inebank_billpayment_do_modifypayment($res, $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 (InEBank_BillPayment Class)

Pays a bill to a given payee.

Object Oriented Interface

public function doPayBill();

Procedural Interface

inebank_billpayment_do_paybill($res);

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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

inebank_billpayment_do_reset($res);

Remarks

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

SynchronizePayees Method (InEBank_BillPayment Class)

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

Object Oriented Interface

public function doSynchronizePayees($token);

Procedural Interface

inebank_billpayment_do_synchronizepayees($res, $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 (InEBank_BillPayment Class)

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

Object Oriented Interface

public function doSynchronizePayments($token);

Procedural Interface

inebank_billpayment_do_synchronizepayments($res, $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 (InEBank_BillPayment Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

inebank_billpayment_register_callback($res, 1, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

This 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:

Error Event (InEBank_BillPayment Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inebank_billpayment_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter 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 (InEBank_BillPayment Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inebank_billpayment_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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 (InEBank_BillPayment Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inebank_billpayment_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

SyncPayees Event (InEBank_BillPayment Class)

Fired for each payee included in the synchronization response.

Object Oriented Interface

public function fireSyncPayees($param);

Procedural Interface

inebank_billpayment_register_callback($res, 5, array($this, 'fireSyncPayees'));

Parameter List

 'payeeaggregate'
 'payeetxtype'
 'payeeid'
 'payeeidscope'
 'payeelistid'
 'payeeaccount'
 'payeename'
 'payeeaddr1'
 'payeeaddr2'
 'payeeaddr3'
 'payeecity'
 'payeestate'
 'payeepostalcode'
 'payeecountry'
 'payeephone'

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 (InEBank_BillPayment Class)

Fired for each payment transaction included in the synchronization response.

Object Oriented Interface

public function fireSyncPayments($param);

Procedural Interface

inebank_billpayment_register_callback($res, 6, array($this, 'fireSyncPayments'));

Parameter List

 'paymentaggregate'
 'paymenttxtype'
 'paymentid'
 'payeeid'
 'payeelistid'
 'payeeaccount'
 'payeeaggregate'
 'paymentamount'
 'fromaccountid'
 'paymentstatus'
 'paymentdate'

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

OFX Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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