FDMSOmahaResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the FDMSOmahaECommerce, FDMSOmahaRetail or FDMSOmahaRestaurant bean. The fields contained by this type are listed below.

Fields

AuthCode
String

The Authorization Code returned from the server after a successful transaction authorization.

Note: The value in this field is parsed from Text.

The value returned in this field is required to perform a Capture or when performing an AuthOnly VoidTransaction request.

AuthorizedAmount
String

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

This is only used when supporting partial authorizations. This will be less than the original TransactionAmount. You must collect the remainder via another form of payment, or Void 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:


Code	Description
0	Address verification was not requested.
A	Customer's address matches, zip does not.
E	AVS error / Ineligible (not a mail/phone order)
G	Address information not verified for international transaction. (Non-US Issuer does not participate).
I	Ver Unavailable - Address information not verified for international transaction.
M	Exact Match - Address match for international transaction.
N	No match on customer's address or zip.
R	Retry - Issuer system unavailable.
S	Service not supported by issuer.
U	Address information is unavailable.
W	Whole nine digit zip matches, but the address does not.
X	Exact AVS match, nine digit zip.
Y	Exact AVS match, five digit zip.
Z	Five digit zip matches, but the address does not.

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


B	Street address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
C	Street address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code).
D	Street addresses and postal codes match for international transaction.
I	Address information not verified for international transaction.
M	Street addresses and postal codes match for international transaction.
P	Postal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code).

Balance
String

Contains the remaining available balance left on the card.

The balance amount is returned by the Issuer when AllowPartialAuths is set to 'True' for Sale transactions.

In the case that the balance is negative, the balance amount will contain a "-" character.

BatchNumber
int

Number identifying the batch assigned by the POS device.

CommercialCard
int

Indicates whether the credit card charged is a corporate commercial card. In some cases, additional data is required to be sent for the transaction to be processed as a commercial card.

The available values are:


Value	Description
octNotCommercial (0)	Not a Commercial Card
octReviseTax (1)	Commercial Card, Sales Tax required for Settlement, Revised transaction required.
octReviseCode (2)	Commercial Card, Customer Code required for Settlement, Revised transaction required.
octReviseTaxCode (3)	Commercial Card, Sales Tax and Customer Code Required for Settlement, Revised transaction required.
octCommercial (4)	Commercial Card, Sales Tax and Customer Code Present, edit not required.

Note when a octReviseTax, octReviseCode, or octReviseTaxCode response is received, the transaction must be revised specifying the requested information (either Sales Tax, Customer Code, or both) to qualify as a Level 2 transaction. Revising a transaction is accomplished via the FDMSOmahaDetailRecord component and setting the TransactionType to ottRevise.

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:


M	CVV2 match.
N	CVV2 no match.
P	Not processed.
S	Merchant has indicated that CVV2 is not present on card.
U	Unknown, or Issuer does not participate.
X	Server Provider did not respond (Default).

DebitNetwork
String

The name of the network through which the debit card was processed.

DebitCardTypeNumber
String

The number of the debit network through which the debit card was processed.

EBTResponseCode
String

The response code sent by the network that processed the transaction.

This field will contain the response code sent by the network that processed the EBT transaction.

The available response codes are:


Code	Description
00	Approved Transaction.
12	Invalid Transaction.
13	ReEnter Transaction.
14	ReEnter Transaction. Invalid Card Number.
19	ReEnter Transaction. Invalid Card Number.
31	Cannot Process. Call Customer Service.
32	Cannot Process. Invalid Card Number.
41	Cannot Process. Call Customer Service.
43	Cannot Process. Call Customer Service.
50	Balance Verified.
52	Cannot Process. Invalid Card Number.
54	Expired Card.
55	Invalid PIN Number.
58	Invalid Transaction.
61	Invalid Transaction.
62	Cannot Process. Invalid Transaction.
75	PIN Tries Exceeded.
77	Cannot Process. Invalid Card Number.
90	Cannot Process. Call Customer Service.
91	Host Not Available.
93	Cannot Process. Call Customer Service.
96	Cannot Process. Call Customer Service.
E5	Cannot Process. Call Customer Service.

RequestedAmount
String

The amount entered at the Point of Sale device to be authorized.

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.

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.


Value	Description
" "	(Space) Authorization did not qualify as a Custom Payment Service transaction or the acquirer or merchant does not participate in Custom Payment Service (CPS).
A	Normal qualified
C	Qualified, customer-activated terminal
E	Qualified Retail
F	Card Not Present (Account Funding - with AVS and CVV2)
K	Qualified CPS/Retail Key Entry (AVS is required with K)
N	Not qualified
U	Card Not Present (E-Commerce - 3D Secure)
V	Qualified Address Verification (Card Not Present)
W	Card Not Present (E-Commerce - Non 3D Secure w/AVS)

RevisionNumber
int

Revision number of the online transaction.

Success
boolean

Determines whether the transaction was successful.

This field can be queried to determine whether the transaction was successful.

Text
String

Message from the Host describing the transaction.

Below are some of the common message responses from the Host.


Value	Description
APPROVED 999999	The Host computer sends this response on an authorization-only transaction. The authorization code appears in place of the "999999".
AUTH/TKT 999999	The Host computer sends this response on a sale transaction. The authorization code appears in place of the "999999".
PRTL SALE 999999	The Host computer sends this response on a sale transaction when the transaction was only partially approved. The authorization code appears in place of the "999999".
BAL 999999.99	This is the Host response to an EBT Balance Inquiry transaction. The "999999.99" represents the amount of the balance returned by the Network.
CALL _CENTER	A condition exists with the cardholder account that requires special handling. The merchant must contact the Voice Authorization Center for instructions about how to proceed.
CLOSE UNAVAIL	This is the Host response when the Host cannot accept the close batch message packet at that time. The merchant will need to retry the close at a later time.
CLOSE 999999.99	This is the Host response for a successful close transaction. The "999999.99" represents the batch amount for which the Host closed the batch.
DECLINED	The issuer has declined the authorization of the transaction for one or more reasons. The merchant should accept another form of payment.
DEP 999999.99	This is the Host response to a deposit inquiry transaction. The "999999.99" represents the batch amount for which the Host closed the last batch.
EXPIRED CARD	The expiration date sent with the authorization request indicates that the card has expired.
INVALID EXP DATE	The expiration date sent with the authorization request was formatted incorrectly.
FORCE 99999.99	The Host closed the batch with an out-of-balance condition. The Host was unable to balance with the POS device. The merchant needs to contact the financial institution for assistance.
INVALID AMOUNT	The POS device sends the Host an unacceptable dollar amount for authorization or the format of the number is incorrect.
INV BATCH SEQ	The batch number of a transaction message (message packet) is out of sequence with the batch number the Host is expecting for the merchant number and device ID combination. This message can also appear if trying to post a transaction with a revision number that is less than or equal too the revision number already posted to the Host.
INVLD BATCH SEQ	The batch number of a close batch message (message packet) is out of sequence with the batch number the Host is expecting for the merchant number and device ID combination.
INVALID CARD #	The cardholder account number entered is not valid and is not acceptable for payment. The merchant must verify the cardholder account number.
INVALID MRCH #	The merchant number in the transaction or close batch message is invalid or is not acceptable for the transaction code of the message packet being sent to the Host.
INVALID PIN	The PIN entered by the cardholder is not valid. Attempt transaction again.
CASH 999999	The Host computer sends this response on an EBT Cash Withdrawal transaction. The authorization code appears in place of the "999999".

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.

TransactionNumber
int

Number of the transaction in the batch as specified by the Point of Sale device.

Constructors

public FDMSOmahaResponse();