When axept® GO has completed the processing of a transaction the results are returned to the integrated application via the broadcast receiver.
Initial Response
The integrated application should check three fields in the response initially:
Initial Check |
---|
Field Name | Data Type | Description |
---|
Approved | Boolean | Whether or not the transaction was approvedtrue | Transaction was approved | false | Transaction was not approved |
|
TransResponse | Boolean | Informs integrated application whether the response includes a transaction responsetrue | Transaction response included | false | Transaction response is not included |
|
TransactionDetails | Boolean | Informs integrated application whether the response includes details of a transactiontrue | Transaction details included | false | Transaction details are not included |
|
Details of the various data elements described above are detailed next.
Transaction Response = True
When the TransResponse
field is set to true
the below information is included.
TransactionResponse |
---|
Field Name | Data Type | Description |
---|
UTI
| GUID | Unique Transaction Identifier Unique identifier for the transaction which has been processed. |
Amount | Numeric | Amount of the transaction which has been processed. Amount in pence, e.g. 100 = £1.00. |
MsgStatus | Not Used | Message Status Reserved for future use. |
Approved | Boolean | Whether or not the transaction was approvedtrue | Transaction was approved | false | Transaction was not approved |
|
Tip | Numeric | Value of the gratuity awarded as part of the transaction. |
Cashback | Numeric | Value of cashback added as part of the transaction. |
Cancelled | Boolean | Whether or not the transaction was cancelledtrue | Transaction was cancelled | false | Transaction was not cancelled |
|
SigRequired | Boolean | Whether or not the transaction required a signaturetrue | Transaction did require a signature | false | Transaction did not require a signature |
|
PINVerified | Boolean | Whether or not the PIN verification was not performedtrue | PIN verification was performed | false | PIN verification was not performed |
|
AuthMode | String | Reserved for future use. |
Currency | String | Currency in which the transaction was processedGBP | Pound Sterling | EUR | Euros |
|
Tid | Numeric | Serial number of the device that processed the transaction. |
Mid | Numeric | Merchant ID used during the authorisation process. |
Version | String | Version of axept® GO used for the transaction. |
Reference | String | A copy of the reference supplied in the request. |
Transaction Details = True
When the TransactionDetails
field is set to true
the below information is included.
TransactionDetails |
---|
Field Name | Data Type | Description |
---|
ReceiptNumber | Integer | Receipt number allocated by axept® GO. |
RRN | Not Used | Reserved for future use. |
ResponseCode | String | Response code issued by the acquirer during the transaction. |
Stan | Not Used | Reserved for future use. |
AuthCode | String | If applicable, the authorisation code issued by the acquirer. |
MerchantTokenId | String | The Optomany token for the card used in the transaction. |
PAN | String | Masked PAN of the card used in the transaction. |
ExpiryDate | String | Expiry date of the card used in the transaction - format YYMM. |
StartDate | String | Start date of the card used in the transaction - format YYMM. |
Scheme | String | Name of the card scheme used in the transaction. |
PSN | Integer | Pan sequence number retrieved from the card. |
CardType | String | Way in which the card was captured for the transaction.EMV | Card was processed via Chip & PIN or Chip & Signature | Contactless | Card was processed via contactless | MSR | Card was swiped | Manual | Card was keyed |
|
IsVoucherUsed | Boolean | Loyalty Transactions Onlytrue | A voucher was used in the transaction |
|
VoucherCodeUsed | String | Loyalty Transactions Only Confirmation of voucher code presented. |
ValueOfVoucher | String | Loyalty Transactions Only Value of voucher presented. |
CardType = EMV
When the CardType
field is returned as EMV
, Contactless
, or MSR
the below information will also be supplied. This is where the transaction has been performed as Chip and PIN, Contactless, or Swipe.
CardType = EMV |
---|
Field Name | Data Type | Description |
---|
AID | String | EMV tag - Application Identifier |
TSI | String | EMV tag - Transaction Status Information |
CardHolder | String | Cardholder name - where available. |
Cryptogram | ByteArray | Cryptogram used. |
CryptogramType | String | Type of Cryptogram used. |
Unsupported Transaction Types
If an integrated application attempts to call an unsupported transaction type, axept® GO will respond with the below:
Initial Check |
---|
Field Name | Data Type | Description |
---|
Approved | Boolean | false |
TransResponse | Boolean | false |
TransactionDetails | Boolean | false |