FDMSReversal Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSREVERSAL class is used to reverse a transaction that was previously authorized using the FDMSRETAIL , FDMSECOMMERCE , or FDMSHEALTHCARE class. This immediately releases the funds in the cardholder's open-to-buy that were blocked by the original authorization.

Syntax

dpaymentssdk.Fdmsreversal

Remarks

Unlike the Timeout Reversals used in the FDMSDebit and FDMSBenefit classs, a credit card reversal is used to void a transaction and return funds to the customer. Often this is used in a split-tender situation, where a customer uses a prepaid Visa or MasterCard (or health care FSA card) to make a purchase which is partially authorized for less than the transaction amount. Partially authorized transactions will have an ApprovalCode that beings with "AL" instead of "AP". If the customer does not have an additional source of funds to make up the difference, the authorization must be reversed and the funds immediately returned to the customer's card. To do this, set the AuthorizedAmount to the Response.AuthorizedAmount from the original transaction, and set the SettlementAmount to "0". This is called a full reversal (in this case, of a partially authorized transaction), and the detail record for the original transaction should be discarded - it must not be settled at the end of the day.

Alternatively, a merchant may need to settle a transaction amount for less than was originally authorized. In this case, set the AuthorizedAmount to the original TransactionAmount, and set the SettlementAmount to the new amount you wish to settle for. After a successful reversal, use the FDMSDetailRecord class to update the SettlementAmount of the detail record for the original transaction with the new amount. This is called a partial reversal. You may also submit a full reversal by setting the SettlementAmount to "0". In that case, all of the funds are returned to the customer and the detail record for the original transaction should be discarded.

Note that partial authorizations must be fully reversed. You cannot partially reverse a partial authorization. Normally authorized transactions can be either partially or fully reversed. A normal authorization has a ApprovalCode that begins with "AP" (APproved). A partial authorization has a ApprovalCode that begins with "AL" (Approved for a Lesser amount).

Upon a successful reversal, the ApprovalCode field will contain either "AP888888" or "AP868686" indicating the reversal was accepted. This code does not indicate the original transaction was found and reversed, merely that the reversal was received and properly formatted. First Data does not actually check whether the original transaction occurred or not. If the transaction was declined ApprovalCode will contain one of the response messages listed in the table below:

Note that partially authorized transactions cannot be partially reversed, they must be fully reversed. For instance, say a customer uses a prepaid visa card to buy $100 worth of merchandise, but his card only has a $50 balance. If the customer does not have an additional form of tender, (cash, check, credit, etc), the $50 that was partially authorized must be reversed and returned to the card. First Data does not support any scenario where a partially authorized transaction may be reversed for less than the full amount.

To reiterate, when a transaction is fully reversed, it must be removed from the batch settlement entirely. A partially reversed transaction must update the SettlementAmount of the original detail record, using the FDMSDetailRecord class. Reversal transactions themselves may not be settled, even if the CaptureFlag is True.

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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ApplicationId Property (FDMSReversal Class)

Identifies the merchant application to the Datawire System.

Syntax

public String getApplicationId();


public void setApplicationId(String applicationId);

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.

ApprovalCode Property (FDMSReversal Class)

Approval code of the transaction to be reversed.

Syntax

public String getApprovalCode();


public void setApprovalCode(String approvalCode);

Default Value

""

Remarks

This property should be set with the Response.ApprovalCode from the transaction you wish to reverse.

AuthorizedAmount Property (FDMSReversal Class)

Authorized Amount from the original response.

Syntax

public String getAuthorizedAmount();


public void setAuthorizedAmount(String authorizedAmount);

Default Value

""

Remarks

This property should be set with the actual authorized amount from the transaction you wish to reverse. If the transaction was partially authorized (Response.AuthorizedAmount was present in the response, and different than the original TransactionAmount), then this property should be set to the AuthorizedAmount returned in the original response. Otherwise it should be set to the original TransactionAmount.

If the original transaction was partially authorized, you cannot do a partial reversal. Partially authorized transactions must be fully reversed (meaning SettlementAmount must be set to "0").

In the case of reversing a transaction containing incremental authorizations, this property should be set to the first (initial) authorization amount. The TotalAuthorizedAmount config should then be set to the total authorization amount (first authorization plus all incremental authorizations).

Card Property (FDMSReversal Class)

Contains the customer's credit card information.

Syntax

public CCCard getCard();


public void setCard(CCCard card);

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.

DatawireId Property (FDMSReversal Class)

Identifies the merchant to the Datawire System.

Syntax

public String getDatawireId();


public void setDatawireId(String datawireId);

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.

DirectMarketingType Property (FDMSReversal Class)

Specifies the type of direct marketing transaction to reverse.

Syntax

public int getDirectMarketingType();


public void setDirectMarketingType(int directMarketingType);


Enumerated values:
  public final static int dmECommerce = 0;
  public final static int dmMOTO = 1;
  public final static int dmRecurring = 2;
  public final static int dmInstallment = 3;

Default Value

0

Remarks

The following types of direct marketing transactions are reversable by this class:

FDMSPlatform Property (FDMSReversal Class)

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

Syntax

public int getFDMSPlatform();


public void setFDMSPlatform(int FDMSPlatform);


Enumerated values:
  public final static int fpNorth = 0;
  public final static int fpNashville = 1;

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.

HealthCare Property (FDMSReversal Class)

Indicates whether this is a healthcare auto-substantiation reversal.

Syntax

public boolean isHealthCare();


public void setHealthCare(boolean healthCare);

Default Value

False

Remarks

Set this property to True in order to reverse FSA transactions made with the FDMSHealthCare class.

IndustryType Property (FDMSReversal Class)

Code which indicates the industry the merchant is engaged in.

Syntax

public int getIndustryType();


public void setIndustryType(int industryType);


Enumerated values:
  public final static int fitUnknown = 0;
  public final static int fitRetail = 1;
  public final static int fitRestaurant = 2;
  public final static int fitGroceryStore = 3;
  public final static int fitDirectMarketing = 4;
  public final static int fitHotel = 5;

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

MerchantNumber Property (FDMSReversal Class)

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

Syntax

public String getMerchantNumber();


public void setMerchantNumber(String merchantNumber);

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

Used to identify a unique terminal within a merchant location.

Syntax

public String getMerchantTerminalNumber();


public void setMerchantTerminalNumber(String merchantTerminalNumber);

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

A set of properties related to proxy access.

Syntax

public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

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

Response Property (FDMSReversal Class)

Contains the response to an authorization request.

Syntax

public FDMSResponse getResponse();

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

This property is read-only.

ReturnedACI Property (FDMSReversal Class)

Returned ACI from the original response.

Syntax

public String getReturnedACI();


public void setReturnedACI(String returnedACI);

Default Value

""

Remarks

This property should be set with the Response.ReturnedACI from the transaction you wish to reverse.

SettlementAmount Property (FDMSReversal Class)

New settlement amount after the reversal.

Syntax

public String getSettlementAmount();


public void setSettlementAmount(String settlementAmount);

Default Value

""

Remarks

To send a full reversal, the new SettlementAmount should be set to "0". The entire transaction will then be reversed, and the original transaction should not be settled with the FDMSSettle class. If you wish to reverse only part of the transaction (known as a "partial reversal"), simply set the SettlementAmount to the new total, minus reversal amount. For instance, if you have a $25 transaction and you wish to reverse $10 because one item was not in stock, set the AuthorizedAmount to "2500" and the SettlementAmount to "1500", and then call Reverse to do a partial reversal.

Note that partial reversals may not be performed on partially authorized transactions. If the ApprovalCode starts with "AL" and the Response.AuthorizedAmount from the original transaction was less than the original TransactionAmount, a full reversal must be performed with the SettlementAmount set to "0".

SSLAcceptServerCert Property (FDMSReversal Class)

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

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

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.

Please note that this functionality is provided only for cases where 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.

SSLCert Property (FDMSReversal Class)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

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.

SSLProvider Property (FDMSReversal Class)

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

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 is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (FDMSReversal Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (FDMSReversal Class)

A timeout for the class.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

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

TransactionId Property (FDMSReversal Class)

Transaction Id from the original response.

Syntax

public String getTransactionId();


public void setTransactionId(String transactionId);

Default Value

""

Remarks

This property should be set with the Response.TransactionId from the transaction you wish to reverse.

TransactionNumber Property (FDMSReversal Class)

Uniquely identifies the transaction.

Syntax

public String getTransactionNumber();


public void setTransactionNumber(String transactionNumber);

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

Location of the Datawire server to which transactions are sent.

Syntax

public String getURL();


public void setURL(String URL);

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.

ValidationCode Property (FDMSReversal Class)

Validation Code from the original response.

Syntax

public String getValidationCode();


public void setValidationCode(String validationCode);

Default Value

""

Remarks

This property should be set with the Response.ValidationCode from the transaction you wish to reverse.

Config Method (Fdmsreversal Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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.

Interrupt Method (Fdmsreversal Class)

Interrupts the current action.

Syntax

public void interrupt();

Remarks

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

Reset Method (Fdmsreversal Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

Reverse Method (Fdmsreversal Class)

Reverses a credit card transaction.

Syntax

public void reverse();

Remarks

Unlike the Timeout Reversals used in the FDMSDebit and FDMSBenefit classs, a credit card reversal is used to void a transaction and return funds to the customer. Often this is used in a split-tender situation, where a customer uses a prepaid Visa or MasterCard (or health care FSA card) to make a purchase which is partially authorized for less than the transaction amount. Partially authorized transactions will have an ApprovalCode that beings with "AL" instead of "AP". If the customer does not have an additional source of funds to make up the difference, the authorization must be reversed and the funds immediately returned to the customer's card. To do this, set the AuthorizedAmount to the Response.AuthorizedAmount from the original transaction, and set the SettlementAmount to "0". This is called a full reversal (in this case, of a partially authorized transaction), and the detail record for the original transaction should be discarded - it must not be settled at the end of the day.

Alternatively, a merchant may need to settle a transaction amount for less than was originally authorized. In this case, set the AuthorizedAmount to the original TransactionAmount, and set the SettlementAmount to the new amount you wish to settle for. After a successful reversal, use the FDMSDetailRecord class to update the SettlementAmount of the detail record for the original transaction with the new amount. This is called a partial reversal. You may also submit a full reversal by setting the SettlementAmount to "0". In that case, all of the funds are returned to the customer and the detail record for the original transaction should be discarded.

Note that partial authorizations must be fully reversed. You cannot partially reverse a partial authorization. Normally authorized transactions can be either partially or fully reversed. A normal authorization has a ApprovalCode that begins with "AP" (APproved). A partial authorization has a ApprovalCode that begins with "AL" (Approved for a Lesser amount).

Upon a successful reversal, the ApprovalCode field will contain either "AP888888" or "AP868686" indicating the reversal was accepted. This code does not indicate the original transaction was found and reversed, merely that the reversal was received and properly formatted. First Data does not actually check whether the original transaction occurred or not. If the transaction was declined ApprovalCode will contain one of the response messages listed in the table below:

Note that partially authorized transactions cannot be partially reversed, they must be fully reversed. For instance, say a customer uses a prepaid visa card to buy $100 worth of merchandise, but his card only has a $50 balance. If the customer does not have an additional form of tender, (cash, check, credit, etc), the $50 that was partially authorized must be reversed and returned to the card. First Data does not support any scenario where a partially authorized transaction may be reversed for less than the full amount.

To reiterate, when a transaction is fully reversed, it must be removed from the batch settlement entirely. A partially reversed transaction must update the SettlementAmount of the original detail record, using the FDMSDetailRecord class. Reversal transactions themselves may not be settled, even if the CaptureFlag is True.

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

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

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void connected(FdmsreversalConnectedEvent e) {}
  ...
}

public class FdmsreversalConnectedEvent {
  public int statusCode;
  public String 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 (Fdmsreversal Class)

Fired when receiving a data packet from the transaction server.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void dataPacketIn(FdmsreversalDataPacketInEvent e) {}
  ...
}

public class FdmsreversalDataPacketInEvent {
  public byte[] 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 (Fdmsreversal Class)

Fired when sending a data packet to the transaction server.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void dataPacketOut(FdmsreversalDataPacketOutEvent e) {}
  ...
}

public class FdmsreversalDataPacketOutEvent {
  public byte[] 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 (Fdmsreversal Class)

This event is fired when a connection is closed.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void disconnected(FdmsreversalDisconnectedEvent e) {}
  ...
}

public class FdmsreversalDisconnectedEvent {
  public int statusCode;
  public String 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 (Fdmsreversal Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void error(FdmsreversalErrorEvent e) {}
  ...
}

public class FdmsreversalErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

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

Fired after the server presents its certificate to the client.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void SSLServerAuthentication(FdmsreversalSSLServerAuthenticationEvent e) {}
  ...
}

public class FdmsreversalSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean 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 (Fdmsreversal Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void SSLStatus(FdmsreversalSSLStatusEvent e) {}
  ...
}

public class FdmsreversalSSLStatusEvent {
  public String message;
}

Remarks

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

Status Event (Fdmsreversal Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

public class DefaultFdmsreversalEventListener implements FdmsreversalEventListener {
  ...
  public void status(FdmsreversalStatusEvent e) {}
  ...
}

public class FdmsreversalStatusEvent {
  public String 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 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 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 Number, ExpMonth, and ExpYear fields, and EntryDataSource 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 EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, 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 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 throws an exception because none is present.

Fields

Constructors

public CCCard();

public CCCard( number,  expMonth,  expYear);

public CCCard( magneticStripe,  entryDataSource);

Certificate Type

This is the digital certificate being used.

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.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

FDMSResponse Type

Contains the response to the authorization.

Remarks

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

Fields

Constructors

public FDMSResponse();

Proxy Type

The proxy the class will connect to.

Remarks

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

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

Config Settings (Fdmsreversal Class)

FDMSReversal Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (Fdmsreversal Class)

FDMSReversal Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors