Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleSee 'Response Parameters'

Field Name

Description

Values

xResult (xGatewayResult)

Transaction status

A
E
D

xStatus (xResponseResult)

Result verbiage

Approved
Error
Declined

xError (xResponseError)

Error message, if applicable

See error code

xErrorCode

Error code

Most common error codes:
00000 = Approved
01332 = Duplicate Transaction
1334 = Declined Transaction
01479 = Invalid Card

See All Error Codes

xRefNum

Cardknox transaction Reference Number
Note: xRefnum is always returned regardless of the outcome of the transaction.

xInvoice

Invoice number

xExp

The card expiration number

xAuthCode (xResponseAuthCode)

Authorization code, approved transactions only

xBatch (xResponseBatch)

Batch into which transaction will settle

xAvsResultCode (xResponseAVSCode)

The Address Verification Service (AVS) response code

YYY = Address: Match & 5 Digit Zip: Match
NYZ = Address: No Match & 5 Digit Zip: Match
YNA = Address: Match & 5 Digit Zip: No Match
NNN = Address: No Match & 5 Digit Zip: No Match
XXU = Address Information not verified for domestic transaction
YYX = Address: Match & 9 Digit Zip: Match
NYW = Address: No Match & 9 Digit Zip: Match
XXR = Retry / System Unavailable
XXS = Service Not Supported
XXW = Card Number Not On File
XXE = Address Verification Not Allowed For Card Type
XXG = Global Non-AVS participant
YYG = International Address: Match & Zip: Not Compatible
GGG = International Address: Match & Zip: Match
YGG = International Address: Not Compatible & Zip: Match

Alternative Responses

AvsResultCodexAvsResultYAddress: Match & 5 Digit Zip: MatchZNo Match & 5 Digit Zip: MatchAAddress: Match & 5 Digit Zip: No MatchNAddress: No Match & 5 Digit Zip: No MatchXAddress: Match & 9 Digit Zip: MatchWAddress: No Match & 9 Digit Zip: MatchRRetry / System UnavailableSService Not Supported

xAvsResult

AVS verbiage

See AVS result code

xCvvResultCode (xResponseCVVCode)

Card Code Verification (CCV) response code

M = Match
N = No Match
P = Not Processed
S = Should be on card, but not so indicated
U = Issuer Not Certified
X = No Response from Association

xCvvResult

CVV verbiage

See CVV result code

xAuthAmount

The total amount authorized, inclusive of tax and tip (if applicable).

xMaskedCardNumber

A masked version of the credit card used for the transaction

xCardType

Type of credit card used for the transaction

Unknown
EBT
GiftCard
Amex
Visa
MasterCard
Discover
Diners
JCB

xName

Name of card holder

xToken

Token returned for use with future transaction.

xEntryMethod

Transaction Method

Keyed
EMV
Swipe

xRefnumCurrent

Current Reference Number

Used for troubleshooting purposes only. Returned when using a command that modifies an existing transaction such as cc:void, cc:capture, or cc:adjust.

...

Sandbox

...

Account Testing Info and Triggers

...

Credit Card and Account Numbers

...

Expand
titleCheck (ACH)

Account Number

Routing Number

999999999

021000021 (Any valid routing number)

Triggers

Expand
titleDeclined Transaction

xName

Response

Decline

Declined

Expand
titlePartial Auth

(AllowPartialAuth must be set to True)

xAmount

AuthAmount

7.5

1.5

7.23

1.23

...