BankTransfer Class

Properties   Methods   Events   Config Settings   Errors  

The BankTransfer class is a single class that supports the SignOn and Intrabank/Interbank Funds Transfer functions of Open Financial Exchange, as described by Specification 1.0.2.

Class Name

InEBank_BankTransfer

Procedural Interface

 inebank_banktransfer_open();
 inebank_banktransfer_close($res);
 inebank_banktransfer_register_callback($res, $id, $function);
 inebank_banktransfer_get_last_error($res);
 inebank_banktransfer_get_last_error_code($res);
 inebank_banktransfer_set($res, $id, $index, $value);
 inebank_banktransfer_get($res, $id, $index);
 inebank_banktransfer_do_canceltransfer($res, $transferid);
 inebank_banktransfer_do_config($res, $configurationstring);
 inebank_banktransfer_do_modifytransfer($res, $transferid);
 inebank_banktransfer_do_reset($res);
 inebank_banktransfer_do_synchronizetransfers($res, $token);
 inebank_banktransfer_do_transferfunds($res);

Remarks

The BankTransfer class supports immediate or scheduled intrabank (between two accounts at the same financial institution) and interbank (between two accounts at different financial institutions).

The fund transfer request designates source and destination accounts and the amount of the transfer. The FI must be able to authenticate the source account. The user can schedule the transfers for a future date or request an immediate transfer. The user can modify or cancel scheduled transfers, but not immediate transfers.

Interbank funds transfers differ from intrabank funds transfers in the following respects:

• the routing and transit number of the destination account differs from the source account;
• at the discretion of the FI, the destination account can be subject to pre-notification;
• source and destination accounts must be enabled for the Automated Clearing House (ACH);

To make transfer, the TransferFunds method should be called and the following information should be provided in the request.

First, identify the:

• OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties;
• financial institution by setting the FIId, FIOrganization, and FIUrl, properties.

• source account you wish to transfer the funds from, by setting TransferFromBankId, TransferFromAccountId, TransferFromAccountType, and for international banks also TransferFromBranchId and TransferFromAccountKey properties;
• destination account where the funds will be deposited to, by setting TransferToBankId (if requesting interbank transfer), TransferToAccountId, TransferToAccountType, and for international banks also TransferToBranchId and TransferToAccountKey;
• transfer amount by setting TransferAmount to the desired value;
• transfer date by setting TransferDateDue (if requesting a scheduled transfer, not an immediate one);

When the response returns, the server cannot provide complete confirmation for the transfer. The server can confirm only that it received the transfer instruction, and possibly, whether it validated the accounts, amount, and date specified in the transfer. When the transfer status is not provided in the server response, then the server should confirm that it accepted the instructions by issuing a TransferId. In this case, it should also indicate the expected posting date of the transfer stored in TransferDatePosted.

The transfer confirmation can be retrieved at a later time through a synchronization request (by calling SynchronizeTransfers method).

If the request is for an immediate transfer and the server can perform the transfer in real time, the server should indicate whether the transfer succeeded and should return the date of the transfer in TransferDatePosted. In this case, synchronization is not required.

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

Financial institution identifier.

Object Oriented Interface

public function getFIId();


public function setFIId($value);

Procedural Interface

inebank_banktransfer_get($res, 1 );


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

Financial institution organization name.

Object Oriented Interface

public function getFIOrganization();


public function setFIOrganization($value);

Procedural Interface

inebank_banktransfer_get($res, 2 );


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

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

inebank_banktransfer_get($res, 3 );


