FDMSResponse Type
Contains the response to the authorization.
Remarks
This type contains the results of a transaction made with the FDMSECommerce or FDMSRetail component. The fields contained by this type are listed below.
Fields
ApprovalCode String |
Contains an authorization code when a transaction has been approved, or an error message if declined. This field 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 AuthorizedAmount field. If the transaction was declined ApprovalCode will contain one of the response messages listed in the table below:
| ||||||||||||||||||||||||||||||||||||||||||
AuthorizedAmount String |
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 ApprovalCode begins with "AL" this field 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. | ||||||||||||||||||||||||||||||||||||||||||
AVSResult String |
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, six additional International Address Verification Service (IAVS) codes are introduced:
| ||||||||||||||||||||||||||||||||||||||||||
Balance String |
Contains the remaining available balance left on the card. This balance amount will only be returned for prepaid cards. | ||||||||||||||||||||||||||||||||||||||||||
CaptureFlag Boolean |
Indicates whether the authorization was successful, and whether it can be settled. After an authorization request, the CaptureFlag 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 component. If this field is False you should consider the transaction as Declined, and it may not be settled. | ||||||||||||||||||||||||||||||||||||||||||
CardLevelResult String |
Two character card level results field returned in the response to Visa authorizations. | ||||||||||||||||||||||||||||||||||||||||||
CommercialCard FDMSCommercialCards |
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. | ||||||||||||||||||||||||||||||||||||||||||
CVVResult String |
Contains the returned CVV result code (if CVV data was sent in the request). If a CVV value was sent in the authorization, this field will contain the host returned Card Verification Value result code. The following is a list of current result codes:
| ||||||||||||||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||||||||||||||
ReturnedACI String |
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 TransactionId or ValidationCode 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.
| ||||||||||||||||||||||||||||||||||||||||||
TransactionDate String |
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. | ||||||||||||||||||||||||||||||||||||||||||
TransactionId String |
Contains the Visa Transaction Identifier or MasterCard Reference Number. This 15-character field contains a Visa transaction identifier or MasterCard reference number. 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. | ||||||||||||||||||||||||||||||||||||||||||
ValidationCode String |
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. |
Constructors
[VB.NET] Public FDMSResponse() [C#] public FDMSResponse();