Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel32
outlinetrue
exclude"Benefits" "Disadvantages"

...

Field Name

Always Returned?

Description

respnseCode

Yes

A numeric code providing the specific outcome. Common values are:

0 - Successful / authorised transaction.

1 - Card referred – Refer to card issuer.

2 - Card referred – Special condition.

4 - Card declined – Keep card.

5 - Card declined

responseStatus

Yes

A numeric code providing the outcome category. Possible values are:

0 – Authorisation Approved / No reason to decline

1 – Authorisation Declined.

2 – Authorisation Error / Transaction malformed.

responseMessage

Yes

Message received from the Acquiring bank, or any error message.

transactionID

Yes

A unique ID assigned by the Gateway.

acquirerResponseXXXX

Depends on the acquirer

Additional Response sent by acquirer

xref

Yes

Used to rerun or refund transactions at a later point.

state

Yes

Transaction state

timestamp

Yes

The time when the transaction was last modified

cardNumberMask

Yes

The first 4 digits and last 4 digits of the customer’s PAN card number. The rest of the digits are encrypted.

transactionUnique

If sent in request

Any value supplied in the initial request.

orderRef

If sent in request

Any value supplied in the initial request.

authorisationCode

If transaction was successful

Authorisation code (Auth Code) received from Acquirer.

amountReceived

If transaction was successful

Amount the Acquirer authorised. This should always be the full amount in the request.

cardTypeCode

Yes

Code identifying the type of card used.

cardType

Yes

Description of the type of card used.

cardSchemeCode

Yes

Code identifying the Card Scheme used.

cardScheme

Yes

Description of the Card Scheme used.

cardIssuer

Yes

Card Issues name

cardIssuerCountry

Yes

Card issuing country’s name

cardIssuerCountryCode

Yes

Card issuing country’s ISO-3166 2-letter code

amountRefunded

If it is a refund

Total amount of original SALE that has so far been refunded. Returned when action is REFUND_SALE

...