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.

Class Name

DPaymentsSDK_FDMSReversal

Procedural Interface

 dpaymentssdk_fdmsreversal_open();
 dpaymentssdk_fdmsreversal_close($res);
 dpaymentssdk_fdmsreversal_register_callback($res, $id, $function);
 dpaymentssdk_fdmsreversal_get_last_error($res);
 dpaymentssdk_fdmsreversal_get_last_error_code($res);
 dpaymentssdk_fdmsreversal_set($res, $id, $index, $value);
 dpaymentssdk_fdmsreversal_get($res, $id, $index);
 dpaymentssdk_fdmsreversal_do_config($res, $configurationstring);
 dpaymentssdk_fdmsreversal_do_interrupt($res);
 dpaymentssdk_fdmsreversal_do_reset($res);
 dpaymentssdk_fdmsreversal_do_reverse($res);

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 ResponseApprovalCode 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 ResponseApprovalCode that begins with "AP" (APproved). A partial authorization has a ResponseApprovalCode that begins with "AL" (Approved for a Lesser amount).

Upon a successful reversal, the ResponseApprovalCode property 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 ResponseApprovalCode 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 ResponseCaptureFlag 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 (DPaymentsSDK_FDMSReversal Class)

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();


public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 1 );


dpaymentssdk_fdmsreversal_set($res, 1, $value );

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.

Data Type

String

ApprovalCode Property (DPaymentsSDK_FDMSReversal Class)

Approval code of the transaction to be reversed.

Object Oriented Interface

public function getApprovalCode();


public function setApprovalCode($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 2 );


dpaymentssdk_fdmsreversal_set($res, 2, $value );

Default Value

''

Remarks

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

Data Type

String

AuthorizedAmount Property (DPaymentsSDK_FDMSReversal Class)

Authorized Amount from the original response.

Object Oriented Interface

public function getAuthorizedAmount();


public function setAuthorizedAmount($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 3 );


dpaymentssdk_fdmsreversal_set($res, 3, $value );

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

Data Type

String

CardType Property (DPaymentsSDK_FDMSReversal Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 4 );


dpaymentssdk_fdmsreversal_set($res, 4, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_FDMSReversal Class)

Three digit security code on back of card (optional).

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 5 );


dpaymentssdk_fdmsreversal_set($res, 5, $value );

Default Value

''

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_FDMSReversal Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 6 );


dpaymentssdk_fdmsreversal_set($res, 6, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_FDMSReversal Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 7 );


dpaymentssdk_fdmsreversal_set($res, 7, $value );

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_FDMSReversal Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 8 );


dpaymentssdk_fdmsreversal_set($res, 8, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_FDMSReversal Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 9 );


dpaymentssdk_fdmsreversal_set($res, 9, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_FDMSReversal Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface

public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 10 );


dpaymentssdk_fdmsreversal_set($res, 10, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_FDMSReversal Class)

Track data read off of the card's magnetic stripe.

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 11 );


dpaymentssdk_fdmsreversal_set($res, 11, $value );

Default Value

''

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_FDMSReversal Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 12 );


dpaymentssdk_fdmsreversal_set($res, 12, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSReversal Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();


public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 13 );


dpaymentssdk_fdmsreversal_set($res, 13, $value );

Default Value

''

Remarks

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

The maximum length for this property is 32 characters.

Data Type

String

DirectMarketingType Property (DPaymentsSDK_FDMSReversal Class)

Specifies the type of direct marketing transaction to reverse.

Object Oriented Interface

public function getDirectMarketingType();


public function setDirectMarketingType($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 14 );


dpaymentssdk_fdmsreversal_set($res, 14, $value );

Default Value

0

Remarks

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

Data Type

Integer

FDMSPlatform Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getFDMSPlatform();


public function setFDMSPlatform($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 15 );


dpaymentssdk_fdmsreversal_set($res, 15, $value );

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.

Data Type

Integer

HealthCare Property (DPaymentsSDK_FDMSReversal Class)

Indicates whether this is a healthcare auto-substantiation reversal.

Object Oriented Interface

public function getHealthCare();


public function setHealthCare($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 16 );


dpaymentssdk_fdmsreversal_set($res, 16, $value );

Default Value

false

Remarks

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

Data Type

Boolean

IndustryType Property (DPaymentsSDK_FDMSReversal Class)

Code which indicates the industry the merchant is engaged in.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 17 );


dpaymentssdk_fdmsreversal_set($res, 17, $value );

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.

Data Type

Integer

MerchantNumber Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getMerchantNumber();


public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 18 );


dpaymentssdk_fdmsreversal_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_FDMSReversal Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();


public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 19 );


dpaymentssdk_fdmsreversal_set($res, 19, $value );

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.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 20 );


dpaymentssdk_fdmsreversal_set($res, 20, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 21 );


dpaymentssdk_fdmsreversal_set($res, 21, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 22 );


dpaymentssdk_fdmsreversal_set($res, 22, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 23 );


dpaymentssdk_fdmsreversal_set($res, 23, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 24 );


dpaymentssdk_fdmsreversal_set($res, 24, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 25 );


dpaymentssdk_fdmsreversal_set($res, 25, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 26 );


dpaymentssdk_fdmsreversal_set($res, 26, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_FDMSReversal Class)

Contains an authorization code when a transaction has been approved, or an error message if declined.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 27 );

Default Value

''

Remarks

Contains an authorization code when a transaction has been approved, or an error message if declined.

This property contains an authorization code when a transaction has been approved. The code will begin with "AP" and will be 8 characters in length. If the transaction was partially approved, it will begin with "AL" (approved for lesser amount), and the actual amount approved will be contained in the ResponseAuthorizedAmount property. If the transaction was declined ResponseApprovalCode will contain one of the response messages listed in the table below:

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_FDMSReversal Class)

When supporting partial authorizations, this is the amount actually charged to the credit card.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 28 );

Default Value

''

Remarks

When supporting partial authorizations, this is the amount actually charged to the credit card.

This is only used when supporting partial authorizations (currently only supported for healthcare transactions). If the ResponseApprovalCode begins with "AL" this property will contain the amount actually charged to the credit card. This will be less than the original TransactionAmount. You must collect the remainder via another form of payment, or Reverse the authorization if the customer does not have an additional form of payment.

This property is read-only.

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_FDMSReversal Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 29 );

Default Value

''

Remarks

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below.

Valid AVS Codes:

If supporting international transactions, four additional International Address Verification Service (IAVS) codes are introduced:

This property is read-only.

Data Type

String

ResponseBalance Property (DPaymentsSDK_FDMSReversal Class)

Contains the remaining available balance left on the card.

Object Oriented Interface

public function getResponseBalance();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 30 );

Default Value

''

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

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

Data Type

String

ResponseCaptureFlag Property (DPaymentsSDK_FDMSReversal Class)

Indicates whether the authorization was successful, and whether it can be settled.

Object Oriented Interface

public function getResponseCaptureFlag();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 31 );

Default Value

false

Remarks

Indicates whether the authorization was successful, and whether it can be settled.

After an authorization request, the ResponseCaptureFlag will be set to True if the request was successfully processed. This indicates that you may send the transaction on for batch settlement using the FDMSSettle class. If this property is False you should consider the transaction as Declined, and it may not be settled.

This property is read-only.

Data Type

Boolean

ResponseCardLevelResult Property (DPaymentsSDK_FDMSReversal Class)

Two character card level results property returned in the response to Visa authorizations.

Object Oriented Interface

public function getResponseCardLevelResult();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 32 );

Default Value

''

Remarks

Two character card level results field returned in the response to Visa authorizations.

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

Data Type

String

ResponseCommercialCard Property (DPaymentsSDK_FDMSReversal Class)

Indicates whether the credit card charged is a corporate commercial card.

Object Oriented Interface

public function getResponseCommercialCard();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 33 );

Default Value

0

Remarks

Indicates whether the credit card charged is a corporate commercial card.

Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data in the settlement when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Commercial card transactions settled with Level 2 or Level 3 data must include tax amounts to receive the best interchange rate.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (DPaymentsSDK_FDMSReversal Class)

Contains the returned CVV result code (if CVV data was sent in the request).

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 34 );

Default Value

''

Remarks

Contains the returned CVV result code (if CVV data was sent in the request).

If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (DPaymentsSDK_FDMSReversal Class)

Contains an error code providing more details about the DatawireStatus received.

Object Oriented Interface

public function getResponseDatawireReturnCode();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 35 );

Default Value

''

Remarks

Contains an error code providing more details about the ResponseDatawireStatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contain the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (DPaymentsSDK_FDMSReversal Class)

Status of the communication with Datawire.

Object Oriented Interface

public function getResponseDatawireStatus();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 36 );

Default Value

''

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

ResponseReturnedACI Property (DPaymentsSDK_FDMSReversal Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 37 );

Default Value

''

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the ResponseTransactionId or ResponseValidationCode fields.

The following is a list of all returned ACI values. Please note that many of these return values result from features not available in any of the currently supported Industry Types.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (DPaymentsSDK_FDMSReversal Class)

Local transaction date returned from the server in MMDDYY format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 38 );

Default Value

''

Remarks

Local transaction date returned from the server in MMDDYY format.

This six digit field contains a local transaction date calculated by the authorization center. This field should be recorded and submitted in the Batch Settlement.

This property is read-only.

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_FDMSReversal Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 39 );

Default Value

''

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

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

Data Type

String

ResponseValidationCode Property (DPaymentsSDK_FDMSReversal Class)

Additional information generated by the card issuer.

Object Oriented Interface

public function getResponseValidationCode();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 40 );

Default Value

''

Remarks

Additional information generated by the card issuer.

This four character field may contain specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.

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

Data Type

String

ReturnedACI Property (DPaymentsSDK_FDMSReversal Class)

Returned ACI from the original response.

Object Oriented Interface

public function getReturnedACI();


public function setReturnedACI($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 41 );


dpaymentssdk_fdmsreversal_set($res, 41, $value );

Default Value

''

Remarks

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

Data Type

String

SettlementAmount Property (DPaymentsSDK_FDMSReversal Class)

New settlement amount after the reversal.

Object Oriented Interface

public function getSettlementAmount();


public function setSettlementAmount($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 42 );


dpaymentssdk_fdmsreversal_set($res, 42, $value );

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSReversal Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 44 );


dpaymentssdk_fdmsreversal_set($res, 44, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_FDMSReversal Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 72 );


dpaymentssdk_fdmsreversal_set($res, 72, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 88 );


dpaymentssdk_fdmsreversal_set($res, 88, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 89 );


dpaymentssdk_fdmsreversal_set($res, 89, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_FDMSReversal Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 90 );


dpaymentssdk_fdmsreversal_set($res, 90, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 91 );


dpaymentssdk_fdmsreversal_set($res, 91, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DPaymentsSDK_FDMSReversal Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 99 );


dpaymentssdk_fdmsreversal_set($res, 99, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_FDMSReversal Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 101 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DPaymentsSDK_FDMSReversal Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 128 );


dpaymentssdk_fdmsreversal_set($res, 128, $value );

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionId Property (DPaymentsSDK_FDMSReversal Class)

Transaction Id from the original response.

Object Oriented Interface

public function getTransactionId();


public function setTransactionId($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 129 );


dpaymentssdk_fdmsreversal_set($res, 129, $value );

Default Value

''

Remarks

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

Data Type

String

TransactionNumber Property (DPaymentsSDK_FDMSReversal Class)

Uniquely identifies the transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 130 );


dpaymentssdk_fdmsreversal_set($res, 130, $value );

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

URL Property (DPaymentsSDK_FDMSReversal Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 131 );


dpaymentssdk_fdmsreversal_set($res, 131, $value );

Default Value

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

Remarks

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

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

Data Type

String

ValidationCode Property (DPaymentsSDK_FDMSReversal Class)

Validation Code from the original response.

Object Oriented Interface

public function getValidationCode();


public function setValidationCode($value);

Procedural Interface

dpaymentssdk_fdmsreversal_get($res, 132 );


dpaymentssdk_fdmsreversal_set($res, 132, $value );

Default Value

''

Remarks

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

Data Type

String

Config Method (DPaymentsSDK_FDMSReversal Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmsreversal_do_config($res, $configurationstring);

Remarks

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

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

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

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

Interrupt Method (DPaymentsSDK_FDMSReversal Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmsreversal_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_FDMSReversal Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsreversal_do_reset($res);

Remarks

This method clears all properties to their default values.

Reverse Method (DPaymentsSDK_FDMSReversal Class)

Reverses a credit card transaction.

Object Oriented Interface

public function doReverse();

Procedural Interface

dpaymentssdk_fdmsreversal_do_reverse($res);

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 ResponseApprovalCode 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 ResponseApprovalCode that begins with "AP" (APproved). A partial authorization has a ResponseApprovalCode that begins with "AL" (Approved for a Lesser amount).

Upon a successful reversal, the ResponseApprovalCode property 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 ResponseApprovalCode 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 ResponseCaptureFlag 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 (DPaymentsSDK_FDMSReversal Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 '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 (DPaymentsSDK_FDMSReversal Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 2, array($this, 'fireDataPacketIn'));

Parameter List

 '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 (DPaymentsSDK_FDMSReversal Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 3, array($this, 'fireDataPacketOut'));

Parameter List

 '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 (DPaymentsSDK_FDMSReversal Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 '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 (DPaymentsSDK_FDMSReversal Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 '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 (DPaymentsSDK_FDMSReversal Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_FDMSReversal Class)

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_fdmsreversal_register_callback($res, 8, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

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

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

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors