FDMSBenefit Module

Properties   Methods   Events   Config Settings   Errors  

The FDMSBenefit module is used to authorize Electronic Benefits Transfer (EBT) transactions with the FDMS system on the North platform. An EBT transaction is similar to a Debit transaction, using a PIN and KSN, but is used for Food Stamp or Cash Benefit programs. This module allows for simple, direct, secure communication to the First Data platform through a standard Internet connection.

Syntax

DPaymentsSDK.Fdmsbenefit

Remarks

This class connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these classs go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the class. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated SSL servers.

An EBT Card (also known as Cash Benefit Card or Food Stamps) works similar to a bank debit card. EBT is a special application of electronic funds transfer (EFT), or debit card technology, which takes money directly from one account and transfers it to another (credit cards, by comparison, simply record a sale for payment later). The steps to setting up the class and sending transactions 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.

FDMSBenefit.MerchantNumber = "000000999990" //Supplied by FDMS/Datawire FDMSBenefit.MerchantTerminalNumber = "555555" //Supplied by FDMS/Datawire FDMSBenefit.DatawireId = "0000B47FFFFFFFFFFFFF" //Retrieved with the FDMSRegister class. FDMSBenefit.URL = "https://staging1.datawire.net/sd/"; //Retrieved with the FDMSRegister class. Next, set properties that contain details about the transaction. The TransactionNumber should be incremented for every transaction you send. The TransactionAmount must be set, and it should contain the amount to be charged, with an implied decimal point (ie: $1.00 is "100"). Like the FDMSDebit class, there is no IndustryType property for FDMSBenefit.The format of the transmitted data does not change for different industry types. Do note that the FDMSBenefit component can only be used in a retail (or restaurant, grocery store, etc) environment, where the card and customer are present. The card must be swiped and track2 data must be specified in the CardMagneticStripe property. Cash Benefit transactions may never be manually-keyed, but Food Stamp transactions may be. EBT transactions also require the customer to input his or her PIN into a certified PIN Pad device, which will return an encrypted PIN and a Key Sequence Number to the merchant. These must be submitted with the transaction in the EncryptedPIN and KSN properties. A unique ReceiptNumber number used to identify the transaction on the merchant's system is also required for all transactions. This number must also be printed on the customer's receipt.

EBT transactions differ from credit card authorizations in that they are real-time -- Funds are immediately removed from (or added to) the customer's cash benefit or food stamp account. However, even though EBT transactions are real-time, FDMS requires they be settled at the end of the day just like credit card transactions.

The following transaction set is available for the Cash Benefit BenefitType:

Note that only food stamp transactions may be voice-authorized, attempting to send a VoucherAuthCode or VoucherNumber in a Sale transaction when the BenefitType is set to Cash Benefits will result in an error.

The example below shows how to submit a simple food stamp sale transaction. FDMSBenefit.TransactionNumber = 1 FDMSBenefit.TransactionAmount = "2500" FDMSBenefit.CardMagneticStripe = "5076800000001355=120412000000000123" FDMSBenefit.CardEntryDataSource = edsTrack1 FDMSBenefit.EncryptedPIN = "7B8491A1007E82B0" FDMSBenefit.KSN = "876543210900300000C" FDMSBenefit.ReceiptNumber = "123456" FDMSBenefit1.BenefitType = btFoodStamps FDMSBenefit.Sale

When the class receives a response, the result of the authorization will be available in several Response properties. The ResponseDatawireStatus and ResponseDatawireReturnCode indicate whether any errors occurred while passing the transaction through the Datawire VXN system. These two properties alone do not indicate a successful transaction, they only tell whether or not there were any problems transporting the authorization request and response through the Datawire system. If the transaction was successfully authorized by FDMS, then the ResponseCaptureFlag will be True, and the ResponseApprovalCode will contain an approval code that beings with "AP". (or "AL" for classs that support partially-approved/split-tender transactions). The remaining response properties provide additional information about the transaction, including cash benefit and food stamp account balances (for supported cards).

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the FDMSSettle class. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

ApplicationId Property (FDMSBenefit Module)

Identifies the merchant application to the Datawire System.

Syntax

• Swift
• Objective-C

public var applicationId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=applicationId,setter=setApplicationId:) NSString* applicationId;

- (NSString*)applicationId;
- (void)setApplicationId :(NSString*)newApplicationId;

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.

BenefitType Property (FDMSBenefit Module)

Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.

Syntax

• Swift
• Objective-C

public var benefitType: FdmsbenefitBenefitTypes {
  get {...}
  set {...}
}

public enum FdmsbenefitBenefitTypes: Int32 {
  case btFoodStamps = 0
  case btCashBenefits = 1
}

@property (nonatomic,readwrite,assign,getter=benefitType,setter=setBenefitType:) int benefitType;

- (int)benefitType;
- (void)setBenefitType :(int)newBenefitType;

Default Value

0

Remarks

Under the EBT system, food stamp clients apply for their benefits in the usual way, by filling out a form at their local food stamp office. Once eligibility and the level of benefits have been determined, an account is established in the client's name, and food stamp benefits are deposited electronically into the account each month. A plastic card similar to a Debit card is issued, and a personal identification number (PIN) is assigned or chosen by the client to provide access to the account.

When a food stamp client is ready to purchase groceries, the client's card is run through an electronic reader or a POS (point-of-sale) terminal, and the client enters the secret PIN to access the food stamp account. A transaction request is transmitted to the processor for the issuing state. The processor electronically verifies the PIN and account balance and sends either an authorization or a denial back to the retailer. The client's account is debited for the amount of the purchase, and the retailer's account is credited. No money or food stamps change hands.

The following are valid btFoodStamps (0) transactions:

• Sale
• Credit
• Voucher Clear (force) of previously voice-authorized Sale or Credit
• BalanceInquiry
• Any of the above transactions may be manually-keyed if track data cannot be read.

• Sale with CashBack
• CashWithdrawal
• Non-food related items (including alcohol)

Various state and county agencies issue cash benefits for various needs; the most familiar is Temporary Assistance to Needy Families (TANF). If the benefit is issued electronically, it can be spent like cash wherever EBT payments are accepted, it works much like a regular debit card.

The following are valid btCashBenefits (1) transactions:

• Sale
• Sale with CashBack
• BalanceInquiry
• CashWithdrawal (amount is not to be limited, client is permitted to access the remaining available balance)

• Credit (refund to a cash account not permitted)
• Voice authorizations with a voucher clear
• Manually keyed transactions (Track2 is required)

Card Property (FDMSBenefit Module)

Contains the customer's credit card information.

Syntax

• Swift
• Objective-C

public var card: CCCard {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardType,setter=setCardType:) int cardType;

- (int)cardType;
- (void)setCardType :(int)newCardType;

@property (nonatomic,readwrite,assign,getter=cardCVVData,setter=setCardCVVData:) NSString* cardCVVData;

- (NSString*)cardCVVData;
- (void)setCardCVVData :(NSString*)newCardCVVData;

@property (nonatomic,readwrite,assign,getter=cardCVVPresence,setter=setCardCVVPresence:) int cardCVVPresence;

- (int)cardCVVPresence;
- (void)setCardCVVPresence :(int)newCardCVVPresence;

@property (nonatomic,readwrite,assign,getter=cardEntryDataSource,setter=setCardEntryDataSource:) int cardEntryDataSource;

- (int)cardEntryDataSource;
- (void)setCardEntryDataSource :(int)newCardEntryDataSource;

@property (nonatomic,readwrite,assign,getter=cardExpMonth,setter=setCardExpMonth:) int cardExpMonth;

- (int)cardExpMonth;
- (void)setCardExpMonth :(int)newCardExpMonth;

@property (nonatomic,readwrite,assign,getter=cardExpYear,setter=setCardExpYear:) int cardExpYear;

- (int)cardExpYear;
- (void)setCardExpYear :(int)newCardExpYear;

@property (nonatomic,readwrite,assign,getter=cardIsEncrypted,setter=setCardIsEncrypted:) BOOL cardIsEncrypted;

- (BOOL)cardIsEncrypted;
- (void)setCardIsEncrypted :(BOOL)newCardIsEncrypted;

@property (nonatomic,readwrite,assign,getter=cardMagneticStripe,setter=setCardMagneticStripe:) NSString* cardMagneticStripe;

- (NSString*)cardMagneticStripe;
- (void)setCardMagneticStripe :(NSString*)newCardMagneticStripe;

@property (nonatomic,readwrite,assign,getter=cardNumber,setter=setCardNumber:) NSString* cardNumber;

- (NSString*)cardNumber;
- (void)setCardNumber :(NSString*)newCardNumber;

 

