Skip to main content

Response Fields

The response will contain all the fields sent in the request (minus any cardNumber and cardCVV) plus the following:

Field NameReturned?Description
responseCodeAlways

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.

Check responseMessage for more details of any error that occurred.

Refer to the Response Codes section for details.

responseStatusAlways

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.

responseMessageAlwaysMessage received from the Acquiring bank, or any error message.
transactionIDAlwaysA unique ID assigned by the Gateway.
xrefAlways

You may store the cross reference for repeat transactions.

Refer to the Payment Tokenisation section for details.

stateAlways

Transaction state.

Refer to the Transaction States section for details.

timestampAlwaysTime the transaction was created or last modified.
transactionUniqueIf suppliedAny value supplied in the initial request.
authorisationCodeOn successAuthorisation code received from Acquirer.
referralPhoneIf providedTelephone number supplied by Acquirer to phone for voice authorisation when provided.
amountReceivedOn successAmount the Acquirer authorised. This should always be the full amount requested.
amountRefundedIf refundTotal amount of original SALE that has so far been refunded. Returned when action is REFUND_SALE.
orderRefIf suppliedAny value supplied in the initial request.
cardNumberMaskAlwaysCard number masked for Merchant storage.
cardTypeCodeAlways

Code identifying the type of card used.

Refer to the Card Identification section for details.

cardTypeAlways

Description of the type of card used.

Refer to the Card Identification section for details.

cardSchemeCodeAlways

Code identifying the Card Scheme used.

Refer to the Card Identification section for details.

cardSchemeAlways

Description of the Card Scheme used.

Refer to the Card Identification section for details.

cardIssuerAlwaysCard Issues name (when known).
cardIssuerCountryAlwaysCard issuing country’s name (when known).
cardIssuerCountryCodeAlwaysCard issuing country’s ISO-3166 2-letter code (when known).
rtAdviceCodeAlwaysAdvice as to why a transaction failed and under what circumstances it can be retried. Refer to the Retry Transaction Advice Codes section.
rtRetryAfterIf suppliedTimestamp after which a transaction can be replied in YYYY-MM-DD HH:MM:SS format. Refer to the Retry Transaction Advice Codes section.

Other response fields may be returned as detailed elsewhere in this guide. Undocumented fields may be returned at the Gateways discretion but should not be relied upon.

The acquirerResponseXXXX fields will normally be returned but these are dependent on the Acquirer in use and are supplied for additional information only.

The response is also POSTed to any URL provided by optional callbackURL.