inebank_banktransfer_set($res, 3, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (InEBank_BankTransfer Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

inebank_banktransfer_get($res, 4 );


inebank_banktransfer_set($res, 4, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

inebank_banktransfer_get($res, 5 );


inebank_banktransfer_set($res, 5, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (InEBank_BankTransfer Class)

This property contains 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_banktransfer_get($res, 6 );


inebank_banktransfer_set($res, 6, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

inebank_banktransfer_get($res, 7 );


inebank_banktransfer_set($res, 7, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

inebank_banktransfer_get($res, 8 );


inebank_banktransfer_set($res, 8, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIUrl Property (InEBank_BankTransfer Class)

Financial institution URL.

Object Oriented Interface

public function getFIUrl();


public function setFIUrl($value);

Procedural Interface

inebank_banktransfer_get($res, 9 );


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

Whether the token in the synchronization request is older.

Object Oriented Interface

public function getLostSync();

Procedural Interface

inebank_banktransfer_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_BankTransfer 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_banktransfer_get($res, 11 );


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

OFX application identifier.

Object Oriented Interface

public function getOFXAppId();


public function setOFXAppId($value);

Procedural Interface

inebank_banktransfer_get($res, 12 );


inebank_banktransfer_set($res, 12, $value );

Default Value

''

Remarks

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

Data Type

String

OFXAppVersion Property (InEBank_BankTransfer Class)

OFX application version.

Object Oriented Interface

public function getOFXAppVersion();


public function setOFXAppVersion($value);

Procedural Interface

inebank_banktransfer_get($res, 13 );


inebank_banktransfer_set($res, 13, $value );

Default Value

''

Remarks

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

Data Type

String

OFXPassword Property (InEBank_BankTransfer Class)

User's password.

Object Oriented Interface

public function getOFXPassword();


public function setOFXPassword($value);

Procedural Interface

inebank_banktransfer_get($res, 14 );


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

The current OFX request aggregate.

Object Oriented Interface

public function getOFXRequest();

Procedural Interface

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

The current OFX response aggregate.

Object Oriented Interface

public function getOFXResponse();


public function setOFXResponse($value);

Procedural Interface

inebank_banktransfer_get($res, 16 );


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

User's id.

Object Oriented Interface

public function getOFXUser();


public function setOFXUser($value);

Procedural Interface

inebank_banktransfer_get($res, 17 );


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

OFX API version.

Object Oriented Interface

public function getOFXVersion();


public function setOFXVersion($value);

Procedural Interface

inebank_banktransfer_get($res, 18 );


inebank_banktransfer_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

SSLAcceptServerCertEncoded Property (InEBank_BankTransfer Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inebank_banktransfer_get($res, 20 );


inebank_banktransfer_set($res, 20, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (InEBank_BankTransfer Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

inebank_banktransfer_get($res, 48 );


inebank_banktransfer_set($res, 48, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

inebank_banktransfer_get($res, 64 );


inebank_banktransfer_set($res, 64, $value );

Default Value

'MY'

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform-dependent.

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

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InEBank_BankTransfer 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_banktransfer_get($res, 65 );


inebank_banktransfer_set($res, 65, $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_BankTransfer Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

inebank_banktransfer_get($res, 66 );


inebank_banktransfer_set($res, 66, $value );

Default Value

0

Remarks

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

SSLCertSubject Property (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

inebank_banktransfer_get($res, 67 );


inebank_banktransfer_set($res, 67, $value );

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

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

Data Type

String

SSLProvider Property (InEBank_BankTransfer Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

inebank_banktransfer_get($res, 75 );


inebank_banktransfer_set($res, 75, $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:

Additional Notes

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

SSLServerCertEncoded Property (InEBank_BankTransfer Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inebank_banktransfer_get($res, 77 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

SyncTransferCount Property (InEBank_BankTransfer Class)

The number of records in the SyncTransfer arrays.

Object Oriented Interface

public function getSyncTransferCount();

Procedural Interface

inebank_banktransfer_get($res, 104 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SyncTransferAggregate
• SyncTransferAmount
• SyncTransferDateDue
• SyncTransferDatePosted
• SyncTransferDateProcessed
• SyncTransferDateProjected
• SyncTransferFromAccountId
• SyncTransferId
• SyncTransferStatus
• SyncTransferToAccountId
• SyncTransferTxType

The array indices start at 0 and end at SyncTransferCount - 1.

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

Data Type

Integer

SyncTransferAggregate Property (InEBank_BankTransfer Class)

Wrapper for a bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getSyncTransferAggregate($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 105 , $synctransferindex);

Default Value

''

Remarks

Wrapper for a bank transfer being initiated, modified or synchronized.

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 $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferAmount Property (InEBank_BankTransfer Class)

Amount of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getSyncTransferAmount($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 106 , $synctransferindex);

Default Value

''

Remarks

Amount of the bank transfer being initiated, modified or synchronized.

This is required to be provided when initiating or modifying a transfer (i.e., when either TransferFunds or ModifyTransfer methods are called),

It is returned in the server response for each payment being synchronized (when the SynchronizeTransfers method is called).

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 $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDateDue Property (InEBank_BankTransfer Class)

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

Object Oriented Interface

public function getSyncTransferDateDue($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 108 , $synctransferindex);

Default Value

''

Remarks

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

This can be provided when sending a bank transfer request (initiating or modifying a transfer when either TransferFunds or ModifyTransfer methods are called. In these cases, if the SyncTransferDateDue is not specified in the request, the transfer is considered immediate by the server and it occurs as soon as possible. However, this is required for scheduled transfers.

This is also returned in the server response when these methods are called. However, the value may have been adjusted by the server. For example, the server may adjust due date to comply with non-processing days. If a client sends a request to make a transfer on July 4 and July 4 happens to be a non-processing day, the due date in the response may be July 4 (because the server hasn't adjusted it yet), July 5 (because this server rolls dates forward), or some other date. For this reason, the SyncTransferDateDue should be inspected as well.

It may also be returned for each payment being synchronized (when the SynchronizeTransfers methods is called) only if it was specified in the original bank transfer request. These values should be inspected as well as might be different from their original values (for the same reason mentioned above).

Note: Immediate intrabank funds transfers cannot be canceled as they are already committed.

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 $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDatePosted Property (InEBank_BankTransfer Class)

Posted date of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getSyncTransferDatePosted($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 109 , $synctransferindex);

Default Value

''

Remarks

Posted date of the bank transfer being initiated, modified or synchronized.

This is the date the transfer actually happens (or happened). This is optional. Server response can contain either a SyncTransferDateProjected or a SyncTransferDatePosted but not both.

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 $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDateProcessed Property (InEBank_BankTransfer Class)

Transfer processing date.

Object Oriented Interface

public function getSyncTransferDateProcessed($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 110 , $synctransferindex);

Default Value

''

Remarks

Transfer processing date.

The interpretation of this value depends on SyncTransferStatus. This is date on which processing status last changed.

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 $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDateProjected Property (InEBank_BankTransfer Class)

Projected date of the transfer.

Object Oriented Interface

public function getSyncTransferDateProjected($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 111 , $synctransferindex);

Default Value

''

Remarks

Projected date of the transfer.

This string gives the date the transfer is expected to take place. This is optional to be returned in the server response. Server response can contain either SyncTransferDateProjected or SyncTransferDatePosted, but not both.

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 $synctransferindex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferFromAccountId Property (InEBank_BankTransfer Class)

Account number where the transfer (being initiated, modified or synchronized) is originating from.

Object Oriented Interface

public function getSyncTransferFromAccountId($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 112 , $synctransferindex);

Default Value

''

Remarks

Account number where the transfer (being initiated, modified or synchronized) is originating from.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

It is returned in the server response for each transfer being synchronized (when the SynchronizeTransfers method is called).

If SyncTransferFromAccountType is set to CreditCard, the SyncTransferFromAccountId is a credit card account number.

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

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

Data Type

String

SyncTransferId Property (InEBank_BankTransfer Class)

Server-assigned id of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getSyncTransferId($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 117 , $synctransferindex);

Default Value

''

Remarks

Server-assigned id of the bank transfer being initiated, modified or synchronized.

The SyncTransferId uniquely identifies a transfer. This is assigned by the server when the transfer is initiated (when the TransferFunds method is called.

As a unique transfer identifier, the SyncTransferId is required to be provided (as parameter) when a transfer modification or cancellation requests are submitted (i.e., when ModifyTransfer or CancelTransfer methods are called) for a scheduled transfer.

This is also required to be provided when submitting the same request types via the OFXBatch class (for each transfer that is going to be part of the batch).

It is also returned for each payment being synchronized when the SynchronizeTransfers method is called.

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

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

Data Type

String

SyncTransferStatus Property (InEBank_BankTransfer Class)

Processing status code of the bank transfer being initiated, modified, canceled or synchronized.

Object Oriented Interface

public function getSyncTransferStatus($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 118 , $synctransferindex);

Default Value

''

Remarks

Processing status code of the bank transfer being initiated, modified, canceled or synchronized.

This is returned in the server response when the TransferFunds, ModifyTransfer, CancelTransfer and SynchronizeTransfers methods are called.

If the server provides this information, the possible values are:

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

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

Data Type

String

SyncTransferToAccountId Property (InEBank_BankTransfer Class)

Account number where the bank transfer ((being initiated, modified or synchronized) is made to.

Object Oriented Interface

public function getSyncTransferToAccountId($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 119 , $synctransferindex);

Default Value

''

Remarks

Account number where the bank transfer ((being initiated, modified or synchronized) is made to.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

It is returned in the server response for each transfer being synchronized (when the SynchronizeTransfers method is called).

If SyncTransferToAccountType is set to CreditCard, the SyncTransferToAccountId is a credit card account number.

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

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

Data Type

String

SyncTransferTxType Property (InEBank_BankTransfer Class)

Transaction type of the bank transfer being synchronized.

Object Oriented Interface

public function getSyncTransferTxType($synctransferindex);

Procedural Interface

inebank_banktransfer_get($res, 124 , $synctransferindex);

Default Value

''

Remarks

Transaction type of the bank transfer being synchronized.

Possible values and their meanings are as follows:

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

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

Data Type

String

Timeout Property (InEBank_BankTransfer Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

inebank_banktransfer_get($res, 125 );


inebank_banktransfer_set($res, 125, $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.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferAmount Property (InEBank_BankTransfer Class)

Amount of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getTransferAmount();


public function setTransferAmount($value);

Procedural Interface

inebank_banktransfer_get($res, 127 );


inebank_banktransfer_set($res, 127, $value );

Default Value

''

Remarks

Amount of the bank transfer being initiated, modified or synchronized.

This is required to be provided when initiating or modifying a transfer (i.e., when either TransferFunds or ModifyTransfer methods are called),

It is returned in the server response for each payment being synchronized (when the SynchronizeTransfers method is called).

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

TransferCurrencyCode Property (InEBank_BankTransfer Class)

Default currency code for this transaction.

Object Oriented Interface

public function getTransferCurrencyCode();

Procedural Interface

inebank_banktransfer_get($res, 128 );

Default Value

''

Remarks

Default currency code for this transaction.

Indicates how to interpret the monetary transferred amount. Expressed as a special character, such as $.

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

Data Type

String

TransferDateDue Property (InEBank_BankTransfer Class)

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

Object Oriented Interface

public function getTransferDateDue();


public function setTransferDateDue($value);

Procedural Interface

inebank_banktransfer_get($res, 129 );


inebank_banktransfer_set($res, 129, $value );

Default Value

''

Remarks

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

This can be provided when sending a bank transfer request (initiating or modifying a transfer when either TransferFunds or ModifyTransfer methods are called. In these cases, if the TransferDateDue is not specified in the request, the transfer is considered immediate by the server and it occurs as soon as possible. However, this is required for scheduled transfers.

This is also returned in the server response when these methods are called. However, the value may have been adjusted by the server. For example, the server may adjust due date to comply with non-processing days. If a client sends a request to make a transfer on July 4 and July 4 happens to be a non-processing day, the due date in the response may be July 4 (because the server hasn't adjusted it yet), July 5 (because this server rolls dates forward), or some other date. For this reason, the TransferDateDue should be inspected as well.

It may also be returned for each payment being synchronized (when the SynchronizeTransfers methods is called) only if it was specified in the original bank transfer request. These values should be inspected as well as might be different from their original values (for the same reason mentioned above).

Note: Immediate intrabank funds transfers cannot be canceled as they are already committed.

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

TransferDatePosted Property (InEBank_BankTransfer Class)

Posted date of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getTransferDatePosted();

Procedural Interface

inebank_banktransfer_get($res, 130 );

Default Value

''

Remarks

Posted date of the bank transfer being initiated, modified or synchronized.

This is the date the transfer actually happens (or happened). This is optional. Server response can contain either a TransferDateProjected or a TransferDatePosted but not both.

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

TransferDateProcessed Property (InEBank_BankTransfer Class)

Transfer processing date.

Object Oriented Interface

public function getTransferDateProcessed();

Procedural Interface

inebank_banktransfer_get($res, 131 );

Default Value

''

Remarks

Transfer processing date.

The interpretation of this value depends on TransferStatus. This is date on which processing status last changed.

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

TransferFromAccountId Property (InEBank_BankTransfer Class)

Account number where the transfer (being initiated, modified or synchronized) is originating from.

Object Oriented Interface

public function getTransferFromAccountId();


public function setTransferFromAccountId($value);

Procedural Interface

inebank_banktransfer_get($res, 133 );


inebank_banktransfer_set($res, 133, $value );

Default Value

''

Remarks

Account number where the transfer (being initiated, modified or synchronized) is originating from.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

It is returned in the server response for each transfer being synchronized (when the SynchronizeTransfers method is called).

If TransferFromAccountType is set to CreditCard, the TransferFromAccountId is a credit card account number.

This property is not available at design time.

Data Type

String

TransferFromAccountKey Property (InEBank_BankTransfer Class)

Checksum for the bank where money has to be withdrawn (international banks only).

Object Oriented Interface

public function getTransferFromAccountKey();


public function setTransferFromAccountKey($value);

Procedural Interface

inebank_banktransfer_get($res, 134 );


inebank_banktransfer_set($res, 134, $value );

Default Value

''

Remarks

Checksum for the bank where money has to be withdrawn (international banks only).

This is optional to be provided when initiating or modifying a bank transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The TransferFromAccountKey is applicable for international banks only.

This property is not available at design time.

Data Type

String

TransferFromAccountType Property (InEBank_BankTransfer Class)

Type of account where the transfer is originating from.

Object Oriented Interface

public function getTransferFromAccountType();


public function setTransferFromAccountType($value);

Procedural Interface

inebank_banktransfer_get($res, 135 );


inebank_banktransfer_set($res, 135, $value );

Default Value

0

Remarks

Type of account where the transfer is originating from.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called). If TransferFromAccountType and TransferToAccountType are set to CreditCard, then the TransferFromBankId and TransferToBankId are not required to be provided in the request.

This property uses the following values:

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

This property is not available at design time.

Data Type

Integer

TransferFromBankId Property (InEBank_BankTransfer Class)

Number that identifies the bank where the transfer is originating from.

Object Oriented Interface

public function getTransferFromBankId();


public function setTransferFromBankId($value);

Procedural Interface

inebank_banktransfer_get($res, 136 );


inebank_banktransfer_set($res, 136, $value );

Default Value

''

Remarks

Number that identifies the bank where the transfer is originating from.

When initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called), and TransferFromAccountType is set to a value different than CreditCard, the TransferFromBankId is required to be provided in the request. Otherwise, it should not be set.

In intrabank transfers requests (transferring funds between two accounts at the same financial institution), the TransferFromBankId represents the source and destination FI (in this case, this is the same as TransferToBankId and TransferToBankId should not be set).

This property is not available at design time.

Data Type

String

TransferFromBranchId Property (InEBank_BankTransfer Class)

Identifier for the bank where the transfer is originating from (international banks only).

Object Oriented Interface

public function getTransferFromBranchId();


public function setTransferFromBranchId($value);

Procedural Interface

inebank_banktransfer_get($res, 137 );


inebank_banktransfer_set($res, 137, $value );

Default Value

''

Remarks

Identifier for the bank where the transfer is originating from (international banks only).

This is optional to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The TransferFromBranchId is applicable for international banks only, and if this applies, it can be provided in the request only if TransferFromAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String

TransferId Property (InEBank_BankTransfer Class)

Server-assigned id of the bank transfer being initiated, modified or synchronized.

Object Oriented Interface

public function getTransferId();


public function setTransferId($value);

Procedural Interface

inebank_banktransfer_get($res, 138 );


inebank_banktransfer_set($res, 138, $value );

Default Value

''

Remarks

Server-assigned id of the bank transfer being initiated, modified or synchronized.

The TransferId uniquely identifies a transfer. This is assigned by the server when the transfer is initiated (when the TransferFunds method is called.

As a unique transfer identifier, the TransferId is required to be provided (as parameter) when a transfer modification or cancellation requests are submitted (i.e., when ModifyTransfer or CancelTransfer methods are called) for a scheduled transfer.

This is also required to be provided when submitting the same request types via the OFXBatch class (for each transfer that is going to be part of the batch).

It is also returned for each payment being synchronized when the SynchronizeTransfers method is called.

This property is not available at design time.

Data Type

String

TransferStatus Property (InEBank_BankTransfer Class)

Processing status code of the bank transfer being initiated, modified, canceled or synchronized.

Object Oriented Interface

public function getTransferStatus();

Procedural Interface

inebank_banktransfer_get($res, 139 );

Default Value

''

Remarks

Processing status code of the bank transfer being initiated, modified, canceled or synchronized.

This is returned in the server response when the TransferFunds, ModifyTransfer, CancelTransfer and SynchronizeTransfers methods are called.

If the server provides this information, the possible values are:

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

Data Type

String

TransferToAccountId Property (InEBank_BankTransfer Class)

Account number where the bank transfer ((being initiated, modified or synchronized) is made to.

Object Oriented Interface

public function getTransferToAccountId();


public function setTransferToAccountId($value);

Procedural Interface

inebank_banktransfer_get($res, 140 );


inebank_banktransfer_set($res, 140, $value );

Default Value

''

Remarks

Account number where the bank transfer ((being initiated, modified or synchronized) is made to.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

It is returned in the server response for each transfer being synchronized (when the SynchronizeTransfers method is called).

If TransferToAccountType is set to CreditCard, the TransferToAccountId is a credit card account number.

This property is not available at design time.

Data Type

String

TransferToAccountKey Property (InEBank_BankTransfer Class)

Checksum for the bank where money has to be deposited to (international banks only).

Object Oriented Interface

public function getTransferToAccountKey();


public function setTransferToAccountKey($value);

Procedural Interface

inebank_banktransfer_get($res, 141 );


inebank_banktransfer_set($res, 141, $value );

Default Value

''

Remarks

Checksum for the bank where money has to be deposited to (international banks only).

This is optional to be provided when initiating or modifying a bank transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The TransferToAccountKey is applicable for international banks only.

This property is not available at design time.

Data Type

String

TransferToAccountType Property (InEBank_BankTransfer Class)

Type of account where money has to be deposited to.

Object Oriented Interface

public function getTransferToAccountType();


public function setTransferToAccountType($value);

Procedural Interface

inebank_banktransfer_get($res, 142 );


inebank_banktransfer_set($res, 142, $value );

Default Value

0

Remarks

Type of account where money has to be deposited to.

This is required to be provided when initiating or modifying a bank transfer (i.e., when TransferFunds or ModifyTransfer methods are called). If TransferFromAccountType and TransferToAccountType are set to CreditCard, then the TransferFromBankId and TransferToBankId are not required to be provided in the request.

This property uses the following values:

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

This property is not available at design time.

Data Type

Integer

TransferToBankId Property (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function getTransferToBankId();


public function setTransferToBankId($value);

Procedural Interface

inebank_banktransfer_get($res, 143 );


inebank_banktransfer_set($res, 143, $value );

Default Value

''

Remarks

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

This is the bank id where the destination account is located. When initiating or modifying an interbank transfer (i.e., transferring funds between two accounts at different FIs) and TransferToAccountType is set to a value different than CreditCard, the TransferToBankId is required to be provided in the request. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String

TransferToBranchId Property (InEBank_BankTransfer Class)

Identifier for the bank where money has to be deposited to (international banks only).

Object Oriented Interface

public function getTransferToBranchId();


public function setTransferToBranchId($value);

Procedural Interface

inebank_banktransfer_get($res, 144 );


inebank_banktransfer_set($res, 144, $value );

Default Value

''

Remarks

Identifier for the bank where money has to be deposited to (international banks only).

This is optional to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The TransferToBranchId is applicable for international banks only and if this applies, it can be provided in the request only if TransferToAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String

CancelTransfer Method (InEBank_BankTransfer Class)

Cancels a scheduled transfer.

Object Oriented Interface

public function doCancelTransfer($transferid);

Procedural Interface

inebank_banktransfer_do_canceltransfer($res, $transferid);

Remarks

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

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

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

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

Config Method (InEBank_BankTransfer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

ModifyTransfer Method (InEBank_BankTransfer Class)

Modifies a scheduled transfer.

Object Oriented Interface

public function doModifyTransfer($transferid);

Procedural Interface

inebank_banktransfer_do_modifytransfer($res, $transferid);

Remarks

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

Only scheduled transfers can be modified, not the immediate ones.

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

When modifying a scheduled transfer by calling the ModifyTransfer method, the user should provide all the fields for source and destination account that were specified when the transfer was initiated (when the TransferFunds method was called), and not just the fields that are to be modified).

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

The response normally just echoes the values passed in the request. However, if the status of a scheduled transfer changes in any way, the user should expect to receive modification responses when they synchronize with the server. For example, when a server completes a transfer, the status of the transfer 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 (transfer modification).

Reset Method (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

inebank_banktransfer_do_reset($res);

Remarks

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

SynchronizeTransfers Method (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function doSynchronizeTransfers($token);

Procedural Interface

inebank_banktransfer_do_synchronizetransfers($res, $token);

Remarks

The transfer synchronization request is applicable for bank accounts only and not for the credit card accounts.

This method can be called when a list of recent server responses is needed whether due to requests submitted by multiple clients or other status changes on the server.

Clients can also choose to perform an explicit synchronization before sending any transfer requests (when TransferFunds, ModifyTransfer or CancelTransfer methods are called). This practice allows clients to be up-to-date and possibly interact with the user before sending any new requests.

If this explicit synchronization 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. The response includes responses more recent than the given token, along with a new token returned by this method.

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 transfers for the specified account.

If a client connection fails, or a client receives a response, but crashes before updating its records, the client will not be able to save the new endpoint. On the next synchronization request, the server sends the same information (plus any further status changes). If a user switches to a backup file, again the client will use the older endpoint in the synchronization request. If multiple clients are in use, each will send requests based on its own endpoint, so that both clients will obtain complete information from the server.

A brand new client, or a client that lost synchronization, might want to learn about in-progress transfers by submitting a synchronization refresh of the transfer 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 transfer models, because these often live for months or years.

A client can request a refresh of current state by calling the SynchronizeTransfers where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you schedule a transfer 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.

Please note that the servers will not have infinite history available. If the token in the synchronization request was older than the earliest available history, then the LostSync property value returned is True. This allows clients to alert users that some responses have been lost.

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

Upon a successful reply, if the response contains a list of bank transfers, then the SyncTransfers will be populated and SyncTransfers event will be fired for each transfer transaction. A single transfer has a single TransferId, but it can undergo several state changes over its life and thus might have several entries in the token history.

TransferFunds Method (InEBank_BankTransfer Class)

Transfers money from one account to another within the same or different Financial Institution(s).

Object Oriented Interface

public function doTransferFunds();

Procedural Interface

inebank_banktransfer_do_transferfunds($res);

Remarks

This function generates the Signon and Intrabank or Interbank Transfer request page, submits it to the financial institution via secure HTTP Post, 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:

If the request is for an immediate transfer and the server can perform the transfer in real time, the server should indicate whether the transfer succeeded and should return the date of the transfer in TransferDatePosted. In this case, synchronization is not required.

In all cases, a server cannot provide complete confirmation for the transfer. The server can only confirm that it received the transfer instruction; and possibly whether it validated the accounts, amount, and date specified in the transfer. For any transfer where the client does not know the status at the time of the response, a server should confirm that it accepted the instruction by assigning a TransferId and indicate the TransferDateProjected if the TransferDatePosted is not available. A client can pick up the confirmation at a later date through a synchronization request by calling the SynchronizeTransfers method.

The interbank funds transfers differ from intrabank funds transfers in the following respects:

• The routing and transit number of the destination account differs from the source account. That means that the TransferFromBankId and TransferToBankId should both be set (if the account type is different than CreditCard).
• At the discretion of an FI, the destination account (identified by TransferToAccountId) can be subject to pre-notification.
• Source and destination accounts must be enabled for the Automated Clearing House (ACH).

The Interbank Funds Transfer is subject to the rules and regulations governing the ACH network. In all other respects, interbank funds transfers function like intrabank funds transfers.

ConnectionStatus Event (InEBank_BankTransfer Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

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

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

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

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

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

Error Event (InEBank_BankTransfer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

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

SSLServerAuthentication Event (InEBank_BankTransfer Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

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

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

SSLStatus Event (InEBank_BankTransfer Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

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

SyncTransfers Event (InEBank_BankTransfer Class)

Fired for each intrabank transfer transaction included in the synchronization response.

Object Oriented Interface

public function fireSyncTransfers($param);

Procedural Interface

inebank_banktransfer_register_callback($res, 5, array($this, 'fireSyncTransfers'));

Parameter List

 'transferaggregate'
 'transfertxtype'
 'transferid'
 'transferamount'
 'fromaccountid'
 'toaccountid'
 'transferstatus'
 'transferdateposted'

Remarks

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

• TransferAggregate contains the aggregate for a transfer transaction.
• TransferTx indicates the transfer transaction type, if this is a new, modified or canceled one (possible values: ADD, MOD, CAN).
• TransferId contains the server id of a transaction in the list of transfers (if any) returned in the synchronization response.
• TransferAmount contains the amount of a transfer transaction.
• FromAccountId contains the account number a transfer has been sent from.
• ToAccountId contains the account number a transfer has been sent to.
• TransferStatus contains the status of a transfer transaction.
• TransferDatePosted contains the actual date of a transfer transaction.

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

Config Settings (BankTransfer Class)

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

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

Trappable Errors (BankTransfer Class)

OFX Errors

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

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

XML Errors

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

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).