Output Response Attributes

The IPC 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 IPC 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 IPC

Note: for contactless refund transactions the values returned differ between PEDs

Value

Meaning

5

Chip transaction

2

Magstripe transaction

1

Keyed transaction

81

Cardholder not present

0

X and; Z report and transaction type Cancel

21

Cash transaction

7

Contactless chip transaction

91

Contactless magstripe transaction

92

Contactless On-Device transaction

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 IPC

Transaction Type

Description

0

Sale (Goods and Services)

3

Cancel

9

Purchase With Cashback

20

Returns


2

1-2

Transaction Result. Uniquely identifies the transaction response.

Note:Additional values may be added with new releases of IPC

Transaction Result

Description

1

Approved Online

2

Approved Offline

3

Approved Manual (Referral)

4

Declined Online

5

Declined Offline

9

Cancelled

10

Transaction performed

16

Capture Card, declined online

17

Terminal Recovery, Keyed by Merchant Success

19

Transaction Aborted

20

Pre sales completed

21

Pre sales rejected

22

Card number not matched

23

Expiry date not matched

24

Invalid transaction state

25

Transaction not valid for requested operation

26

Invalid PGTR

27

Invalid Merchant

28

Invalid Terminal

29

Merchant status is not valid

30

Invalid card number

31

Expired Card

32

Pre valid card

33

Invalid issue number

34

Invalid card expiry date

35

Invalid start date

36

Card not accepted

37

Transaction not allowed

38

Cash back not allowed

42

Status Busy

43

Status Not Busy

44

Pinpad is not connected

45

Pinpad is connected

50

AVS details required

4001

Declined Online if card doesn’t support account verification transaction


Authorisation Code, holds the value generated by the issuer for an approved transaction. Present only in case of a successful transaction.

Note – For Alipay Transactions, NO Auth Code will be received from Alipay.

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

Note: For Alipay Sale Transaction using BarCode, instead of Card PAN the complete BarCode will be printed in plain text. The same will be a required parameter while requesting for an Alipay Refund or Cancel transactions against that Alipay Sale Transaction, along with PGTR.

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

CVM

Description

1

Signature verified

2

Pin verified/ CVM performed on Consumer device in contactless transaction

7

Cardholder not present

8

No CVM

9

Unknown CVM

10

Signature and Pin verified

11

Pin Bypass (US)

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

Total Sale Amount.

This amount is returned when X and Z report transaction is performed.

Amount is returned in major currency denomination

18

NA

Total Refund Amount.

This amount is returned when X and Z report transaction is performed.

Amount is returned in major currency denomination

19

NA

EFT Sequence number

21

1-6

Merchant Address

22

1-140

Merchant Name

23

40

Batch Number

25

9

Referral telephone number 1

26

8-20

Referral telephone number 2

27

8-20

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.

Note – For VISA Contactless Cards, truncated EMV Card Data Element Application Identifier (AID) will be received instead Extended AID.

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

IPC returns the expiry date in case of iPP350 and iWL250 if token is generated in the 61 field, otherwise returns expiry date as ("0101").

IPC always returns actual expiry date for VeriFone Vx820 and Miura PEDs.

Any valid MMYY date can be sent to IPC for cancel and pre sales completion transaction type.

If a card does not have an expiry date then IPC returns expiry data as ("0101").

37

4

Total Amount. Amount is returned in configured major/minor currency denomination.

Total amount includes Sale Amount, Cash Back Amount (if any), Gratuity Amount (if any) and Pennies Donation Amount ( if any)

The default format of amount will be in minor currency.

38

NA

Cash Back Amount. Present if cash back amount is entered when requested Cash Back Amount is returned in configured major/minor currency denomination.

The default format of amount will be in minor currency.

39

NA

Gratuity Amount

Gratuity Amount is returned in configured major/minor currency denomination.

The default format of amount will be in minor currency.

40

NA

This field indicates Card type, If card is fuel card it returns 1 else 0.

41

1

This field indicates track 2 data. If a card is whitelisted and the transaction type is check card then this field will return in output response.

46

40

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 three digit WPH card issuer code. Should be used to identify the type of the card.

Note:Additional values may be added with new releases of IPC

This is the current list of issuer codes for UK and Europe:

Code

Description

Name abbreviation

Comments

000

Not In Use

NOT ISSUED

Not in use

001

VISA DEBIT

DELTA

002

UK Electron

UKELECTRON

003

Visa Purchasing

VISA

004

Visa

VISA

005

Mastercard

MASTER

006

UK Maestro

UK MAESTRO

007

Solo DISCONTINUED

SOLO

Not in use

008

JCB

JCB

009

Maestro

MASTER

010

VISA ATM

VISA ATM

011

ARVAL PHH

ARVALPHH

012

Amex

AMEX

013

Diners Club International

DINERS

014

Laser

LASER

Not in use

015

DUET

DUET

Not in use

016

HN Mastercard

MASTER

017

HN PLCC

PLCC

018

Tesco Clubcard

CLUBCARD

019

DANKORT

DANKORT

020

Discover

DISCOVER

021

US Debit

USDEBIT

022

Debit Mastercard

MASTER

023

Mastercard Purchasing

MASTER

024

Bank of America

BANAMER

025

Newday MasterCard

NDMASTERCARD

026

Newday Staff Card

NDSTAFF

027

Newday Store PLC

NDSTOREPLC

028

Newday Temporary

NDTEMP

080

YESpay Virtual Card

FLEXCASH

Not in use

081

Flexecash Love 2 Reward

FLEXECASH

090

YESpay Gift Card

YESPAY

Not in use

091

PPS Gift Card

PPS

029

Alipay BarCode

Alipay BarCode

60

3

Token Reference: This will be 20 characters long and alphanumeric field.

IPC will return token reference for Sales(Redemptions) and Top Up.

61

20

Credit/Debit card identification with online/offline indicator will be returned only in Check Card response.

Only four values are possible:

  • D|Online

  • C|Online

  • D|Offline

  • C|Offline

64

9-10

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

Balance Amount in gift card

Balance amount will be shown for all gift card transaction types. If IPC did not get a balance then “NA” will be shown in output response.

73

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 pinpad.

76

6-9

Available offline spending amount

77

NA

Flexecash card available balance amount

78

NA

Retrieval Reference Number. It is a copy of receipt number.

80

12

Card Country Code

Card Country Code is an optional field and it will be returned only on merchant choice and information should be collected at the time of on boarding.

Note: It will be returned only for transaction type Sale and Preauth (Excluding Token Transaction) and is subject to availability in system.

81

NA

Transaction reference. This field will be present in the response of a transaction if field 1 is present in transaction request.

98

1-30

End of message indicator, values always 0.

99

1

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.
  • For contactless EMV refund transactions, the Verifone Vx820 PED does not use the CVM information for ‘On Device’ contactless refunds, although this information is provided with the transaction and captured by the WPT payment service. This results in a difference between PEDs for the POS Entry Mode (attribute 1) and CVM Method (attribute 14) values returned in the output response for contactless refund transactions as detailed in the table below.

PEDContactless Tender Type in Refund transactionCVM Method (Attribute 14 )POS Entry Mode (Attribute 1)
iPP350/iWL250/M010 IPP350Contactless Card tapNo CVM (14=8)Contactless Chip
(1=7)
iPP350 HVC/iWL250/M010On Device (ApplePay etc)CVM performed on consumer device (14=2)Contactless On-Device
(1=92)
Vx820/Verifone P400Contactless Card tapNo CVM (14=8)Contactless Chip
(1=7)
Vx820/Verifone P400On Device (ApplePay etc)No CVM (14=8)Contactless Chip
(1=7)