Response Fields
The response will contain all the fields sent in the request (minus any cardNumber and cardCVV) plus the following:
| Field Name | Returned? | Description |
|---|---|---|
| responseCode | Always | 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 Refer to the Response Codes section for details. |
| responseStatus | Always | 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 | Always | Message received from the Acquiring bank, or any error message. |
| transactionID | Always | A unique ID assigned by the Gateway. |
| xref | Always | You may store the cross reference for repeat transactions. Refer to the Payment Tokenisation section for details. |
| state | Always | Transaction state. Refer to the Transaction States section for details. |
| timestamp | Always | Time the transaction was created or last modified. |
| transactionUnique | If supplied | Any value supplied in the initial request. |
| authorisationCode | On success | Authorisation code received from Acquirer. |
| referralPhone | If provided | Telephone number supplied by Acquirer to phone for voice authorisation when provided. |
| amountReceived | On success | Amount the Acquirer authorised. This should always be the full amount requested. |
| amountRefunded | If refund | Total amount of original SALE that has so far been refunded. Returned when action is REFUND_SALE. |
| orderRef | If supplied | Any value supplied in the initial request. |
| cardNumberMask | Always | Card number masked for Merchant storage. |
| cardTypeCode | Always | Code identifying the type of card used. Refer to the Card Identification section for details. |
| cardType | Always | Description of the type of card used. Refer to the Card Identification section for details. |
| cardSchemeCode | Always | Code identifying the Card Scheme used. Refer to the Card Identification section for details. |
| cardScheme | Always | Description of the Card Scheme used. Refer to the Card Identification section for details. |
| cardIssuer | Always | Card Issues name (when known). |
| cardIssuerCountry | Always | Card issuing country’s name (when known). |
| cardIssuerCountryCode | Always | Card issuing country’s ISO-3166 2-letter code (when known). |
| rtAdviceCode | Always | Advice as to why a transaction failed and under what circumstances it can be retried. Refer to the Retry Transaction Advice Codes section. |
| rtRetryAfter | If supplied | Timestamp 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.