- Home
- All APIs
- Worldpay Total Hospitality
- Output Response Attributes
Output Response Attributes
The Hospitality response message also contains transaction response in a Name Value pair format. There is a name (number) associated with all the response attributes of the transaction. The Hospitality will send a list of attributes and their values in the response. Each attribute Name Value pair is separated by a Line Feed.
Note: Not all of the listed attributes are sent in every response. The response attributes can vary even for the same type of transaction: an example is where DCC is enabled, there are attributes detailing DCC currency, the currency conversion rate etc which will be present in the output response only if DCC was offered and accepted for the transaction. If the transaction proceeded in the home currency, these DCC attributes will not be present in the output response.
This is the list of response attributes for a transaction:
Description | Attribute Name | Length | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POS Entry Mode, card payment entry method. Additional values may be added with new releases of Hospitality.
| 1 | 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Type. Transaction Type indicates the type of financial transaction, represented by the first two digits of ISO 8583:1987 Processing Code. Note: Additional values may be added with new releases of Hospitality
| 2 | 1-2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Result. Uniquely identifies the transaction response. Note: Additional values may be added with new releases of IPC
| 3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authorisation Code, holds the value generated by the issuer for an approved transaction. Present only in case of a successful transaction. | 4 | 2-6 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMV Card Data Element Application Primary Account Number (PAN) holds the valid cardholder account number. Masked PAN consists of first 6 digits and last 4 digits: e.g. 492949 XXXXXX 0002 | 5 | 13-19 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMV Card Data Element Application Label holds the mnemonic associated with the AID according to the ISO/IEC 7816-5. | 6 | 1-16 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMV Card Data Element Application Effective Date which holds date from which the application may be used. The format is DDMMYYYY. | 7 | 8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Date contains local date that the transaction was authorised. The format is DDMMYYYY. | 8 | 8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Time contains local time that the transaction was authorised. The format is HHMMSS. | 9 | 6 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMV Card Data Element Cardholder Name indicates cardholder name according to ISO 7813. | 10 | 4-52 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMV Card Data Element Cardholder Name Extended indicates the whole cardholder name when greater than 26 characters using the same coding convention as in ISO 7813. | 11 | 54-90 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Identifier | 12 | 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminal Identifier | 13 | 8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Card Verification Method Note: Additional values may be added with new releases of IPC
| 14 | 1-2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Start Date, present only in case of a swiped UK Maestro/Solo card transaction. | 15 | 8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total Number of Sale Counts | 16 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total Number of Refund Counts | 17 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Indicates Total Sale Amount This amount is returned when X and Z report transaction is performed. Amount is returned in minor currency denomination. | 18 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Indicates Total Refund Amount. This amount is returned when X and Z report transaction is performed. Amount is returned in minor currency denomination. | 19 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EFT Sequence number | 21 | 1-6 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Address | 22 | 1-140 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Name | 23 | 40 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Batch Number | 25 | 9 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PGTR, Payment gateway transaction reference. | 28 | 12-14 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMV Card Data Element Application Identifier (AID), which identifies the application as described in ISO/IEC 7816-5. | 29 | 10-32 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PAN Sequence number or Issue Number. PAN Sequence number in case of an ICC transaction and Issue number in case of a Swiped UK Maestro/Solo card transaction. | 30 | 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Status Information (TSI), present only in case of an ICC transaction. Used for debug purpose only. | 31 | 4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminal Verification Results (TVR), present only in case of an ICC transaction. Used for debug purpose only. | 32 | 10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retention reminder | 33 | 10-100 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customer Declaration | 34 | 240 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Additional Response Data, the CVV response | 35 | 6 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Receipt Number | 36 | 1-10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Card Expiry Date Hospitality returns the encrypted expiry date from PEDs. Any valid MMYY date can be sent to Hospitality for cancel and pre sales completion transaction type. | 37 | 4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total Amount. Amount is returned in minor currency denomination. Total amount includes Sale Amount, Cash Back Amount (if any), Gratuity Amount (if any) and Pennies Donation Amount ( if any) | 38 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cash Back Amount. Present if cash back amount is entered when requested Cash Back Amount is returned in minor currency denomination. | 39 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gratuity Amount Gratuity Amount is returned in minor currency denomination. | 40 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This field indicates Card type, If card is fuel card it returns 1 else 0. | 41 | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This field indicates X and Z report in XML format. | 48 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The response message signifies notification result field that contains all the Closed notification status of particular table number. E.g. 53=[12=CLOSED, 15=CLOSED] | 53 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A field of 40 zeros(0) is returned to maintain the backward compatibility (earlier SHA1 hash value for the PAN number was returned in response | 59 | 40 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Card Issuer Code, this is the 3 digit card issuer code as held on the Worldpay Total central service . It may be used to identify the type of the card. Note: Additional values may be added with new releases of Hospitality This is the current list of issuer codes for UK and Europe:
| 60 | 3 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Token Reference: This will be 20 characters long and alphanumeric field. | 61 | 20 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Acquirer Name will be returned in this field only in get territory response. | 65 | 1-40 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Converted currency name for DCC transactions like HKD – HK Dollar. | 70 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Amount converted into accepted currency for DCC transactions. | 71 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Currency conversion rate. | 72 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pennies Donation Amount: This field will be present only in the response of Pennies Donation transaction. Pennies Donation Amount is returned in major currency. | 74 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total number of offline stored transactions. | 75 | 1-4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Serial number of connected PED. (PTID) | 76 | 6-9 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Available offline spending amount | 77 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieval Reference Number. It is a copy of receipt number. | 80 | 12 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Target reference (Type numeric. Max width 12 digits). This will have the same value as received in pre-set + target reference of input message. This can be used to associate a payment with sent input message. Note: Won't be present for No Table transactions | 97 | 12 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Instance ID (alphanumeric). This will have the same value as received in pre-set and target reference of input message. Format for instance IDis INST followed by instance ID 1,2,3 eq. INST1,INST2 . This can be used to associate a payment with sent input message. | 101 | 5-7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction reference. This field will be present in the response of a transaction if field 1 is present in transaction request. | 98 | 1-30 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Purpose. This field will be present in the response of an account verification transaction, it represents account verification to charge cardholders for adhoc payments. | 103 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Instance ID (alphanumeric). This attribute have the same value as received in transactions processed from P400 PEDs. Format for instance ID is INST followed by instance ID 1,2,3 eq. INST1,INST2. This field is specific to Pay at counter transactions and can be used to associate a payment with input message | 107 | 5-7 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Instance ID & Waiter ID (alphanumeric). This attribute specify value of waiter ID and Instance ID of PED. Application sends this attribute in response of ‘close table polling’ request when 'Identify Waiter ID' functionality is enable and operator enters waiter ID from PED to process any payment. It can be used to determine who is logged into which device at a given time. Format of this attribute is [WAITERID1:INST1,WAITERID2:INST2] were Instance ID is INST followed by numeric 1,2,3 etc. e.g. INST1,INST2 and Waiter ID can be numeric or alphanumeric value. E.g. 105 = [456:INST1,457:INST2] | 105 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Indicates transaction is performed by chip&pin and chip&signature card. In pay at counter mode. The value for this attribute returned is 1. | 118 | NA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
End of message indicator, values always 0. | 99 | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Split transaction marker. In case multiple transactions were attempted for a payment, response message for all such transaction will be returned. The response messages are separated by two dash characters (--). There will be only one end of message marker (99=0) in the whole response at the end. | -- |
Note: The Transaction result 10 in field 3 is valid for non-financial transactions, these transaction types are 22,23,25,26 and 27. Also these transaction types are available for UK.
PED | CVM Method (14 = ) | PEM (1 = ) |
---|---|---|
V240m / P400 Contactless | 8 | 7 |
V240m / P400 HVC | 2 | 92 |