Default Value

""

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 for swiped cards, or a , , and for manually entered cards. ( indicates which set of properties will be used). See the CCCard type for more information.

Note, track1 data is not valid for EBT cards. You may only the track2 data on the card, or enter the card number manually.

CashBack Property (FDMSBenefit Module)

Optional cash back amount to return to the customer.

Syntax

• Swift
• Objective-C

public var cashBack: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cashBack,setter=setCashBack:) NSString* cashBack;

- (NSString*)cashBack;
- (void)setCashBack :(NSString*)newCashBack;

Default Value

""

Remarks

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 largest possible CashBack amount is "99999", yielding a maximum US dollar amount of $999.99. This field may not contain a negative number.

For cash back transactions, the TransactionAmount must contain the sum total of the purchase amount PLUS the CashBack amount. If the purchase is for $10 and the customer requests $20 cash back, CashBack should be set to "2000" and TransactionAmount must contain "3000".

Note that only US currency is supported for debit transactions.

Note: Cash back is only available for the Cash Benefit sale transactions. See BenefitType for more information.

DatawireId Property (FDMSBenefit Module)

Identifies the merchant to the Datawire System.

Syntax

• Swift
• Objective-C

public var datawireId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=datawireId,setter=setDatawireId:) NSString* datawireId;

- (NSString*)datawireId;
- (void)setDatawireId :(NSString*)newDatawireId;

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.

EncryptedPIN Property (FDMSBenefit Module)

DUKPT DES encrypted pin block, retrieved from a PIN pad.

Syntax

• Swift
• Objective-C

public var encryptedPIN: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptedPIN,setter=setEncryptedPIN:) NSString* encryptedPIN;

- (NSString*)encryptedPIN;
- (void)setEncryptedPIN :(NSString*)newEncryptedPIN;

Default Value

""

Remarks

A 16-byte encrypted PIN and associated KSN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device.

The EncryptedPIN and KSN are not required for ReverseLastTransaction transactions.

The following code snippet shows how to send a simple debit sale transaction with all required properties. FDMSDebit1.MerchantNumber = "YOURNUMBER" FDMSDebit1.MerchantTerminalNumber = "YOURTERMID" FDMSDebit1.DatawireId = "YOURDID" FDMSDebit1.URL = "https://staging1.datawire.net/sd"; // test server FDMSDebit1.TransactionNumber = 4; FDMSDebit1.TransactionAmount = "100"; FDMSDebit1.Card.EntryDataSource = edsTrack2; FDMSDebit1.Card.MagneticStripe = "9876543210012341234=12041200000001"; // (pin 1234) FDMSDebit1.EncryptedPIN = "0082943935BA205D"; FDMSDebit1.KSN = "8765432109003000012"; FDMSDebit1.ReceiptNumber = "123456"; FDMSDebit1.Sale(); If the transaction is successful, the ResponseApprovalCode will start with "AP", and the ResponseCaptureFlag will be true. Even though debit transactions are on-line transactions, it is still necessary to settle them with First Data. The following example shows how to send a simple settlement. The first thing to do is to set up the FDMSSettle class's properties with the same information used for the debit sale: FDMSSettle1.MerchantNumber = FDMSDebit1.MerchantNumber; FDMSSettle1.MerchantTerminalNumber = FDMSDebit1.MerchantTerminalNumber; FDMSSettle1.DatawireId = FDMSDebit1.DatawireId; FDMSSettle1.URL = FDMSDebit1.URL; FDMSSettle1.MerchantServiceNumber = "8001234567"; FDMSSettle1.BatchSequenceNumber = "101"; FDMSSettle1.IndustryType = itRetail; Then all that needs to be done is add the detail record from the debit sale to the settlement component and call the SendSettlement method. FDMSSettle1.DetailRecords.Add(new FDMSRecordType(FDMSDebit1.GetDetailAggregate()); FDMSSettle1.SendSettlement(); Note that in a live system you would store detail records in a database and send multiple records in a single batch at the end of the business day.

FDMSPlatform Property (FDMSBenefit Module)

Specifies the FDMS platform that the transactions will be processed on.

Syntax

• Swift
• Objective-C

public var fdmsPlatform: FdmsbenefitFDMSPlatforms {
  get {...}
  set {...}
}

public enum FdmsbenefitFDMSPlatforms: Int32 {
  case fpNorth = 0
  case fpNashville = 1
}

@property (nonatomic,readwrite,assign,getter=FDMSPlatform,setter=setFDMSPlatform:) int FDMSPlatform;

- (int)FDMSPlatform;
- (void)setFDMSPlatform :(int)newFDMSPlatform;

Default Value

0

Remarks

This property is used to identify the FDMS platform that the transactions will be sent to and processed on. The following table lists the platforms supported by this class.

KSN Property (FDMSBenefit Module)

Clear-text Key Sequence Number retrieved from a PIN pad.

Syntax

• Swift
• Objective-C

public var ksn: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=KSN,setter=setKSN:) NSString* KSN;

- (NSString*)KSN;
- (void)setKSN :(NSString*)newKSN;

Default Value

""

Remarks

A 19 or 20-byte Key Sequence Number (KSN) and associated EncryptedPIN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device. A 20-byte Key Sequence Number consists of a 1-byte pad character ('F'), a 9-byte Base Derivation Key Id (BDK ID), a 5-byte device Id, and a 5-byte transaction counter. If this property is set with a Key Sequence Number less than 20 bytes in length, the class will pad it on the left with 'F' characters.

The EncryptedPIN and KSN are not required for ReverseLastTransaction transactions.

The following code snippet shows how to send a simple debit sale transaction with all required properties. FDMSDebit1.MerchantNumber = "YOURNUMBER" FDMSDebit1.MerchantTerminalNumber = "YOURTERMID" FDMSDebit1.DatawireId = "YOURDID" FDMSDebit1.URL = "https://staging1.datawire.net/sd"; // test server FDMSDebit1.TransactionNumber = 4; FDMSDebit1.TransactionAmount = "100"; FDMSDebit1.Card.EntryDataSource = edsTrack2; FDMSDebit1.Card.MagneticStripe = "9876543210012341234=12041200000001"; // (pin 1234) FDMSDebit1.EncryptedPIN = "0082943935BA205D"; FDMSDebit1.KSN = "8765432109003000012"; FDMSDebit1.ReceiptNumber = "123456"; FDMSDebit1.Sale(); If the transaction is successful, the ResponseApprovalCode will start with "AP", and the ResponseCaptureFlag will be true. Even though debit transactions are on-line transactions, it is still necessary to settle them with First Data. The following example shows how to send a simple settlement. The first thing to do is to set up the FDMSSettle class's properties with the same information used for the debit sale: FDMSSettle1.MerchantNumber = FDMSDebit1.MerchantNumber; FDMSSettle1.MerchantTerminalNumber = FDMSDebit1.MerchantTerminalNumber; FDMSSettle1.DatawireId = FDMSDebit1.DatawireId; FDMSSettle1.URL = FDMSDebit1.URL; FDMSSettle1.MerchantServiceNumber = "8001234567"; FDMSSettle1.BatchSequenceNumber = "101"; FDMSSettle1.IndustryType = itRetail; Then all that needs to be done is add the detail record from the debit sale to the settlement component and call the SendSettlement method. FDMSSettle1.DetailRecords.Add(new FDMSRecordType(FDMSDebit1.GetDetailAggregate()); FDMSSettle1.SendSettlement(); Note that in a live system you would store detail records in a database and send multiple records in a single batch at the end of the business day.

MerchantFNSNumber Property (FDMSBenefit Module)

Government-issued number identifying a food-stamp-participating merchant location.

Syntax

• Swift
• Objective-C

public var merchantFNSNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantFNSNumber,setter=setMerchantFNSNumber:) NSString* merchantFNSNumber;

- (NSString*)merchantFNSNumber;
- (void)setMerchantFNSNumber :(NSString*)newMerchantFNSNumber;

Default Value

""

Remarks

The United States Department of Agriculture, Food and Nutrition Service (FNS) must authorize merchants who wish to accept food stamps. A merchant applies directly to this agency. If the necessary requirements are met, the merchant is issued a certificate with a seven-digit number for each participating merchant location. This number, referred to as the FNS number, uniquely identifies the merchant location to the state EBT processor system. In the FDMS system, this number must be set up in the Cross-Reference File (XREF) under usage indicator I. The number is pulled from the XREF file and inserted into each transaction request before the request is passed on from the front end. This number is used only for Food Stamp transactions

If this number is not supplied, FDMS will attempt to obtain it from a Merchant Control File in their system.

MerchantNumber Property (FDMSBenefit Module)

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

Syntax

• Swift
• Objective-C

public var merchantNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantNumber,setter=setMerchantNumber:) NSString* merchantNumber;

- (NSString*)merchantNumber;
- (void)setMerchantNumber :(NSString*)newMerchantNumber;

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.

MerchantTerminalNumber Property (FDMSBenefit Module)

Used to identify a unique terminal within a merchant location.

Syntax

• Swift
• Objective-C

public var merchantTerminalNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantTerminalNumber,setter=setMerchantTerminalNumber:) NSString* merchantTerminalNumber;

- (NSString*)merchantTerminalNumber;
- (void)setMerchantTerminalNumber :(NSString*)newMerchantTerminalNumber;

Default Value

""

Remarks

This property contains a number (typically 6 digits) assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber and DatawireId as connection credentials.

Proxy Property (FDMSBenefit Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

ReceiptNumber Property (FDMSBenefit Module)

Merchant generated number used to identify the transaction.

Syntax

• Swift
• Objective-C

public var receiptNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=receiptNumber,setter=setReceiptNumber:) NSString* receiptNumber;

- (NSString*)receiptNumber;
- (void)setReceiptNumber :(NSString*)newReceiptNumber;

Default Value

""

Remarks

This property is required for Debit transaction clearing, and should contain a unique 6-digit trace number identifying the transaction. The merchant application should generate a unique number for each Debit or EBT transaction. If a Debit or EBT transaction is voided or reversed, the ReceiptNumber of the original transaction should be used. The receipt number must be passed to the FDMS Host on both the Debit/EBT authorization request and the batch settlement detail. It must also be printed on the customer receipt. Used such, this number satisfies Debit Network Provider requirements.

Response Property (FDMSBenefit Module)

Contains the response to an EBT transaction.

Syntax

• Swift
• Objective-C

public var response: FDMSBenefitResponse {
  get {...}
}

@property (nonatomic,readonly,assign,getter=responseApprovalCode) NSString* responseApprovalCode;

- (NSString*)responseApprovalCode;

@property (nonatomic,readonly,assign,getter=responseAvailableBalance) NSString* responseAvailableBalance;

- (NSString*)responseAvailableBalance;

@property (nonatomic,readonly,assign,getter=responseBeginningBalance) NSString* responseBeginningBalance;

- (NSString*)responseBeginningBalance;

@property (nonatomic,readonly,assign,getter=responseCaptureFlag) BOOL responseCaptureFlag;

- (BOOL)responseCaptureFlag;

@property (nonatomic,readonly,assign,getter=responseCashAvailableBalance) NSString* responseCashAvailableBalance;

- (NSString*)responseCashAvailableBalance;

@property (nonatomic,readonly,assign,getter=responseCashBeginningBalance) NSString* responseCashBeginningBalance;

- (NSString*)responseCashBeginningBalance;

@property (nonatomic,readonly,assign,getter=responseCashEndingBalance) NSString* responseCashEndingBalance;

- (NSString*)responseCashEndingBalance;

@property (nonatomic,readonly,assign,getter=responseDatawireReturnCode) NSString* responseDatawireReturnCode;

- (NSString*)responseDatawireReturnCode;

@property (nonatomic,readonly,assign,getter=responseDatawireStatus) NSString* responseDatawireStatus;

- (NSString*)responseDatawireStatus;

@property (nonatomic,readonly,assign,getter=responseEndingBalance) NSString* responseEndingBalance;

- (NSString*)responseEndingBalance;

@property (nonatomic,readonly,assign,getter=responseTransactionDate) NSString* responseTransactionDate;

- (NSString*)responseTransactionDate;

 

Default Value

""

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 FDMSBenefitResponse type contains the following fields:

SSLAcceptServerCertEncoded Property (FDMSBenefit Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (FDMSBenefit Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (FDMSBenefit Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

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

SSLCertStorePassword Property (FDMSBenefit Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (FDMSBenefit Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: FdmsbenefitSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum FdmsbenefitSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

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:

SSLCertSubject Property (FDMSBenefit Module)

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

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (FDMSBenefit Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: FdmsbenefitSSLProviders {
  get {...}
  set {...}
}

public enum FdmsbenefitSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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 the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (FDMSBenefit Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (FDMSBenefit Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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

TransactionAmount Property (FDMSBenefit Module)

Purchase amount to be authorized.

Syntax

• Swift
• Objective-C

public var transactionAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transactionAmount,setter=setTransactionAmount:) NSString* transactionAmount;

- (NSString*)transactionAmount;
- (void)setTransactionAmount :(NSString*)newTransactionAmount;

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.

TransactionNumber Property (FDMSBenefit Module)

Uniquely identifies the transaction.

Syntax

• Swift
• Objective-C

public var transactionNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transactionNumber,setter=setTransactionNumber:) NSString* transactionNumber;

- (NSString*)transactionNumber;
- (void)setTransactionNumber :(NSString*)newTransactionNumber;

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.

URL Property (FDMSBenefit Module)

Location of the Datawire server to which transactions are sent.

Syntax

• Swift
• Objective-C

public var url: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL;

- (NSString*)URL;
- (void)setURL :(NSString*)newURL;

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.

VoucherAuthCode Property (FDMSBenefit Module)

Used to clear (force) a food stamp voucher that was previously voice-authorized.

Syntax

• Swift
• Objective-C

public var voucherAuthCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=voucherAuthCode,setter=setVoucherAuthCode:) NSString* voucherAuthCode;

- (NSString*)voucherAuthCode;
- (void)setVoucherAuthCode :(NSString*)newVoucherAuthCode;

Default Value

""

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by FDMS or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear, just send a normal Sale or Credit transaction with the VoucherAuthCode and VoucherNumber properties set.

Note that only food stamp transactions may be voice-authorized, attempting to send a VoucherAuthCode or VoucherNumber in a Sale transaction when the BenefitType is set to Cash Benefits will result in an error.

VoucherNumber Property (FDMSBenefit Module)

Used to clear (force) a food stamp voucher that was previously voice-authorized.

Syntax

• Swift
• Objective-C

public var voucherNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=voucherNumber,setter=setVoucherNumber:) NSString* voucherNumber;

- (NSString*)voucherNumber;
- (void)setVoucherNumber :(NSString*)newVoucherNumber;

Default Value

""

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by FDMS or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear, just send a normal Sale or Credit transaction with the VoucherAuthCode and VoucherNumber properties set.

Note that only food stamp transactions may be voice-authorized, attempting to send a VoucherAuthCode or VoucherNumber in a Sale transaction when the BenefitType is set to Cash Benefits will result in an error.

BalanceInquiry Method (FDMSBenefit Module)

Retrieves the current balances of Food Stamp and Cash Benefit accounts on an EBT card.

Syntax

• Swift
• Objective-C

public func balanceInquiry() throws -> Void

- (void)balanceInquiry;

Remarks

A BalanceInquiry transaction requests that FDMS return the amount of funds remaining on the customer's EBT Card. No charge is made to the customer's card. The balance results from a balance inquiry on a Food Stamps card will be returned in ResponseBeginningBalance, ResponseAvailableBalance, and ResponseEndingBalance. The balance results from an inquiry on a Cash Benefits card will be returned in ResponseCashBeginningBalance, ResponseCashAvailableBalance, and ResponseCashEndingBalance. For a card that accesses both Food Stamp and Cash Benefit accounts, all six balances may be returned.

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

CashWithdrawal Method (FDMSBenefit Module)

Withdraws cash from a cash benefits account.

Syntax

• Swift
• Objective-C

public func cashWithdrawal() throws -> Void

- (void)cashWithdrawal;

Remarks

This method is used when a customer wishes to withdraw funds from his cash benefit account. This is called a "Cash Only" transaction. There is no item purchased, and the TransactionAmount the customer may withdraw is not to be limited. The customer is permitted to access the remaining available balance in the account. Track2 and PIN entry are required.

This method is only for use with the Cash Benefits BenefitType.

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

Config Method (FDMSBenefit Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Credit Method (FDMSBenefit Module)

Submits a food stamp credit transaction, returning funds to an EBT card.

Syntax

• Swift
• Objective-C

public func credit() throws -> Void

- (void)credit;

Remarks

EBT credit (return) transactions are similar to debit credits in that they are real-time -- Funds are immediately added back to the customer's food stamp account, instead of the funds transfer taking place several days after settlement. EBT credits may use track2 data read from the card's magnetic stripe, or be manually keyed. Track1 data is not acceptable. The customer is required to enter enter his PIN number into a certified PIN Pad device, and both an EncryptedPIN and KSN (Key Sequence Number) are returned from the pad to the merchant, and must be submitted in the Credit/Return transaction.

Note that credits are only supported for the food stamp BenefitType. Attempting to send a Credit when the BenefitType is set to Cash Benefits will result in an error.

Even though debit transactions are real-time, FDMS requires they be settled at the end of the day just like credit card transactions.

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

GetDetailAggregate Method (FDMSBenefit Module)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

• Swift
• Objective-C

public func getDetailAggregate() throws -> String

- (NSString*)getDetailAggregate;

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseCaptureFlag is false) the method .

An example of how this method is used is shown below:

FDMSRetail.AuthorizeTrack1() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1 FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate() End If

Interrupt Method (FDMSBenefit Module)

Interrupts the current action.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (FDMSBenefit Module)

Clears all properties to their default values.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

ReverseLastTransaction Method (FDMSBenefit Module)

Used to reverse/void a previous transaction.

Syntax

• Swift
• Objective-C

public func reverseLastTransaction() throws -> Void

- (void)reverseLastTransaction;

Remarks

This method is used to reverse a previous transaction in the case a response was not received from the host or to void a previous Sale or Credit transaction.

A Timeout Reversal is needed when a terminal initiates a debit transaction (Sale or Credit) to the FDMS host, but the host fails to send a response back to the terminal for any reason. If a transaction times out or you receive a network connectivity error, you should immediately call ReverseLastTransaction. In this situation you don't know whether the host received the request and the response back to you was lost, or if the host ever received the request at all. Therefore the ReverseLastTransaction method can used to reverse the last transaction sent by this class. You must not change any properties or call any other methods (including Reset), as ReverseLastTransaction operates based on the current state of the class.

First Data will always send an ResponseApprovalCode of "AP888888" or "AP868686" on a reversal response, and the ResponseCaptureFlag value will be False. First Data does not check whether the original transaction occurred or not.

If you do not receive a response to the reversal (eg, it also times out), you must continue to call ReverseLastTransaction until you do receive a response.

Note: A Debit Reversal must not be used by the merchant as a way to credit a customer for returned merchandise.

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

Sale Method (FDMSBenefit Module)

Submits a sale transaction for an Electronic Benefits (EBT) card.

Syntax

• Swift
• Objective-C

public func sale() throws -> Void

- (void)sale;

Remarks

EBT sale are similar to Debit card transactions in that they are real-time and require an EncryptedPIN and KSN. EBT cards are connected to either a Food Stamp account or a Cash Benefit account, or both. Like debit transactions, EBT transactions also must use track2 data read from the card's magnetic stripe - Track1 data is not acceptable. Food stamp transactions MAY be manually keyed, but cash benefit transactions may NOT be manually keyed. The BenefitType property indicates whether the sale acts on a Food Stamp or Cash Benefit account.

Even though EBT transactions are real-time, FDMS requires they be settled at the end of the day just like credit card transactions.

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

Connected Event (FDMSBenefit Module)

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

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

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 (FDMSBenefit Module)

Fired when receiving a data packet from the transaction server.

Syntax

• Swift
• Objective-C

func onDataPacketIn(dataPacket: Data)

- (void)onDataPacketIn:(NSData*)dataPacket;

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 (FDMSBenefit Module)

Fired when sending a data packet to the transaction server.

Syntax

• Swift
• Objective-C

func onDataPacketOut(dataPacket: Data)

- (void)onDataPacketOut:(NSData*)dataPacket;

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 (FDMSBenefit Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

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 (FDMSBenefit Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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 (FDMSBenefit Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

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

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

SSLStatus Event (FDMSBenefit Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

Status Event (FDMSBenefit Module)

Shows the progress of the FDMS/Datawire connection.

Syntax

• Swift
• Objective-C

func onStatus(message: String)

- (void)onStatus:(NSString*)message;

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.

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 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 to indicate which track is stored in the field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor 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 , , and fields, and must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the to edsManualEntryNoCardReader. If you wish to set any other value for the , you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of . If you set the , , and fields, but is set to edsTrack2, the class will look for data when authorizing the transaction, and will because none is present.

Fields

Constructors

public init()

public init(number: , expMonth: , expYear: )

public init(magneticStripe: , entryDataSource: )

FDMSBenefitResponse Type

Contains the response to the EBT transaction..

Remarks

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

Fields

Constructors

public init()

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

Config Settings (FDMSBenefit Module)

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 (FDMSBenefit Module)

FDMSBenefit Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors