FDMSGiftCard Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSGiftCard class is used to manipulate funds on Stored Value (Gift) Cards with the FDMS Closed Loop Gift Card System. This class supports both card-present and card-not-present gift card transactions, and allows for simple, direct, secure communication to the Datawire gateway to FDMS through a standard Internet connection. This class can be integrated into web pages or stand- alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

FDMSGiftCard

Remarks

A Stored Value Card (or Gift Card as they are commonly called) is a not actually a type of credit or debit card. Simply put, a Stored Value Card is a card with a magnetic strip on the back that holds information about monies that have been "pre-paid" into an account for the purpose of making financial transactions. Examples include a retailer's gift card, a prepaid telephone card, a college campus meal plan card, a reloadable subway pass, etcetera. Not included are government income-support cards, otherwise known as EBT cards or electronic food stamps.

The FDMSGiftCard class makes gift card transactions 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 class and authorizing a transaction are outlined below:

First, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSRegister class to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId with the value retrieved by the FDMSRegister class after activating your merchant account. Set the URL property with one of the URLs you retrieved during Service Discovery.

 
 Copy
  FDMSGiftCard.MerchantNumber = "57111111111";          // Supplied by FDMS/Datawire  
  FDMSGiftCard.MerchantTerminalNumber = "00000000001";  // Supplied by FDMS/Datawire
  FDMSGiftCard.DatawireId = "00010388888888888878";     // Retrieved with the FDMSRegister class.  

After the merchant information is setup, you may enter transaction data. When the card is Manually Entered, the merchant should fill the Number and EntryDataSource fields. Otherwise, you should fill the MagneticStripe field with the Track 2 data read from the back of the card.

 
 Copy
  
  FDMSGiftCard.Card.MagneticStripe = "6010567008288444=00010004000070771026";
  FDMSGiftCard.Card.EntryDataSource = edsTrack2;

Then set additional information about the transaction, including any merchant-designated tracking information, such as the Id of the employee making the transaction, the terminal where the transaction is taking place, any alternate identification for the merchant location, and transaction and reference numbers.

 
 Copy
  
  FDMSGiftCard.TransactionNumber = "0000001V000003";
  FDMSGiftCard.ClerkId = "123";
  FDMSGiftCard.ReferenceNumber = "555523";  
  FDMSGiftCard.AlternateMerchantId = "132123";  
  FDMSGiftCard.TerminalId = "1234"; 

To add funds to an existing Gift Card, simply set the TransactionAmount with the amount to add to the card, and then call LoadCard. Activating a new gift card is handled similarly, by calling ActivateCard instead.

To redeem funds from a Gift Card due to a customer purchase, set TransactionAmount to the total for the purchase and call RedeemCard. If the Gift Card account contains enough funds, Code will indicate the card was approved. If there are not enough funds available on the card to cover the TransactionAmount, normally the transaction will be declined. However, the merchant may set RedemptionType to rtPartialRedemption. This allows the customer to split the cost of the purchase between the Gift Card and another form of payment. Instead of declining the Gift Card, PreviousBalance and NewBalance can be used to deduce the amount removed from the Gift Card. The merchant may subtract that from the requested TransactionAmount to determine the difference to charge the customer.

You may also inquire as to the total funds contained on the card by calling BalanceInquiry. This will not effect the amount of funds contained on the card in any way.

You also have the ability to lock funds on a card with the LockCard method, so that they may not be used for any other purchase until first unlocked. Previous transactions may be voided with VoidTransaction, and any transactions for which you did not receive a response (due to network issues), should be immediately reversed using the ReverseLastTransaction method.

The status of any of the above transactions will be stored in the Code field, with human-readable text appearing in Text. Like the FDMSRetail class, there are several other Response fields which will contain data that should be logged.

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.

AlternateMerchantId Property (FDMSGiftCard Class)

Merchant-designated store or location number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlternateMerchantId();
int SetAlternateMerchantId(const char* lpszAlternateMerchantId);

Unicode (Windows)
LPWSTR GetAlternateMerchantId();
INT SetAlternateMerchantId(LPCWSTR lpszAlternateMerchantId);

char* dpaymentssdk_fdmsgiftcard_getalternatemerchantid(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setalternatemerchantid(void* lpObj, const char* lpszAlternateMerchantId);

QString GetAlternateMerchantId();
int SetAlternateMerchantId(QString qsAlternateMerchantId);

Default Value

""

Remarks

Unlike the MerchantNumber property, the AlternateMerchantId is not used by FDMS or Datawire as connection credentials. This number is for the merchant's internal use. The maximum length of this property is 11 digits, and it may only contain numeric data.

Data Type

String

ApplicationId Property (FDMSGiftCard 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_fdmsgiftcard_getapplicationid(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setapplicationid(void* lpObj, const char* lpszApplicationId);

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

Default Value

"NSFTDIRCTGFTXML"

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.

Data Type

String

Card Property (FDMSGiftCard Class)

Contains the customer's credit card information.

Syntax

• C++
• C
• Qt

DPaymentsSDKCCCard* GetCard();
int SetCard(DPaymentsSDKCCCard* val);

int dpaymentssdk_fdmsgiftcard_getcardtype(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardtype(void* lpObj, int iCardType);

char* dpaymentssdk_fdmsgiftcard_getcardcvvdata(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

int dpaymentssdk_fdmsgiftcard_getcardcvvpresence(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int dpaymentssdk_fdmsgiftcard_getcardentrydatasource(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int dpaymentssdk_fdmsgiftcard_getcardexpmonth(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardexpmonth(void* lpObj, int iCardExpMonth);

int dpaymentssdk_fdmsgiftcard_getcardexpyear(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardexpyear(void* lpObj, int iCardExpYear);

int dpaymentssdk_fdmsgiftcard_getcardisencrypted(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

char* dpaymentssdk_fdmsgiftcard_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

char* dpaymentssdk_fdmsgiftcard_getcardnumber(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setcardnumber(void* lpObj, const char* lpszCardNumber);

int GetCardType();
int SetCardType(int iCardType);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

Data Type

DPaymentsSDKCCCard

ClerkId Property (FDMSGiftCard Class)

Identifies the clerk executing this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClerkId();
int SetClerkId(const char* lpszClerkId);

Unicode (Windows)
LPWSTR GetClerkId();
INT SetClerkId(LPCWSTR lpszClerkId);

char* dpaymentssdk_fdmsgiftcard_getclerkid(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setclerkid(void* lpObj, const char* lpszClerkId);

QString GetClerkId();
int SetClerkId(QString qsClerkId);

Default Value

""

Remarks

This contains a merchant-generated code used to identify an individual clerk in the merchant's system. Each clerk within a merchant's location should have their own unique identifier, to help determine which employee has performed operations on a gift card. This may be a maximum of 8 characters in length, and may only contain alphanumeric data. This can be used in conjunction with the TerminalId to determine the location a transaction was made and the employee who made it.

Data Type

String

DatawireId Property (FDMSGiftCard 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_fdmsgiftcard_getdatawireid(void* lpObj);
int dpaymentssdk_fdmsgiftcard_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.

Data Type

String

LockType Property (FDMSGiftCard Class)

Indicates the type of lock requested by the LockCard method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLockType();
int SetLockType(int iLockType);

Unicode (Windows)
INT GetLockType();
INT SetLockType(INT iLockType);

LT_FULL_LOCK(0), 
LT_PARTIAL_LOCK(1)

int dpaymentssdk_fdmsgiftcard_getlocktype(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setlocktype(void* lpObj, int iLockType);

int GetLockType();
int SetLockType(int iLockType);

Default Value

0

Remarks

This property is only used when locking funds on a card. If set to ltFullLock (default), the full balance on the gift card will be locked, and the customer will be unable to use funds on the card until the card is unlocked by setting RedemptionType to rtRedemptionWithUnlock and calling RedeemCard.

If set to ltPartialLock, only the amount indicated by the TransactionAmount property is locked. Any remaining funds on the card may be used for other purchases.

Data Type

Integer

MerchantNumber Property (FDMSGiftCard Class)

A unique number used to identify the merchant within the FDMS and Datawire 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_fdmsgiftcard_getmerchantnumber(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

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

Default Value

""

Remarks

This property contains a unique number (typically 12 digits) which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS and Datawire systems, and is used along with the MerchantTerminalNumber and DatawireId as connection credentials.

Data Type

String

MerchantTerminalNumber Property (FDMSGiftCard Class)

Used to identify a unique terminal within a merchant location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber);

Unicode (Windows)
LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);

char* dpaymentssdk_fdmsgiftcard_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

Default Value

""

Remarks

This property contains a number assigned by FDMS to uniquely identify a terminal within a merchant's location, and is used along with the MerchantNumber and DatawireId as Datawire connection credentials. This number differs from the TerminalId number, which is a 4-digit merchant-generated id used along with the ClerkId to identify where and who executed the transaction.

The maximum length of the MerchantTerminalNumber is 11 digits, and it may only contain numeric data.

Data Type

String

Proxy Property (FDMSGiftCard Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

DPaymentsSDKProxy* GetProxy();
int SetProxy(DPaymentsSDKProxy* val);

int dpaymentssdk_fdmsgiftcard_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int dpaymentssdk_fdmsgiftcard_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* dpaymentssdk_fdmsgiftcard_getproxypassword(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int dpaymentssdk_fdmsgiftcard_getproxyport(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxyport(void* lpObj, int iProxyPort);

char* dpaymentssdk_fdmsgiftcard_getproxyserver(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxyserver(void* lpObj, const char* lpszProxyServer);

int dpaymentssdk_fdmsgiftcard_getproxyssl(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxyssl(void* lpObj, int iProxySSL);

char* dpaymentssdk_fdmsgiftcard_getproxyuser(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

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

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

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

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

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

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

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

DPaymentsSDKProxy

RedemptionType Property (FDMSGiftCard Class)

Identifies the type of redemption to execute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRedemptionType();
int SetRedemptionType(int iRedemptionType);

Unicode (Windows)
INT GetRedemptionType();
INT SetRedemptionType(INT iRedemptionType);

RT_NORMAL_REDEMPTION(0), 
RT_PARTIAL_REDEMPTION(1), 
RT_CASH_OUT(2), 
RT_REDEMPTION_WITH_UNLOCK(3)

int dpaymentssdk_fdmsgiftcard_getredemptiontype(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setredemptiontype(void* lpObj, int iRedemptionType);

int GetRedemptionType();
int SetRedemptionType(int iRedemptionType);

Default Value

0

Remarks

This property is used by the RedeemCard method to indicate the type of charge to make against the gift card account. The valid redemption types include:

Data Type

Integer

ReferenceNumber Property (FDMSGiftCard Class)

Reference number used to identify the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceNumber();
int SetReferenceNumber(const char* lpszReferenceNumber);

Unicode (Windows)
LPWSTR GetReferenceNumber();
INT SetReferenceNumber(LPCWSTR lpszReferenceNumber);

char* dpaymentssdk_fdmsgiftcard_getreferencenumber(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setreferencenumber(void* lpObj, const char* lpszReferenceNumber);

QString GetReferenceNumber();
int SetReferenceNumber(QString qsReferenceNumber);

Default Value

""

Remarks

The merchant may optionally specify up to 16 characters of alphanumeric data in this property. The ReferenceNumber should not contain any leading or trailing whitespace, or any spaces between characters.

This property is for tracking and logging purposes only, and is not validated by the FDMS Closed Loop Gift Card system.

Data Type

String

Response Property (FDMSGiftCard Class)

Contains the response returned from the FDMS Closed Loop Gift Card system.

Syntax

• C++
• C
• Qt

DPaymentsSDKFDMSGiftResponse* GetResponse();

char* dpaymentssdk_fdmsgiftcard_getresponseapprovalcode(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsecardclass(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsecardexpdate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsecashback(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsecode(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsedatawirereturncode(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsedatawirestatus(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponselockamount(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsenewbalance(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsepreviousbalance(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsereferencenumber(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsesystemtrace(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getresponsetext(void* lpObj);

QString GetResponseApprovalCode();

QString GetResponseCardClass();

QString GetResponseCardExpDate();

QString GetResponseCashBack();

QString GetResponseCode();

QString GetResponseDatawireReturnCode();

QString GetResponseDatawireStatus();

QString GetResponseLockAmount();

QString GetResponseNewBalance();

QString GetResponsePreviousBalance();

QString GetResponseReferenceNumber();

QString GetResponseSystemTrace();

QString GetResponseText();

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSGiftResponse type contains the following fields:

This property is read-only.

Data Type

DPaymentsSDKFDMSGiftResponse

SSLAcceptServerCert Property (FDMSGiftCard Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_fdmsgiftcard_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_fdmsgiftcard_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_fdmsgiftcard_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsgiftcard_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DPaymentsSDKCertificate

SSLCert Property (FDMSGiftCard Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_fdmsgiftcard_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertissuer(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmsgiftcard_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_fdmsgiftcard_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_fdmsgiftcard_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_fdmsgiftcard_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertusage(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertversion(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_fdmsgiftcard_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmsgiftcard_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DPaymentsSDKCertificate

SSLProvider Property (FDMSGiftCard Class)

The Secure Sockets Layer/Transport Layer Security (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_fdmsgiftcard_getsslprovider(void* lpObj);
int dpaymentssdk_fdmsgiftcard_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 as follows:

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

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

Data Type

Integer

SSLServerCert Property (FDMSGiftCard Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_fdmsgiftcard_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_fdmsgiftcard_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertusage(void* lpObj);

int dpaymentssdk_fdmsgiftcard_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertversion(void* lpObj);

char* dpaymentssdk_fdmsgiftcard_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

TerminalId Property (FDMSGiftCard Class)

Merchant-generated 4-digit terminal Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTerminalId();
int SetTerminalId(const char* lpszTerminalId);

Unicode (Windows)
LPWSTR GetTerminalId();
INT SetTerminalId(LPCWSTR lpszTerminalId);

char* dpaymentssdk_fdmsgiftcard_getterminalid(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setterminalid(void* lpObj, const char* lpszTerminalId);

QString GetTerminalId();
int SetTerminalId(QString qsTerminalId);

Default Value

""

Remarks

This terminal number is created by the merchant, and is used to identify the terminal or register where the transaction is taking place. This can be used in conjunction with the ClerkId to determine the location and employee who initiated the transaction. This number differs from the MerchantTerminalNumber, which is an 11-digit number specified by FDMS and used as Datawire connection credentials.

Data Type

String

Timeout Property (FDMSGiftCard 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_fdmsgiftcard_gettimeout(void* lpObj);
int dpaymentssdk_fdmsgiftcard_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

TransactionAmount Property (FDMSGiftCard Class)

Purchase amount to be authorized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount);

Unicode (Windows)
LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);

char* dpaymentssdk_fdmsgiftcard_gettransactionamount(void* lpObj);
int dpaymentssdk_fdmsgiftcard_settransactionamount(void* lpObj, const char* lpszTransactionAmount);

QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);

Default Value

""

Remarks

This property contains the transaction amount to be authorized.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (FDMSGiftCard Class)

Uniquely identifies the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionNumber();
int SetTransactionNumber(const char* lpszTransactionNumber);

Unicode (Windows)
LPWSTR GetTransactionNumber();
INT SetTransactionNumber(LPCWSTR lpszTransactionNumber);

char* dpaymentssdk_fdmsgiftcard_gettransactionnumber(void* lpObj);
int dpaymentssdk_fdmsgiftcard_settransactionnumber(void* lpObj, const char* lpszTransactionNumber);

QString GetTransactionNumber();
int SetTransactionNumber(QString qsTransactionNumber);

Default Value

""

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) 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.

For all classs except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

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

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

Data Type

String

URL Property (FDMSGiftCard 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_fdmsgiftcard_geturl(void* lpObj);
int dpaymentssdk_fdmsgiftcard_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.

Data Type

String

VoidType Property (FDMSGiftCard Class)

Identifies the type of void to execute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVoidType();
int SetVoidType(int iVoidType);

Unicode (Windows)
INT GetVoidType();
INT SetVoidType(INT iVoidType);

VT_REDEMPTION(0), 
VT_LOAD(1), 
VT_ACTIVATION(2)

int dpaymentssdk_fdmsgiftcard_getvoidtype(void* lpObj);
int dpaymentssdk_fdmsgiftcard_setvoidtype(void* lpObj, int iVoidType);

int GetVoidType();
int SetVoidType(int iVoidType);

Default Value

0

Remarks

This property is used by the VoidTransaction method to indicate the type of transaction which is to be voided. Valid void types include:

Data Type

Integer

ActivateCard Method (FDMSGiftCard Class)

Activates a Gift Card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ActivateCard();

Unicode (Windows)
INT ActivateCard();

int dpaymentssdk_fdmsgiftcard_activatecard(void* lpObj);

int ActivateCard();

Remarks

Stored value Activation transactions provide merchants the ability to activate a new stored value card on the FDMS Closed Loop Gift Card System. Activation transactions can only be performed on cards that have not been previously activated. Merchants have the ability to activate stored value cards with a host configured pre-denominated TransactionAmount or activate non-denominated cards with a flexible TransactionAmount. With pre-denominated cards, the stored value host will either approve the transaction for the amount on the face of the card (regardless of the amount specified in TransactionAmount), or decline the transaction if the TransactionAmount doesn't match the amount printed on the card. This is dependent on individual merchant setup.

The Code and Text fields indicate whether this transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

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

BalanceInquiry Method (FDMSGiftCard Class)

Retrieves the balance remaining on a gift card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BalanceInquiry();

Unicode (Windows)
INT BalanceInquiry();

int dpaymentssdk_fdmsgiftcard_balanceinquiry(void* lpObj);

int BalanceInquiry();

Remarks

A BalanceInquiry transaction requests that the FDMS Closed Loop Gift Card system return the amount of funds remaining on the customer's Stored Value (Gift) Card. No charge is made to the customer's gift card. The PreviousBalance and NewBalance fields will contain the card's current balance.

The Code and Text fields indicate whether this transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

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 (FDMSGiftCard 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_fdmsgiftcard_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.

Interrupt Method (FDMSGiftCard Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

LoadCard Method (FDMSGiftCard Class)

Adds funds to a gift card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadCard();

Unicode (Windows)
INT LoadCard();

int dpaymentssdk_fdmsgiftcard_loadcard(void* lpObj);

int LoadCard();

Remarks

This method adds funds to a gift card. The gift card must have been previously activated using the ActivateCard method. ActivateCard is used when the card is originally purchased. LoadCard should be used when a customer wishes to add funds onto his card, to give the customer a refund, etc.

The Code and Text fields indicate whether this transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

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

LockCard Method (FDMSGiftCard Class)

Locks funds on a gift card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LockCard();

Unicode (Windows)
INT LockCard();

int dpaymentssdk_fdmsgiftcard_lockcard(void* lpObj);

int LockCard();

Remarks

This transaction will lock funds on a gift card. The LockType property determines if you want to lock the full amount on the card, or a lesser amount indicated by the TransactionAmount you specify. If you lock the full amount the customer will be unable to use the card until the funds are unlocked. If you request a partial lock, the customer will still be able to make purchases on the card, unless a purchase would cause the balance on the card to drop below the locked amount. For example, if a customer uses a gift card at a restaurant, you do not know the gratuity beforehand, so you may wish to lock the amount of the bill plus 20% for any tip he might leave.

Use the RedeemCard method with the RedemptionType set to rtRedemptionWithUnlock, to unlock the card. If you made a partial lock, the TransactionAmount for this redemption must be less than or equal to the locked amount, or the transaction will be declined.

Note: A full lock also requires the TransactionAmount property to be sent in the request. If the gift card balance is less than the requested TransactionAmount, the lock transaction will be declined.

The Code and Text fields indicate whether this transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

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

RedeemCard Method (FDMSGiftCard Class)

Removes funds from the gift card for a purchase.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RedeemCard();

Unicode (Windows)
INT RedeemCard();

int dpaymentssdk_fdmsgiftcard_redeemcard(void* lpObj);

int RedeemCard();

Remarks

A Redemption transaction is the process of deducting value from the Gift Card, and is very similar to a Credit Card Sale transaction, except that funds are immediately removed from the balance of the gift card. There are four types of redemptions that can be made with this method, depending on the value of the RedemptionType.

Regular redemptions can be made with TransactionAmounts up to the balance on the card. Attempting to redeem a card for more than the current balance will result in a decline for insufficient funds.

In the case that the customer's gift card does not have enough funds to cover the entire TransactionAmount, the merchant may request that the host perform a Partial Redemption. With the RedemptionType set to rtPartialRedemption, the point of sale is capable of processing a Redemption transaction for more than the card balance, and still receive an approval. All of the funds remaining on the gift card will be put towards the TransactionAmount, and the merchant will be required to obtain an additional form of payment for the remaining balance. The PreviousBalance and NewBalance can then be used to calculate the amount actually removed from the card, and the amount the customer still needs to tender (via cash, credit card, etc).

If the merchant allows it, a customer may Cash Out his gift card, and receive the remainder of the gift card's stored value as cash. To cash out a gift card, clear the TransactionAmount and set the RedemptionType to rtCashOut before calling RedeemCard. If successful, the NewBalance will be zero, and the PreviousBalance will indicate the total amount removed from the card, which should be given to the customer as cash.

Finally, you can send a Redemption Unlock transaction, which redeems the card and removes a lock that was previously made with the LockCard method.

The Code and Text fields indicate whether this transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

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

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

ReverseLastTransaction Method (FDMSGiftCard Class)

Reverses the last attempted transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReverseLastTransaction();

Unicode (Windows)
INT ReverseLastTransaction();

int dpaymentssdk_fdmsgiftcard_reverselasttransaction(void* lpObj);

int ReverseLastTransaction();

Remarks

If a transaction times out or you are otherwise unsure if it completed successfully, immediately use this method to reverse it. If the transaction had gone through successfully, the Code will be "00" and the other Response properties will show the results of the reversal. If the transaction was never actually received by the FDMS Closed Loop Gift Card System you will get a Code of "33", indicating that no previous transaction was found to reverse.

The Code and Text fields indicate whether this transaction was successful.

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

VoidTransaction Method (FDMSGiftCard Class)

Voids a previous transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VoidTransaction();

Unicode (Windows)
INT VoidTransaction();

int dpaymentssdk_fdmsgiftcard_voidtransaction(void* lpObj);

int VoidTransaction();

Remarks

This method is used to void a transaction previously made with the RedeemCard, LoadCard, or ActivateCard methods. The VoidType property indicates the type of transaction you wish to void. Voiding a redemption adds the TransactionAmount back onto the gift card. Voiding a Load removes the TransactionAmount from the card. Voiding an Activation removes the TransactionAmount from the card and resets the state of the card to unactivated. However, Activations can only be voided if any subsequent transactions after the initial activation are voided first. See the VoidType property for more information.

The Code and Text fields indicate whether this transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

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

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_CONNECTED 1

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

class FDMSGiftCardConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass FDMSGiftCard and override this emitter function.
virtual int FireConnected(FDMSGiftCardConnectedEventParams *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.

DataPacketIn Event (FDMSGiftCard Class)

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_DATAPACKETIN 2

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

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

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

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

// Or, subclass FDMSGiftCard and override this emitter function.
virtual int FireDataPacketIn(FDMSGiftCardDataPacketInEventParams *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 (FDMSGiftCard Class)

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_DATAPACKETOUT 3

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

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

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

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

// Or, subclass FDMSGiftCard and override this emitter function.
virtual int FireDataPacketOut(FDMSGiftCardDataPacketOutEventParams *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 (FDMSGiftCard Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_DISCONNECTED 4

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

class FDMSGiftCardDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass FDMSGiftCard and override this emitter function.
virtual int FireDisconnected(FDMSGiftCardDisconnectedEventParams *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.

Error Event (FDMSGiftCard Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_ERROR 5

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

class FDMSGiftCardErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass FDMSGiftCard and override this emitter function.
virtual int FireError(FDMSGiftCardErrorEventParams *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.

SSLServerAuthentication Event (FDMSGiftCard Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_SSLSERVERAUTHENTICATION 6

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

class FDMSGiftCardSSLServerAuthenticationEventParams {
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(FDMSGiftCardSSLServerAuthenticationEventParams *e);

// Or, subclass FDMSGiftCard and override this emitter function.
virtual int FireSSLServerAuthentication(FDMSGiftCardSSLServerAuthenticationEventParams *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 (FDMSGiftCard Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (FDMSGiftCard Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_FDMSGIFTCARD_STATUS 8

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

CCCard Type

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard (declared in dpaymentssdk.h)

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields

 
 Copy
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A";
card.EntryDataSource = edsTrack1;

 
 Copy
CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields

 
 Copy
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;

 
 Copy
CCCard card = new CCCard("4012000033330026", 04, 2009);

When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will fails with an error because none is present.

• CardType
• CVVData
• CVVPresence
• EntryDataSource
• ExpMonth
• ExpYear
• IsEncrypted
• MagneticStripe
• Number

Fields

 
 Copy
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1

or

class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2

Constructors

CCCard()

CCCard(const char* lpszNumber, int iExpMonth, int iExpYear)

CCCard(const char* lpszMagneticStripe, int iEntryDataSource)

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

FDMSGiftResponse Type

Contains the response to a gift card transaction.

Syntax

DPaymentsSDKFDMSGiftResponse (declared in dpaymentssdk.h)

Remarks

This type contains the results of a transaction made with the FDMSGiftCard class. The fields contained by this type are listed below.

• ApprovalCode
• CardClass
• CardExpDate
• CashBack
• Code
• DatawireReturnCode
• DatawireStatus
• LockAmount
• NewBalance
• PreviousBalance
• ReferenceNumber
• SystemTrace
• Text

Fields

Constructors

FDMSGiftResponse()

Proxy Type

The proxy the component will connect to.

Syntax

DPaymentsSDKProxy (declared in dpaymentssdk.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

• AuthScheme
• AutoDetect
• Password
• Port
• Server
• SSL
• User

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

Config Settings (FDMSGiftCard Class)

FDMSGiftCard Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

 
 Copy
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");

 
 Copy
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

C#
 Copy
server.Config("SSLNegotiatedCipher[connId]");

C#
 Copy
server.Config("SSLNegotiatedCipherStrength[connId]");

C#
 Copy
server.Config("SSLNegotiatedCipherSuite[connId]");

C#
 Copy
server.Config("SSLNegotiatedKeyExchange[connId]");

C#
 Copy
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

C#
 Copy
server.Config("SSLNegotiatedVersion[connId]");

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

C#
 Copy
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");

Socket Config Settings

Base Config Settings