FDMSOmahaBatchMgr Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSOmahaBatchMgr class is used to close batches and also handles the sending of all offline transactions to the FDMS Host.

Syntax

FDMSOmahaBatchMgr

Remarks

This component allows for a connection to the FDMS Omaha platform via a VPN or PPP (dial-up) connection. This component can be integrated into web pages or stand-alone Point Of Sale applications.

The FDMSOmahaBatchMgr component makes sending offline transactions and closing batches very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance: FDMSOmahaBatchMgr.MerchantNumber = "123456789123456" FDMSOmahaBatchMgr.MerchantTerminalID = "XXX01" FDMSOmahaBatchMgr.DeviceId = "DID1" // Optional, Merchant-Assigned

Next, add all the detail records for the transactions you wish to settle in the batch. Note that all the added detail records must be transactions that are processed within the same batch that you wish to close. Below is an example of how to add a detail record to the OmahaBatchMgr component. FDMSOmahaBatchMgr.DetailRecordCount = 1; FDMSOmahaBatchMgr.DetailRecordAggregate[0] = FDMSOmahaRetail.GetDetailAggregate()

The BatchNumber and TransactionNumber should then be set. Note the BatchNumber should be the same value as all the transactions contained within the DetailRecords. The TransactionNumber specified must be 1 greater than the number of Credit Card transactions specified within DetailRecords and less than the last Debit/EBT Card TransactionNumber specified. See TransactionNumber for more specific information. FDMSOmahaBatchMgr.BatchNumber = 1 FDMSOmahaBatchMgr.TransactionNumber = 2

Finally the batch can be closed by calling CloseBatch. When CloseBatch is called, all the off-line transactions (Voids, Revisions, etc.) will be sent to the Host. After all the off-line transactions have been successfully sent, the batch close request will be sent. If the batch was successfully closed, ResponseSuccess will be 'True'. FDMSOmahaBatchMgr.CloseBatch()

Note it is possible that the Host may be out-of-balance with the Total Amount specified (which is calculated by the component based on the information contained within the DetailRecords). If such a case occurs, the Host may request an inquiry to synchronize all transactions (this request is sent after a batch close message is sent by the component). When the component receives this request, it will handle all inquiries and respond accordingly based on the request and information contained within DetailRecords. Once the host is in sync, the Host will send the close batch response and Response will be populated. ResponseSuccess will be true if the batch was successfully closed.

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.

ApplicationId Property (FDMSOmahaBatchMgr Class)

Identifies the merchant application to the Datawire System.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApplicationId();
int SetApplicationId(const char* lpszApplicationId);

Unicode (Windows)
LPWSTR GetApplicationId();
INT SetApplicationId(LPCWSTR lpszApplicationId);

char* dpaymentssdk_fdmsomahabatchmgr_getapplicationid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setapplicationid(void* lpObj, const char* lpszApplicationId);

QString GetApplicationId();
int SetApplicationId(QString qsApplicationId);

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this class.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

Data Type

String

BatchNumber Property (FDMSOmahaBatchMgr Class)

Number identifying the batch (assigned by the POS device).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Unicode (Windows)
INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);

int dpaymentssdk_fdmsomahabatchmgr_getbatchnumber(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setbatchnumber(void* lpObj, int iBatchNumber);

int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Default Value

0

Remarks

This property is used to specify the number identifying the batch that the transaction will be processed in.

This is a consecutive numbering system assigned by the POS application that identifies a batch of transactions. The batch number must increment each time a batch is successfully closed. When the batch number reaches 9, it is the responsibility of the application to recycle the batch number to 0. The Host will allow a variety of sequencing of the batch number, but you cannot have the same batch number in consecutive batches. For example: The application can close batch 2 and open the next batch with number 5, but you cannot close batch 2 then re-open batch 2 without a different batch number in between. If you should receive a message of "INV BATCH SEQ", this usually indicates the current batch number is the same as the previous batch number closed or there is a batch still open on the Host and the application is trying to process a transaction with a different batch number. If a batch is left open for more than 45 days, (45 days from the open date, not last activity date), the system will automatically purge the batch and it will not be retrievable.

Valid values: 0-9

Data Type

Integer

ClientRef Property (FDMSOmahaBatchMgr Class)

Uniquely identifies the transaction within the Datawire system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientRef();
int SetClientRef(const char* lpszClientRef);

Unicode (Windows)
LPWSTR GetClientRef();
INT SetClientRef(LPCWSTR lpszClientRef);

char* dpaymentssdk_fdmsomahabatchmgr_getclientref(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setclientref(void* lpObj, const char* lpszClientRef);

QString GetClientRef();
int SetClientRef(QString qsClientRef);

Default Value

""

Remarks

The ClientRef (Client Reference Number) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

The maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version and revision number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

The entire TransactionNumber must be unique within a 24 hour time period.

Note: If a value is not specified, the component will generate a value for you. The transaction id will be generated based on the current time (hour of day and minutes) along with the TransactionNumber specified. The version number is hard-coded based on the current library version which is 16.X.X (016XX0).

Data Type

String

DatawireId Property (FDMSOmahaBatchMgr Class)

Identifies the merchant to the Datawire System.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDatawireId();
int SetDatawireId(const char* lpszDatawireId);

Unicode (Windows)
LPWSTR GetDatawireId();
INT SetDatawireId(LPCWSTR lpszDatawireId);

char* dpaymentssdk_fdmsomahabatchmgr_getdatawireid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setdatawireid(void* lpObj, const char* lpszDatawireId);

QString GetDatawireId();
int SetDatawireId(QString qsDatawireId);

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister class). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

Data Type

String

DetailRecordCount Property (FDMSOmahaBatchMgr Class)

The number of records in the DetailRecord arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

Unicode (Windows)
INT GetDetailRecordCount();
INT SetDetailRecordCount(INT iDetailRecordCount);

int dpaymentssdk_fdmsomahabatchmgr_getdetailrecordcount(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setdetailrecordcount(void* lpObj, int iDetailRecordCount);

int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• DetailRecordAggregate

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

This property is not available at design time.

Data Type

Integer

DetailRecordAggregate Property (FDMSOmahaBatchMgr Class)

Set this property with xml aggregates of the transactions you wish to settle.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, const char* lpszDetailRecordAggregate);

Unicode (Windows)
LPWSTR GetDetailRecordAggregate(INT iDetailRecordIndex);
INT SetDetailRecordAggregate(INT iDetailRecordIndex, LPCWSTR lpszDetailRecordAggregate);

char* dpaymentssdk_fdmsomahabatchmgr_getdetailrecordaggregate(void* lpObj, int detailrecordindex);
int dpaymentssdk_fdmsomahabatchmgr_setdetailrecordaggregate(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAggregate);

QString GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, QString qsDetailRecordAggregate);

Default Value

""

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the FDMSOmahaECommerce, FDMSOmahaRetail, FDMSOmahaRestaurant, or FDMSOmahaDetailRecord class's GetDetailAggregate method. For instance:

FDMSOmahaBatchMgr1.DetailRecords.Add(new FDMSOmahaRecordType(FDMSOmahaRetail1.GetDetailAggregate()));

On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the FDMSOmahaDetailRecord class.

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

DeviceId Property (FDMSOmahaBatchMgr Class)

POS Device Identification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDeviceId();
int SetDeviceId(const char* lpszDeviceId);

Unicode (Windows)
LPWSTR GetDeviceId();
INT SetDeviceId(LPCWSTR lpszDeviceId);

char* dpaymentssdk_fdmsomahabatchmgr_getdeviceid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setdeviceid(void* lpObj, const char* lpszDeviceId);

QString GetDeviceId();
int SetDeviceId(QString qsDeviceId);

Default Value

""

Remarks

Merchant-assigned code identifying the device at the merchant's location.

This field is required if there is one MerchantNumber assigned to more than one terminal at a merchant's location.

The maximum length of this property is 4 characters.

Data Type

String

LocalHost Property (FDMSOmahaBatchMgr Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* dpaymentssdk_fdmsomahabatchmgr_getlocalhost(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

String

LocalPort Property (FDMSOmahaBatchMgr Class)

The TCP port in the local host where the class binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int dpaymentssdk_fdmsomahabatchmgr_getlocalport(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

Integer

MerchantNumber Property (FDMSOmahaBatchMgr Class)

A unique number used to identify the merchant within the FDMS systems.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber);

Unicode (Windows)
LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);

char* dpaymentssdk_fdmsomahabatchmgr_getmerchantnumber(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

Default Value

""

Remarks

This 19 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS systems, and is used along with the MerchantTerminalNumber as connection credentials.

Data Type

String

MerchantTerminalID Property (FDMSOmahaBatchMgr Class)

Used to identify a unique terminal within a merchant location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTerminalID();
int SetMerchantTerminalID(const char* lpszMerchantTerminalID);

Unicode (Windows)
LPWSTR GetMerchantTerminalID();
INT SetMerchantTerminalID(LPCWSTR lpszMerchantTerminalID);

char* dpaymentssdk_fdmsomahabatchmgr_getmerchantterminalid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setmerchantterminalid(void* lpObj, const char* lpszMerchantTerminalID);

QString GetMerchantTerminalID();
int SetMerchantTerminalID(QString qsMerchantTerminalID);

Default Value

""

Remarks

This nine digit property contains an ID assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber as connection credentials.

Data Type

String

ProxyAuthScheme Property (FDMSOmahaBatchMgr Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dpaymentssdk_fdmsomahabatchmgr_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FDMSOmahaBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dpaymentssdk_fdmsomahabatchmgr_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (FDMSOmahaBatchMgr Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dpaymentssdk_fdmsomahabatchmgr_getproxypassword(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FDMSOmahaBatchMgr Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dpaymentssdk_fdmsomahabatchmgr_getproxyport(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FDMSOmahaBatchMgr Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dpaymentssdk_fdmsomahabatchmgr_getproxyserver(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FDMSOmahaBatchMgr Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dpaymentssdk_fdmsomahabatchmgr_getproxyssl(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FDMSOmahaBatchMgr Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dpaymentssdk_fdmsomahabatchmgr_getproxyuser(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RemoteHost Property (FDMSOmahaBatchMgr Class)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* dpaymentssdk_fdmsomahabatchmgr_getremotehost(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setremotehost(void* lpObj, const char* lpszRemoteHost);

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

String

RemotePort Property (FDMSOmahaBatchMgr Class)

This property includes the Transmission Control Protocol (TCP) port in the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int dpaymentssdk_fdmsomahabatchmgr_getremoteport(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setremoteport(void* lpObj, int iRemotePort);

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

0

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

Integer

ResponseBatchAmount Property (FDMSOmahaBatchMgr Class)

The total authorized amount for all Credit Card transactions in the batch.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseBatchAmount();

Unicode (Windows)
LPWSTR GetResponseBatchAmount();

char* dpaymentssdk_fdmsomahabatchmgr_getresponsebatchamount(void* lpObj);

QString GetResponseBatchAmount();

Default Value

""

Remarks

The total authorized amount for all Credit Card transactions in the batch.

This value is taken directly from ResponseText. Note in the case of a negative amount, a minus '-' sign will be put at the beginning of the amount.

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

Data Type

String

ResponseBatchID Property (FDMSOmahaBatchMgr Class)

Code identifying batch to the Host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseBatchID();

Unicode (Windows)
LPWSTR GetResponseBatchID();

char* dpaymentssdk_fdmsomahabatchmgr_getresponsebatchid(void* lpObj);

QString GetResponseBatchID();

Default Value

""

Remarks

Code identifying batch to the Host.

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

Data Type

String

ResponseBatchNumber Property (FDMSOmahaBatchMgr Class)

Number identifying the batch assigned by the POS device.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseBatchNumber();

Unicode (Windows)
INT GetResponseBatchNumber();

int dpaymentssdk_fdmsomahabatchmgr_getresponsebatchnumber(void* lpObj);

int GetResponseBatchNumber();

Default Value

0

Remarks

Number identifying the batch assigned by the POS device.

This property is read-only.

Data Type

Integer

ResponseDebitBatchAmount Property (FDMSOmahaBatchMgr Class)

The total authorized amount for all Debit/EBT Card transactions in the batch.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDebitBatchAmount();

Unicode (Windows)
LPWSTR GetResponseDebitBatchAmount();

char* dpaymentssdk_fdmsomahabatchmgr_getresponsedebitbatchamount(void* lpObj);

QString GetResponseDebitBatchAmount();

Default Value

""

Remarks

The total authorized amount for all Debit/EBT Card transactions in the batch.

This value is taken directly from ResponseDebitText. Note in the case of a negative amount, a minus '-' sign will be put at the beginning of the amount.

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

Data Type

String

ResponseDebitText Property (FDMSOmahaBatchMgr Class)

Message from the Host describing the transaction in relation to Debit cards.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseDebitText();

Unicode (Windows)
LPWSTR GetResponseDebitText();

char* dpaymentssdk_fdmsomahabatchmgr_getresponsedebittext(void* lpObj);

QString GetResponseDebitText();

Default Value

""

Remarks

Message from the Host describing the transaction in relation to Debit cards.

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

Data Type

String

ResponseSuccess Property (FDMSOmahaBatchMgr Class)

Determines whether the transaction was successful.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseSuccess();

Unicode (Windows)
BOOL GetResponseSuccess();

int dpaymentssdk_fdmsomahabatchmgr_getresponsesuccess(void* lpObj);

bool GetResponseSuccess();

Default Value

FALSE

Remarks

Determines whether the transaction was successful.

This field can be queried to determine whether the transaction was successful.

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

Data Type

Boolean

ResponseText Property (FDMSOmahaBatchMgr Class)

Message from the Host describing the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* dpaymentssdk_fdmsomahabatchmgr_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

Message from the Host describing the transaction.

Below are some of the common message responses from the Host.

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

Data Type

String

ResponseTransactionNumber Property (FDMSOmahaBatchMgr Class)

Number of the transaction in the batch as specified by the Point of Sale device.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseTransactionNumber();

Unicode (Windows)
INT GetResponseTransactionNumber();

int dpaymentssdk_fdmsomahabatchmgr_getresponsetransactionnumber(void* lpObj);

int GetResponseTransactionNumber();

Default Value

0

Remarks

Number of the transaction in the batch as specified by the Point of Sale device.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertEncoded Property (FDMSOmahaBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_fdmsomahabatchmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

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

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_fdmsomahabatchmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_fdmsomahabatchmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

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 designations are 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., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (FDMSOmahaBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_fdmsomahabatchmgr_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_fdmsomahabatchmgr_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_fdmsomahabatchmgr_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

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

SSLProvider Property (FDMSOmahaBatchMgr Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_fdmsomahabatchmgr_getsslprovider(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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:

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

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dpaymentssdk_fdmsomahabatchmgr_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

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

Timeout Property (FDMSOmahaBatchMgr Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_fdmsomahabatchmgr_gettimeout(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionNumber Property (FDMSOmahaBatchMgr Class)

The transaction number for the current transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Unicode (Windows)
INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);

int dpaymentssdk_fdmsomahabatchmgr_gettransactionnumber(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_settransactionnumber(void* lpObj, int iTransactionNumber);

int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

0

Remarks

This property is used to specify the transaction number for the current transaction. The valid values are 0 - 999. A TransactionNumber of 0 is only used and MUST be used for AuthOnly transactions, thus all other transaction types must have a TransactionNumber of 1 or greater. The maximum value of TransactionNumber is 999 (note: closing a batch requires an item number and thus the actual number of transactions in a batch is 998).

If a transaction is unsuccessful the TransactionNumber should be re-used.

For Credit Card transactions, the TransactionNumber starts at 1 (provided it is not an AuthOnly transaction) and must increment with each successful transaction.

For Debit/EBT Card transactions, the TransactionNumber starts at 999 and must decrement with each successful transaction.

Note TransactionNumbers for Credit Card and Debit/EBT cards *cannot* overlap and must be unique. Additionally, there must be an open TransactionNumber for the close batch transaction. For example, you can have 1-454 for Credit Card transactions and 456-999 for Debit/EBT cards but TransactionNumber 455 must be left available for the close batch transaction.

Item numbers do NOT have to be processed in sequence (i.e. 1, 2, 3, etc.). However, when a batch is closed all transactions up to the TransactionNumber specified to close the batch must be accounted for. For example; if a batch is closed using TransactionNumber 5, transactions 1, 2, 3, and 4 MUST be accounted for. Additionally, if the batch is closed using an TransactionNumber that is not one more than the number of items in the batch, the Host will delete all records over the close TransactionNumber. For example; if a batch is closed using TransactionNumber 5, transaction records 5, 6, 7, etc. will be automatically deleted by the system.

Each transaction that posts to the Host with an TransactionNumber must keep that TransactionNumber until the batch is closed. Note: the Host accepts two or more transactions with the same TransactionNumber, but the last transaction will overwrite any previous transactions. For example, if a Sale is performed for TransactionNumber 1 and then a Credit is performed, only the Credit will post to the cardholder's account (it will be as if the Sale transaction never happened, with the exception of the reserved funds).

This property is not applicable for the ottRevise and ottVoid transaction types. Thus when GetDetailAggregate is called, the returned aggregate will contain the TransactionNumber specified within the original transaction.

Below is a table of the various transaction types and how TransactionNumber should be handled for Credit Card transactions. Note that the below table is only applicable to Credit Card transactions.

Debit/EBT cards are always performed online and thus each successful transaction should have their own unique TransactionNumber that starts at 999 and decrements by 1 for each success transaction performed.

Data Type

Integer

URL Property (FDMSOmahaBatchMgr Class)

Location of the Datawire server to which transactions are sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* dpaymentssdk_fdmsomahabatchmgr_geturl(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

Default Value

"https://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister class. Once you Register and Activate the merchant using the FDMSRegister class, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister class.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

Data Type

String

CloseBatch Method (FDMSOmahaBatchMgr Class)

Sends a Close Batch request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseBatch();

Unicode (Windows)
INT CloseBatch();

int dpaymentssdk_fdmsomahabatchmgr_closebatch(void* lpObj);

int CloseBatch();

Remarks

This method sends a close batch request to the FDMS transaction processor, which initiates the settlement of the transactions contained within the batch.

By default, prior to CloseBatch being called, all the detail aggregates for every transaction within the batch should be added to DetailRecords. These detail records are used by the component to send all offline transactions and compute the total transaction amounts for the batch (which are sent in the close batch request).

When CloseBatch is called, all the offline transactions (Voids, Revisions, etc) contained within DetailRecords will be sent prior to the actual close batch request. After all the offline transactions have been sent, the batch close message is sent. If the Host is out-of-balance with the Total Amount specified (which is calculated by the component based on the information contained within the DetailRecords), the Host may request an inquiry to synchronize all transactions. If such a case occurs, the component will handle all inquiries and respond accordingly based on the request and information contained within DetailRecords. Once the host is in sync, the Host will send the close batch response and Response will be populated. ResponseSuccess will be true if the batch was successfully closed.

Note: TransactionNumber must be one greater than the number of Credit Card transactions and must also be less than the number of Debit/EBT Card transactions within the batch.

Note under specific circumstances, it may be advantageous for you to manually handle batch amounts and polling or revision inquiries (rather then adding all the transaction aggregates to DetailRecords). To do this, you can set the following configuration settings CreditBatchAmount, DebitBatchCount, and DebitBatchAmount. When these configuration settings are set, the component does not compute batch amount totals and thus only the offline transaction aggregates need to be added to DetailRecords. If a revision or specific poll inquiry is requested by the host, rather than the component automatically sending a response based on the DetailRecords, the RevisionInquiry or SpecificPoll events will fire. Within these events, you will be required to set the information requested which will be used to send the inquiry response. OmahaBatchMgr.BatchNumber = 1; OmahaBatchMgr.TransactionNumber = 10; OmahaBatchMgr.CloseBatch();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (FDMSOmahaBatchMgr Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_fdmsomahabatchmgr_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DepositInquiry Method (FDMSOmahaBatchMgr Class)

Sends a Deposit Inquiry request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DepositInquiry();

Unicode (Windows)
INT DepositInquiry();

int dpaymentssdk_fdmsomahabatchmgr_depositinquiry(void* lpObj);

int DepositInquiry();

Remarks

This method sends a Deposit Inquiry request and allows the merchant to view the last batch closed with the same MerchantNumber and DeviceId from the previous processing day.

Response will contain the details of the deposit inquiry response. OmahaBatchMgr.DepositInquiry();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (FDMSOmahaBatchMgr Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_fdmsomahabatchmgr_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts any processing that the class is currently executing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FDMSOmahaBatchMgr Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_fdmsomahabatchmgr_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (FDMSOmahaBatchMgr Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(FDMSOmahaBatchMgrConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} FDMSOmahaBatchMgrConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(FDMSOmahaBatchMgrConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FDMSOmahaBatchMgrConnectedEventParams;

#define EID_FDMSOMAHABATCHMGR_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class FDMSOmahaBatchMgrConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(FDMSOmahaBatchMgrConnectedEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireConnected(FDMSOmahaBatchMgrConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, 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.

Please refer to the Error Codes section for more information.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

DataPacketIn Event (FDMSOmahaBatchMgr Class)

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} FDMSOmahaBatchMgrDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} FDMSOmahaBatchMgrDataPacketInEventParams;

#define EID_FDMSOMAHABATCHMGR_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class FDMSOmahaBatchMgrDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireDataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e) {...}

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (FDMSOmahaBatchMgr Class)

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} FDMSOmahaBatchMgrDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} FDMSOmahaBatchMgrDataPacketOutEventParams;

#define EID_FDMSOMAHABATCHMGR_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class FDMSOmahaBatchMgrDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireDataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e) {...}

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (FDMSOmahaBatchMgr Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} FDMSOmahaBatchMgrDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FDMSOmahaBatchMgrDisconnectedEventParams;

#define EID_FDMSOMAHABATCHMGR_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class FDMSOmahaBatchMgrDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireDisconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

Error Event (FDMSOmahaBatchMgr Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(FDMSOmahaBatchMgrErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FDMSOmahaBatchMgrErrorEventParams;


Unicode (Windows)
virtual INT FireError(FDMSOmahaBatchMgrErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FDMSOmahaBatchMgrErrorEventParams;

#define EID_FDMSOMAHABATCHMGR_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FDMSOmahaBatchMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FDMSOmahaBatchMgrErrorEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireError(FDMSOmahaBatchMgrErrorEventParams *e) {...}

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.

RevisionInquiry Event (FDMSOmahaBatchMgr Class)

Fired when a revision inquiry request is received from the host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e);

typedef struct {
  int StartTransactionNumber;
  char *RevisionNumbers;
  int reserved;
} FDMSOmahaBatchMgrRevisionInquiryEventParams;


Unicode (Windows)
virtual INT FireRevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e);

typedef struct {
  INT StartTransactionNumber;
  LPWSTR RevisionNumbers;
  INT reserved;
} FDMSOmahaBatchMgrRevisionInquiryEventParams;

#define EID_FDMSOMAHABATCHMGR_REVISIONINQUIRY 6

virtual INT DPAYMENTSSDK_CALL FireRevisionInquiry(INT &iStartTransactionNumber, LPSTR &lpszRevisionNumbers);

class FDMSOmahaBatchMgrRevisionInquiryEventParams {
public:
  int StartTransactionNumber();

  const QString &RevisionNumbers();
  void SetRevisionNumbers(const QString &qsRevisionNumbers);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireRevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e) {...}

Remarks

This event fires when a revision inquiry request is received. Note that this is only applicable when manually handling the batch close details (occurs when setting CreditBatchAmount and DebitBatchAmount). Otherwise the component will compute batch details and handle all revision and specific poll inquiries.

StartTransactionNumber is used to identify the transaction number where the revision number list should begin.

RevisionNumbers is a comma-separated list containing the total number of revisions for each transaction. The maximum length of the list is 10 revision numbers or until you reach the last transaction number within the batch (whichever comes first).

For example, you have 12 transactions within the current batch with transaction 3 being voided, 9 being revised once and then voided, and transaction 12 being revised once. (Revisions include all transactions that have been revised or voided). A revision inquiry is requested and RevisionInquiry is fired with a StartTransactionNumber of 1. '1' specifies that we need to start with the first transaction number. Therefore RevisionNumbers should be set to the following list for transactions 1-10: "0,0,1,0,0,0,0,0,2,0". So the '1' in the list represents transaction 3 which was voided. The '2' in the list represents transaction 9 which was revised once and then voided (thus it was revised twice). Once specified, the component will send the revision inquiry response with the numbers specified. Upon a successful response, the host may send back a batch close response or request another revision inquiry. Let's say a second revision inquiry was requested. When RevisionInquiry is fired, TransactionNumber will be 11 (from our current example). Thus RevisionNumbers should be set to: "0,1" for transactions 11 and 12 (12 being the last one in the batch).

Note FDMS does have time constraints on when a response should be sent and received by the host which can be as low as 4 seconds. Therefore the handling and specifying of the RevisionNumbers should occur in a timely manner to ensure that all requests/responses can be processed without the connection being closed.

SpecificPoll Event (FDMSOmahaBatchMgr Class)

Fired when a specific poll request is received from the host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e);

typedef struct {
  int TransactionNumber;
  char *Aggregate;
  int reserved;
} FDMSOmahaBatchMgrSpecificPollEventParams;


Unicode (Windows)
virtual INT FireSpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e);

typedef struct {
  INT TransactionNumber;
  LPWSTR Aggregate;
  INT reserved;
} FDMSOmahaBatchMgrSpecificPollEventParams;

#define EID_FDMSOMAHABATCHMGR_SPECIFICPOLL 7

virtual INT DPAYMENTSSDK_CALL FireSpecificPoll(INT &iTransactionNumber, LPSTR &lpszAggregate);

class FDMSOmahaBatchMgrSpecificPollEventParams {
public:
  int TransactionNumber();

  const QString &Aggregate();
  void SetAggregate(const QString &qsAggregate);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireSpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e) {...}

Remarks

This event fires when a specific poll request is received (which occurs when the host is out-of-balance with the Total Amount specified). Note that this is only applicable when manually handling the batch close details (occurs when setting CreditBatchAmount and DebitBatchAmount). Otherwise the component will compute batch details and handle all revision and specific poll inquiries.

TransactionNumber is used to identify the transaction number requested by the host.

Aggregate should be set to the detail aggregate for the specified TransactionNumber. The component will then use the detail aggregate data to build and send the specific poll response to the host.

If no aggregate is specified, the component will send a negative response to the specific poll inquiry.

Note FDMS does have time constraints on when a response should be sent and received by the host which can be as low as 4 seconds. Therefore the handling and specifying of the Aggregate should occur in a timely manner to ensure that all requests/responses can be processed without the connection being closed.

SSLServerAuthentication Event (FDMSOmahaBatchMgr Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FDMSOmahaBatchMgrSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FDMSOmahaBatchMgrSSLServerAuthenticationEventParams;

#define EID_FDMSOMAHABATCHMGR_SSLSERVERAUTHENTICATION 8

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FDMSOmahaBatchMgrSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireSSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e) {...}

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FDMSOmahaBatchMgrSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FDMSOmahaBatchMgrSSLStatusEventParams;

#define EID_FDMSOMAHABATCHMGR_SSLSTATUS 9

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class FDMSOmahaBatchMgrSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireSSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e) {...}

Remarks

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

Status Event (FDMSOmahaBatchMgr Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(FDMSOmahaBatchMgrStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FDMSOmahaBatchMgrStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(FDMSOmahaBatchMgrStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FDMSOmahaBatchMgrStatusEventParams;

#define EID_FDMSOMAHABATCHMGR_STATUS 10

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

class FDMSOmahaBatchMgrStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(FDMSOmahaBatchMgrStatusEventParams *e);

// Or, subclass FDMSOmahaBatchMgr and override this emitter function.
virtual int FireStatus(FDMSOmahaBatchMgrStatusEventParams *e) {...}

Remarks

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

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

Config Settings (FDMSOmahaBatchMgr Class)

FDMSOmahaBatchMgr Config Settings

TCPClient Config Settings

SSL Config Settings

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSOmahaBatchMgr Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FDMSOmahaBatchMgr Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors