FDMSGiftResponse Type
Contains the response to a gift card transaction.
Remarks
This type contains the results of a transaction made with the FDMSGiftCard component. The fields contained by this type are listed below.
Fields
ApprovalCode String |
Contains an authorization code if the transaction has been approved. This field is returned in response to all approved gift card transactions, and will contain an authorization code used for tracking within the FDMS Closed Loop Gift Card System. Depending on the merchant's setup, this field will contain either 6 digit numeric or 8 character alphanumeric data for the approval code. If the transaction was declined this field will be empty. The contents of this field should not be used to determine the status of a transaction. The Code field will indicate whether the transaction was approved or declined. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CardClass String |
Identifies the class of the gift card used in the transaction. The First Data Closed Loop Gift Card database may contain a list of merchant-defined card classes. If using card classes, it is the merchant's responsibility to interpret the value of this field. A value of "0" indicates the card does not belong to any card class. Contact your First Data Closed Loop Gift Card representative if you wish to assign card classes to use in your solution. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CardExpDate String |
Contains the expiration date of the gift card. The account's expiration date is returned on approved transactions and on declined transactions that are declined due to the card being expired. The expiration date will be an 8-digit string in the format "MMDDYYYY". Accounts with no expiration date will return a year (YYYY) greater than 3000. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CashBack String |
Indicates the amount of cash to return to the customer. This field may be used at the point of sale to indicate the amount that needs to be tendered to a customer to remove the remaining balance from the card. It will bring the account balance to zero and close the account as defined by the merchant's configuration with First Data. For example, if $10.00 is remaining on a gift card and a purchase of $9.70 is made, the gift card system may put $.30 in this field. The response NewBalance will indicate that the card is now empty, and the merchant should give the $.30 change to the customer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Code String |
Indicates the status of the authorization request. This field will contain a two character response code indicating the status of the transaction request sent to the FDMS Closed Loop Gift Card system. The merchant must evaluate this response code and not the Text or ApprovalCode to determine the nature of a response message. A response code of "00" represents a successful transaction. All other response codes represent non-approved requests. All non-approved response codes should NOT be assumed to be "DECLINED" as an error condition may be present. A list of valid result codes is:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DatawireReturnCode String |
Contains an error code providing more details about the DatawireStatus received. When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". These two fields 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 field only indicates that the request reached FDMS, and that FDMS responded with some data. The CaptureFlag and ApprovalCode fields contain the actual transaction result that was returned by FDMS. The following is a list of possible Datawire return codes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DatawireStatus String |
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 DatawireStatus will be "OK" and the DatawireReturnCode will be "000". These two fields 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 field only indicates that the request reached FDMS, and that FDMS responded with some data. The CaptureFlag and ApprovalCode fields contains the actual FDMS Transaction Result that was returned. The following is a list of possible Datawire response status codes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LockAmount String |
Contains the amount that is locked and cannot be used. If the gift card has previously been locked via the LockCard method, this field will reflect the balance that is locked and cannot be used for purchases. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NewBalance String |
Contains the balance on the card reflected immediately after this transaction. This field contains the balance of funds left on the card after the transaction was applied. When redeeming a card with the RedeemCard method and RedemptionType set to rtPartialRedemption, the merchant must use the NewBalance and PreviousBalance fieldsto determine if full amount was authorized, or if an additional amount needs to be tendered by the customer. (via cash, credit, another gift card, etc). Note that NewBalance and PreviousBalance will display the same value in response to a call a Balance Inquiry or Lock Card transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PreviousBalance String |
Contains the balance that was on the gift card before this transaction was completed. This field contains the balance of funds that was on the card immediately before the transaction that was just authorized. When redeeming a card with the RedeemCard method and RedemptionType set to rtPartialRedemption, the merchant must use the NewBalance and PreviousBalance fieldsto determine if full amount was authorized, or if an additional amount needs to be tendered by the customer. (via cash, credit, another gift card, etc). Note that NewBalance and PreviousBalance will display the same value in response to a call a Balance Inquiry or Lock Card transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReferenceNumber String |
Contains the reference or customer number that was submitted in the request. If supported by your merchant setup, this field will contain a reference or customer number that will match the number submitted in the request. This can be used to match up responses with requests, or for other logging and reporting purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SystemTrace String |
Contains a number used to trace the transaction. This number is generated by the FDMS Closed Loop Gift Card system and should be logged and kept with the transaction for the duration of the transaction's life cycle. The merchant should not attempt to interpret the contents of this field. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Text String |
Contains a human-readable description of the response Code. This field will contain a description of the response code returned in the Code field. The Text field may be displayed to the sales clerk or customer to explain why the transaction was declined, but it should not be used by the merchant application to determine the success or failure of the transaction. To determine this status use the Code field instead. See the table of contents for a list of response codes and their meanings. |
Constructors
[VB.NET] Public FDMSGiftResponse() [C#] public FDMSGiftResponse();