UOB ECR Specification V1.17

UOB - ECR Interface Specification Version 1.
17
UOB - ECR Interface

Specifications
Version 1.17
UOB - ECR Interface Specification Version 1.17
Change History
Version Revision Description Date
No. No.
1. 00 Initial Draft 15/09/2015
1. 01 Updated for DGF amount field type 42 09/03/2016
1. 02 Added Tips Adjust 20/07/2016
1. 04 Added Offline Sale 20/11/2017
1. 05 1. Change D8 Field to be 19 or 20 10/04/2018
2. Added PRE-AUTH
3. Added Field Type DC – Card Number last 4
digits
4. Added SALE COMPLETION
5. Added AUTH REVERSAL
6. Added D8 in response
7. Added Instalment
1. 06 Added INCIDENTAL CHARGE 14/06/2018

1. 07 Added Receipt Printing Field For Kiosk 27/09/2018
1. 08 Added UB for TMS download 19/11/2018
1. 09 Added UPI Ref No, MMDD for UPI Refund 25/01/2019
1. 10 Added UPOS ECR 2 Support and Sample Data 24/03/2019
1. 11 Added UPI QR, Wechat, Alipay 05/08/2019
1. 12 Added QR MPM Payment 23/09/2019
1. 13 Change Auth Reversal for Preauth Unfreeze 01/10/2019
1. 14 Added Card Tokenization 08/04/2020
1. 15 Added UPI Coupon SALE 08/05/2020
1. 16 Update UPI Coupon SALE 13/10/2020
1. 17 Added PAYNOW 01/12/2021
Update Field Code D6/D7 in Field Type
Table of Contents
1 Introduction ......................................................................................................... 6
2 Message Exchange Sequence ........................................................................... 7
2.1 Communication Protocol ............................................................................... 7
2.1.1 Communication parameter ..................................................................... 7
2.1.2 Control Character ................................................................................... 7
2.1.3 Message Checksum ............................................................................... 8
2.2 Connection diagram ...................................................................................... 9
2.2.1 MagicBox ................................................................................................ 9
2.2.2 ECR Cable.............................................................................................. 9
3 Message REQUEST and RESPONSE Protocol ............................................... 10
3.1 Communication Protocol between the external device (POS) and terminal in
normal condition. .................................................................................................. 10
3.2 Communication Protocol between the external device (POS) and terminal in
error handling. ...................................................................................................... 10
3.2.1 NACK is received by the external device. ............................................. 10
3.2.2 No response from terminal after External Device has issue command. 11
3.2.3 No response from External Device after terminal has sent response
message. .......................................................................................................... 11
3.2.4 NACK is received by the terminal. ........................................................ 12
3.2.5 No response from terminal after Acknowledgement is received by the
Extermal Device. ............................................................................................... 12
4 MESSAGE STRUCTURE ................................................................................. 13
5 MESSAGE DATA.............................................................................................. 14
5.1 Transport Header ....................................................................................... 14
5.2 Presentation Header .................................................................................. 14
5.3 Field Data ................................................................................................... 15
5.3.1 Field Element Format .......................................................................... 15
5.4 Response Code .......................................................................................... 16
6 Transaction Codes Support by Terminal ........................................................... 17

7 Fields Type ....................................................................................................... 18
8 Authorisation Transaction ................................................................................. 21
8.1 SALE ........................................................................................................... 21
8.2 VOID ........................................................................................................... 26
8.3 REFUND ..................................................................................................... 28
8.4 TIPS ADJUST ............................................................................................. 30
8.5 OFFLINE SALE ........................................................................................... 32
8.6 INSTALMENT ............................................................................................. 34
8.7 PRE-AUTH .................................................................................................. 36
8.8 PRE-AUTH TOPUP .................................................................................... 38
8.9 SALE COMPLETION .................................................................................. 40
8.10 AUTH REVERSAL ................................................................................... 42
8.11 INCIDENTAL CHARGE ........................................................................... 44
8.12 QR INQUIRY ........................................................................................... 46
8.13 QR MERHCANT PRESENTED MODE SALE (MPM- UPI, WECHAT,
ALIPAY) ................................................................................................................ 48
8.14 QR MERHCANT PRESENTED MODE PREAUTH ( ALIPAY Only) ........ 50
8.15 CARD TOKENIZATION ........................................................................... 52
8.16 UPI COUPON SALE ................................................................................ 53
8.17 PAYNOW ................................................................................................. 55
9 Administrative Transactions .............................................................................. 57
9.1 SETTLEMENT ............................................................................................ 57
9.2 SUMMARY/DATAIL/LAST SETTLEMENT/ANY RECEIPT ......................... 61
9.3 TEST DIAL .................................................................................................. 62
9.4 TMS DOWNLOAD ...................................................................................... 63
10 Sample Commands ........................................................................................ 64
11 Receipt Printing Format For Kiosk.................................................................. 66
12 UPOS using NETS ECR 2 Specification ........................................................ 67
13 QR Transaction flow with Inquiry .................................................................... 69
14 POS Log Files Format .................................................................................... 70
1 Introduction
This document provides information on how an external device, such as a cash

register, can handle the requirements of UOB in terms of a POS interface and
communicate effectively with secure terminal module for the purpose of financial debit
transactions involving a VISA or MASTERCARD and other Credit Card (e.g CUP) is
available. The interface specifications will include communications protocol, as well as
payment procedures using different methods.
2 Message Exchange Sequence

The external module initiates the message exchange sequence. The device requests
the terminal to perform a particular task. This is acknowledged at the link level by the
terminal, which then performs the task. On completion of the task, the terminal
responds to the external module with data pertinent to the task performed and the
external module returns an acknowledgement at the link level.
2.1 Communication Protocol
2.1.1 Communication parameter
The terminal model interfaces through an asynchronous serial communications port

with the following port parameters:
Baud Rate 9600

Parity None
Data 8 Bits, 1 Stop Bit
Retries 3
2.1.2 Control Character
The following four control characters are used to control the communication protocol.
All the proposed values are in hexadecimal format.
Start of Text STX 0x02

End of Text ETX 0x03
Acknowledgement ACK 0x06
Negative Acknowledgement NACK 0x15
2.1.3 Message Checksum
All messages have a Long Range Checksum (LRC) appended at the end of the
message, following the ETX control character. The LRC is an exclusive OR of all data
bytes contained in between STX and ETX. The LRC operation includes the ETX
control character, but not the STX. The Start value for computing the LRC is
hexadecimal 0x00.
STX Length of Message Data ETX LRC

Message bytes ...
Following the message checksum rule, The Long Range Checksum of the above
sample message is computed by performing an exclusive OR of the grey-shaded data.
The Length of Message field is a 2-byte BCD format value, starting with the most
significant byte. For example, a message of 158 bytes would have this content: 01 58
in the Length of Message field, if a message of 189 bytes, the Length of the Message
field would be 01 89.
2.2 Connection diagram
2.2.1 MagicBox
2.2.2 ECR Cable

3 Message REQUEST and RESPONSE Protocol

3.1 Communication Protocol between the external device (POS) and terminal
in normal condition.
Request
Ack
Electronic
Cash Response Terminal
Register
Ack
3.2 Communication Protocol between the external device (POS) and terminal
in error handling.
3.2.1 NACK is received by the external device.
Request
NACK
Electronic Resend Request immediately

Terminal
Cash
Register NACK
Resend Request immediately
NACK
3.2.2 No response from terminal after External Device has issue command.
Request
No response (No ACK)
Electronic Resend Request after 2 sec Terminal

Cash
Register No response (No ACK)
Resend Request after 2 sec
3.2.3 No response from External Device after terminal has sent response
message.
Request
Send ACK (06)

Electronic
Cash Send Response
Register No response Terminal
Re-send response after 2 sec
No response
Re-send response after 2 sec

No response
. The terminal only re-sends the response message twice. After the terminal makes
the final re-sends and has waited for 2s, if no acknowledgement is received from the
Kiosk, the transaction is considered unsuccessful and the external device should
check for any error in the communication setup, fix the error and then re-issue another
request message again
3.2.4 NACK is received by the terminal.
Request
Send ACK (06)
Send Response Terminal
Electronic Send NACK (0x15)

Cash
Register Re-send response immediately
Send NACK (0x15)
Re-send response immediately
Send NACK (0x15)
If the last resend response is still result in NACK, terminal will stop sending the
response and consider the transaction completed, POS will need to check for any
errors in the communication setup and fix any errors.
3.2.5 No response from terminal after Acknowledgement is received by the

Extermal Device.
Electronic Request
Cash
Register Send Response (0x06)
Terminal
No Response
After the External Device has received Acknowledgement from the terminal, it should
set a timeout period while waiting for the response message from the terminal. The
recommended time-out duration for the external device is ant 120 secs.
4 MESSAGE STRUCTURE
S LLLL MESSAGE DATA E L

T T R
X X C
Transport Presentation Field Data

Header Header
Field Field
Element Element
Field Bytes Value Description

STX 1 0x02 Start of Text
LLLL 2 Length of Message data to follow.
It is in BCD form
E.g. for a length of 256 bytes, it will be
transmitted as 0x02 0x56
MESSAGE LLLL The message data consists of a Transport

DATA Header, presentation Heard and Field data
which is one or more Field Elements.
EXT 1 0x03 End of Text
LRC 1 Longitudinal Redundancy Characters.
This character is calculated by exclusive Or-
ing each character following (but not including)
the STX up to (and including) the ETX.
5 MESSAGE DATA
The message data within a message consists of three different components, in the
order as shown in the following diagram.
MESSAGE DATA
Transport Header Presentation Header Field Data
5.1 Transport Header

Hardcoded data:
TRANSPORT HEADER
“60” “0000 “0000”
5.2 Presentation Header
PRESENTATION HEADER
Format Request- Transaction Response More Data Field Separator
Version Response Code Code Indicator
Indicator

Format 1 0x31 “1”
Request- 1 “0” This is a request message which require a
Response response
Indicator “1” This is a response message
Transaction 2 Identifies the type of transaction this message
Code is performing
See Transaction code supported by terminal
table for a list of supported transaction.
Response Code 2 Identifies the result of the transaction in a
response. Response code should be set to
'00' for all request messages.
See the table in section for a list of valid
Response
More Indicator 1 '0' This is the last message for this
transaction.
'1' There is another message following
this one with more field data for this
transaction.
Field Separator 1 0x1C This field is used to make it easier to identify

the end of the presentation header when
looking at message traces.
5.3 Field Data
FIELD
Field Elements Field Element Field Element Field Element
5.3.1 Field Element Format
FIELD ELEMENT FORMAT

Field LLLL Data Field
Type Separator

Field Type 2 Indicates the type of data that is included in this
field element.
This is an alphanumeric field. Characters 0-9
and A-Z are available for use.
The table in next section lists the available
values.
LLLL 2 Indicates the length in bytes of the data to follow.
It is transmitted in BCD.
For example, a length if 12 bytes, it is transmitted
as 0x00 0x12
Data LLLL The data for this field. If no data is in this field (for
example, when the functionality is indicated by
the field type on its own), there will be no data.
Field Separator 1 0x1C Please Make use of the LLLL to parse the data,
field code 9D data will contain 1C.
Example:
394400087A25C8241C039B3B1C
5.4 Response Code
Response Description
Code
00 Approved
NA Transaction Not Available or Declined
ND Transaction Declined
NC Multiple Card Detected , Declined ( For Hotel Server solution only)
IN For QR Transaction Only,
Transaction Status Unknown, POS need to send QR Inquiry to Check status
XX Any other Response code = Declined
TE Token Exists
TN Token Not Exists
6 Transaction Codes Support by Terminal
Transaction Description
Code
Authorization Transactions
20 SALE
26 VOID
27 REFUND
28 TIPS ADJUST
23 INSTALMENT
44 OFFLINE SALE
41 PRE-AUTH
45 PRE-AUTH TOPUP
42 SALE COMPLETION
47 AUTH REVERSAL
48 INCIDENTAL CHARGE
49 QR INQUIRY
UE QR MERHCANT PRESENTED MODE SALE (MPM- UPI, WECHAT, ALIPAY)
UG QR MERHCANT PRESENTED MODE PREAUTH (ALIPAY ONLY)
UF CARD TOKENIZATION
UH UPI COUPON SALE
UP PAYNOW
Administrative Transaction
50 SETTLEMENT
U5 SUMMARY/DATAIL/LAST SETTLEMENT RECEIPT (Printed)
UA TEST DIAL
UB TMS DOWNLOAD (Mandatory to call this Function for Kiosk that is does not have
Auto have auto TMS download after settlement.
7 Fields Type
Attribute Description
ANS Alpha, Numeric and Special characters
AN Alpha and Numeric characters
N Numeric characters
Z Numeric Data plus '=' character
This is used for Track 2 data, where the '=' is the separator between the card
number and the rest of the data.
$ Amount.
Numeric characters indicating number of cents. No $ sign or decimal point is
B included.
Binary Data
The data is a stream of bytes that could take any value.
T Telephone Number Data
Valid characters are 0-9, *, #, space, -, and a comma or a P for a dial tone pause.
Field Type Field Data Length Attribute

01 Approval Code 6 ANS
02 Response Text 40 ANS
03 Transaction Date 6 N
YYMMDD
04 Transaction Time 6 N
HHMMSS
16 Terminal ID 8 ANS
30 Card Number …19 N
31 Expiration Date 4 N
YYMM
DC Card Number last 4 Digit 4 N
40 Amount 12 $
$12.34 -> 000000001234
50 Batch Number 6 N
65 Invoice Number 6 ANS
D0 Merchant Name and 69 ANS
Address
D1 Merchant ID 15 N
D2 Card Issuer Name 10 ANS
D3 Retrieval Reference 12 ANS
Number
D4 Card Issuer ID 2 N
D5 Card Holder Name 26 ANS

D8 ECR Reference No 19 or 20 ANS
91 Amount Redeem 12 ANS
96 Loyalty Info .999 ANS
97 Trace No 6 N
98 Entry Type : 10 ANS
Manual
Swipe
Fallback M
Fallback S
Chip
PAYPASS
PAYWAVE
9A AID ..16 B
9B AP ..16 ANS
9C Cryptogram Information 1 B
Data
9D Application Cryptogram 8 B
9E TVR 5 B
9F TSI 2 B
HN NII 3 ANS
HM Settlement Data .999 ANS
N0 Number of receipt 1 N
0 – No receipts
1 – One Receipts,
2 – Two Receipts
3 – Customer Copy Only
4 – Merchant Copy Only
N1 Merchant Receipt 4 N
Length
N2 Merchant Receipt Data .9999 ANS
N3 Customer Receipt 4 N
Length
N4 Customer Receipt Data .9999 ANS
N6 Next Record 3 ANS
P1 Transaction Currency 3 AN
Code
P2 Transaction Amount 12 $
P3 Decimal Place 1 N
P4 Exchange Rate 9 $
P5 Decimal Place 1 N
P7 Number of Host to Settle 2 N
P8 Number of Host Settle 2 N
Successfully
X1 Receipt Required 2 ANS
I1 IPP Plan Code 3 ANS
I2 IPP Tenure 2 ANS
I3 IPP Total Amt 12 ANS
I4 IPP Monthly Instalment 12 ANS
Amount
I5 IPP First Payment 12 ANS
Amount
I6 IPP Last Payment 12 ANS
Amount
33 Reference No 12 ANS
34 MMDD 4 ANS
35 QR Type .999 ANS
36 Card Token 20 ANS (Must be 20 length)
37 Use/Add Token 1 ANS
CN UPI Coupon Number .99 ANS
D6 Wechat/Alipay Trans ID/ .99 ANS
PAYNOW Txn Ref No
D7 Alipay Order No/ .99 ANS
PAYNOW Ref Number
8 Authorisation Transaction
8.1 SALE
This command sent to Terminal to perform a Credit card Sale transaction.
The simplest POS command is to send only the amount. Terminal will take its own internal invoice
no and sent to host.
If the Invoice no is sent to the terminal, Terminal will use the POS invoice number to send to
message to host If the POS required the receipt to be printed, the POS can include the field type
X1. Upon transaction approved, the terminal will response to POS with same receipt format that
is printed on the physical receipt. POS can choose to use this to print or use the response field
to print the required data.
Request
Field Type Field Name Reqd/Optl Comments
40 Amount REQD
65 Invoice No OPTL
D8 ECR Reference No REQD
00,10,11,
X1 Receipt Required OPTL
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
QR QR Code Scan by OPTL Can be UPI QR (BarCode not
Merchant POS scanner supported)
WECHAT (Bin start – 10 – 15)
ALIPAY ( length 16-24 digits , Bin
start 25 – 30)
36 Token No OPTL (0 - 9)(A-Z) no small capital
(Must be 20 length)
37 Use/Add Token OPTL “0” – Use Token
“1” – Add Token
DC Last 4 digit of Card No. OPTL Sent only when Use/Add Token=0
31 Expiration Date OPTL Sent only when Use/Add Token=0
YYMM
Response
02 Response Text REQD Text will be 40 characters long
organized as 2 lines of 20
D0 Merchant Name and REQD 69 characters, organized as 3 lines

Address of 23 characters
03 Transaction Date REQD
04 Transaction Time REQD
01 Approval Code APPR
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
D2 Card Issuer Name APPR
30 Card Number APPR
31 Expiration Date APPR
50 Batch Number APPR
D3 Retrieval Reference APPR
Number
D4 Card Issuer ID APPR See note (1) below
9A AID APPR EMV Data
9B AP APPR EMV Data, if return data is 00 00
00 00 …., print empty
9C Cryptogram Information APPR EMV Data
Data
9D Application Cryptogram APPR EMV Data
9E TVR APPR EMV Data
9F TSI APPR EMV Data
D5 Card Holder Name OPTL
91 Amount Redeem OPTL
96 Loyalty Info OPTL See note (2) below
99 Loyalty Info (2) OPTL See note (3) below
97 Trace No APPR
98 Entry Type APPR
P1 Transaction Currency OPTL For DCC sale, this is the DCC
Code currency code. For local sale, this
is “SGD”
P2 Transaction Amount OPTL For DCC, this is the DCC amount
P3 Decimal Place OPTL Transaction amount decimal place
P4 Exchange Rate OPTL For Local Refund, this will be “1”
P5 Decimal Place Exchange Rate decimal place
D8 ECR Reference No / OPTL
Order Number
N0 Number of receipts OPTL Receipt Required != 00
N1 Merchant Receipt OPTL If Receipt Required == x1

Length
If Receipt Required == x1
N2 Merchant Receipt Data OPTL
If Receipt Required == 1x.
N3 Customer Receipt OPTL
Length
N4 Customer Receipt Data OPTL
D6 WeChat/AliPay Trans ID OPTL
D7 Alipay Order No OPTL
Note (1)
Card Issuer ID: (D4)
1st Char 2nd Char Card Type
0 4 On Us Visa
0 5 On Us Mastercard
1 4 Off Us Visa
1 5 Off Us Mastercard
1 6 DINERS
1 7 AMEX
1 8 JCB
1 A UNIONPAY
1 B WECHAT
1 D ALIPAY
1 E PAYNOW
Note (2) :
Field Type 96
Trans Amount 12 ANS

Net Amount 12 ANS
Redeem Amount 12 ANS
No of pools 1 BCD
Club Id 3 ANS Repeat for the no of pools
Pool Id 3 ANS Repeat for the no of pools
Redeem Amount 12 ANS Repeat for the no of pools
If Club Id isUNI : Redeem UNI$ , see IRR Redeem
Amt ($) for actual $ Value.
Award Amount 12 ANS Repeat for the no of pools
Point Balance 1 ANS Repeat for the no of pools
Balance Amount 12 ANS Repeat for the no of pools

Pool Description 30 ANS Repeat for the no of pools
IRR Club Id 3 ANS To be matched against the Club ID above and printed
before the cluib Redeem Amt , award amt and Bal
amt
IRR QTY 2 ANS
IRR Description 40 ANS
IRR Redeem Amt 12 ANS The actual amount ($) value for the IRR that is
($) redeem,
Note (3) :
Field Type 99 For SPC
Discount Amt 12 Ans
Base Amount 12 Ans
Nett Amount 12 Ans
Redeem Amount 12 Ans Total of Redeem ($ Value) in all Pools
No of pools 1 BCD
Club Id 3 Ans
Pool Id 3 Ans
Redeem Amount 12 Ans
Redeem ($ Value) 12 Ans Example $ redeem for UNI$
Award Amount 12 Ans
Point Balance 1 ANS
Balance Amount 12 ANS
Pool Description 30 Ans
IRR Club Id 3 ANS To be matched against the Club ID above and printed
before the cluib Redeem Amt , award amt and Bal
amt
IRR QTY 2 ANS
IRR Description 40 ANS
IRR Redeem Amt 12 ANS The actual amount ($) value for the IRR that is
($) redeem,
Command Sample
a) SALE transaction with only Amount of $12.34
00 35 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30 30 30 1C 34 30 00 12 30 30 30 30 30 30
30 30 31 32 33 34 1C 03 11
Breakdown:
Transport Presentation Field

STX Len Header Header Type
Len
02 00 35 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30 30 30 1C 34 30 00 12
30 30 30 30 30 30 30 30 31 32 33 34 1C 03 11
Data ETX LRC
b) SALE transaction with only Amount of $12.34 with Invoice No 004567

02 00 46 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30 30 30 1C 34 30 00 12 30 30 30 30 30
30 30 30 31 32 33 35 1C 36 35 00 06 30 30 34 35 36 37 1C 03 7A
c) SALE transaction with only Amount of $12.34 with Invoice No 004567 and Receipt Required
02 00 53 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30 30 30 1C 34 30 00 12 30 30 30 30 30
30 30 30 31 32 33 36 1C 36 35 00 06 30 30 34 35 36 38 1C 58 31 00 02 31 31 1C 03 14
8.2 VOID
This command void the SALE or Refund transaction based on the invoice no. The invoice no
must be in the current batch. If the transaction has been settled, void will not be allowed, instead
a Refund can be done.
Request
65 Invoice No OPTL
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
D4 Card Issuer ID APPR See note below
9B AP APPR EMV Data
Data

97 Trace No APPR 6
98 Entry Type APPR 10
is “SGD”
Order Number
N0 Number of receipt OPTL Receipt Required != 00
Length
Length
8.3 REFUND
This command will refund the transaction amount back to customer credit card.
Request
40 Amount REQD
65 Invoice No OPTL
DC Last 4 digit of Card No. OPTL Must sent together with Field 01
for Hotel Solution Only
01 Approved Code OPTL Must sent together with Field DC
for Hotel Solution Only
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
33 UPI Original Txn Ref No OPTL For UPI Refund Only
for Hotel Solution Only and QR
34 UPI Original Txn MMDD OPTL For UPI Refund Only
for Hotel Solution Only and QR
35 QR Type OPTL “ALIPAY”, “UPI”
D7 Alipay Order Number OPTL
(Must be 20 length)
Cannot Send Field D8 if this is use
37 Use/Add Token OPTL “0” – Use Token Only
YYMM
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data
97 Trace No APPR 6
is “SGD”
Order Number
Length
Length
D6 Alipay Trans ID OPTL
8.4 TIPS ADJUST

This command will adjust the tips amount the transaction.
Request
65 Invoice No REQD
41 Tips Amount REQD
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data
97 Trace No APPR 6

is “SGD”
Order Number
Length
Length
8.5 OFFLINE SALE
Request
40 Amount REQD
65 Invoice No OPTL
01 Approved Code OPTL
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data

97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.6 INSTALMENT

40 Amount REQD
65 Invoice No OPTL
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data
I1 IPP Plan Code OPTL
I2 IPP Tenure OPTL

I3 IPP Total Amt OPTL
I4 IPP Monthly Instalment OPTL
Amount
I5 IPP First Payment OPTL
Amount
I6 IPP Last Payment OPTL
Amount
97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.7 PRE-AUTH
Request
40 Amount REQD
65 Invoice No OPTL
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
QR QR Code Scan by OPTL Can be UPI QR (BarCode not
Merchant POS scanner supported)
WECHAT
ALIPAY
35 QR Type OPTL “ALIPAY”, “ALIPAYMPM”
(Must be 20 length)
YYMM
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR

Number
9B AP APPR EMV Data
Data
97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.8 PRE-AUTH TOPUP
Request
40 Amount REQD
D8 ECR Reference No OPTL Can be sent together with Field 01
and DC
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data

97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.9 SALE COMPLETION
Request
40 Amount REQD
D8 ECR Reference No OPTL
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
35 QR Type OPTL “ALIPAY”
D7 Alipay Order Number OPTL
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data

97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.10 AUTH REVERSAL
Request
40 Amount REQD
and DC
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
35 QR Type OPTL “ALIPAY”
D7 Alipay Order Number OPTL Field 40 (Amt need to send)
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data
Data

97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.11 INCIDENTAL CHARGE
Request
40 Amount REQD
and DC
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
9B AP APPR EMV Data

Data
97 Trace No APPR
98 Entry Type APPR
Order Number
Length
Length
8.12 QR INQUIRY
This command is to INQUIRY the previous QR Txn if successful. See section 13

for flow.
Request
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
97 Trace No APPR 6
Order Number
Length
Length
D6 Wechat/Alipay Trans ID/ OPTL
PAYNOW Txn Ref No
D7 Alipay Order No/ OPTL
PAYNOW Ref Number
8.13 QR MERHCANT PRESENTED MODE SALE (MPM- UPI, WECHAT, ALIPAY)
Request
40 Amount REQD
65 Invoice No OPTL
“ALIPAY”,
35 QR Type REQD
“WECHAT”,
“UPI”
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
97 Trace No APPR 6
Order Number

Length
Length
D6 Alipay Trans ID/ OPTL
PAYNOW Txn Ref No
D7 Alipay Order No/ OPTL
PAYNOW Ref Number
8.14 QR MERHCANT PRESENTED MODE PREAUTH ( ALIPAY Only)
Request
40 Amount REQD
65 Invoice No OPTL
“ALIPAY”
35 QR Type REQD
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy
Response
65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
97 Trace No APPR 6
Order Number

Length
Length
8.15 CARD TOKENIZATION
Request
36 Token No REQD (0 - 9)(A-Z) no small capital
(Must be 20 length)
30 Card Number OPTL
31 Expiration Date OPTL
YYMM
Response
36 Token No REQD (0 - 9)(A-Z) no small capital
30 Card Number APPR
DC Last 4 digit of Card No. REQD
31 Expiration Date REQD
YYMM
8.16 UPI COUPON SALE
Request
40 Amount REQD
65 Invoice No OPTL
CN Coupon QR code or OPTL Coupon No
Barcode Scan by
Merchant POS
scanner
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy

65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
97 Trace No APPR 6

Order Number
Length
Length
8.17 PAYNOW
Request
40 Amount REQD
65 Invoice No OPTL
00,10,11,
[x][y]
[x] : Customer Copy
[y] : Merchant Copy

65 Invoice No APPR
16 Terminal ID APPR
D1 Merchant ID APPR
30 Card Number APPR
Number
D4 Card Issuer ID APPR “1E”
97 Trace No APPR 6
Order Number

Length
Length
D6 PAYNOW Txn Ref No OPTL
D7 PAYNOW Ref Number OPTL
9 Administrative Transactions
9.1 SETTLEMENT
Request
HN NII REQD “000”.
Response
P7 Number of Host to Settle REQD
P8 Number of Host Settled REQD If P8 != P7 , mean there is still
Successfully pending host settlement not done,
Retry settlement for remaining
host.
HM No of Host 4
Host Name 1 25 Eg UOB-LOYALTY / UOB-
ONUS (See Note 1)
No of Card Name 1
Card Name 1 20 E,g LOYALTY VISA (See
Note 2)
Sale Count 3
Sale Amount 12
Refund Count 3
Refund Amount 12
Offline Count 3
Offline Amount 12
Discount Count 3
Discount Amount 12
Void Sale Count 3
Void Sale Amount 12
Void Refund Count 3
Void Refund Amount 12
Void Cash Count 3
Void Cash Amount 12
No of Club 2 “0” if no club
Club ID 1 3 This field will not be there if
No of club id is “0”
Pool Id 1 3 This field will not be there if
Redeem Count 3 This field will not be there if

Redeem Amount 12 This field will not be there if
Award Count 3 This field will not be there if
Award Amount 12 This field will not be there if
Club ID N Repeat above is no of club if
more than “1”
…
Card Name N Next card Name : LOYALTY
MASTERCARD
…
Host Name N 25
No of Card Name 1
Card Name N 20
Sale Count 3
Sale Amount 12
Refund Count 3
Refund Amount 12
Offline Count 3
Offline Amount 12
Cash Count 3
Cash Amount 12
Void Sale Count 3
Void Sale Amount 12
Void Refund Count 3
Void Refund Amount 12
Void Cash Count 3
Void Cash Amount 12
No of Club 1
Club ID 1 3
Pool Id 1 3
Redeem Count 3
Redeem Amount 12
Award Count 3
Award Amount 12
…….
(See Note 1)
Available HOST Name :
1. UOB-ONUS
2. UOB-LOYALTY
3. UOB-JCB
4. AMEX
5. USD
6. MYR
7. IDR
8. AUD
9. EUR
10. JPY
11. HKD
12. GBP
13. THB
14. PHP
15. KRW
16. INR
17. CNY
18. TWD
19. CHF
20. NZD
21. CAD
22. LKR
23. MOP
24. VND
25. DINERS
26. UNIONPAY
27. MOTO
28. ALIPAY
Note 2:
1. VISA ONUS
2. LOYALTY VISA
3. VISA OFFUS
4. MASTERCARD ONUS
5. LOYALTY MASTERCARD
6. MASTERCARD OFFUS
7. AMEX
8. DINERS
9. UNIONPAY
10. ALIPAY
9.2 SUMMARY/DATAIL/LAST SETTLEMENT/ANY RECEIPT
Request
52 Last Settlement Receipt OPTL “000”.
53 Detail Receipt OPTL “000”.
54 Summary Report OPTL “000”.
Invoice Number to be printed.
5B Print Any Receipt OPTL
“000000” for Last Receipt.
Printing Data package Value “xxx” BCD format to the next
5C REQD
data package to receive. For the
sequence value
first packet, the value will be “001”.
Data package will be received in
sequence. Eg, 002, 003…
If the Terminal response with
“000”, the POS will not sent the
request anymore as it indicated by
the terminal that there is no more
data to print.
configs.rar
Response
5D Printing Data APPR Receipt value to be printed
“00X” indication next record
5E Next Record APPR
available. For example, if Terminal
return 002, POS will sent in 002 for
the next request.
A “000” represent no more record
9.3 TEST DIAL
Request
No request Field Type Needed
Response
T1 IP Host 1 APPR “0” = Not tested,
“1” = Success,
“2” = Not Successful.
T2 IP Host 2 APPR As above
T6 Dial Host 1 APPR As above
5D Printing Data APPR Test Dial Printed Message
9.4 TMS DOWNLOAD
If POS vendor or merchant need to get last settlement report, they need to
request UOB to disable the Auto TMS download function on terminal.
POS vendor need to implement this command if the need to trigger TMS
download after they get the last settlement report.
Failing to implement this command will deem certification failed.
Request
No request Field Type Needed
Response
No Response Field Needed
10 Sample Commands
1 Sale 02 00 35 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 31 32 33
34 1C 03 11
2 Sale with Invoice 02 00 46 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
Number 30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 31 32 33
36 1C 36 35 00 06 31 32 33 33 33 34 1C 03 7D
3 Sale with ECR 02 00 59 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
Reference 30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 31 32 33
Number 38 1C 44 38 00 19 30 30 30 30 30 30 30 30 31 32 33 32
33 32 32 33 33 32 34 1C 03 3F
4 Sale with Invoice 02 00 70 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
number and ECR 30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 30 31 31
refence number 32 1C 36 35 00 06 30 30 31 32 33 35 1C 44 38 00 19 30
30 30 30 30 30 30 30 30 30 30 30 31 32 33 34 35 36 38
1C 03 08
5 Sale with 02 00 42 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
customer receipt 30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 30 31 31
33 1C 58 31 00 02 31 30 1C 03 17
6 Sale with 02 00 42 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
Merchant receipt 30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 30 31 31
34 1C 58 31 00 02 30 31 1C 03 10
7 Sale with Both 02 00 42 36 30 30 30 30 30 30 30 30 30 31 30 32 30 30
Customer and 30 30 1C 34 30 00 12 30 30 30 30 30 30 30 30 30 31 31
Merchant receipt 35 1C 58 31 00 02 31 31 1C 03 10
Sample Response:
02052036303030303030303030313132303030301C3032004020202020202020202
0202020415050524F56414C20202020202020202020202020203538343832311C4
430006945572074657374696E6700000000000000000000000000323438204C6F72
6F6E6720310000000000000000000000546F61205061796F6800000000000000000
000000000001C303300063138303731301C303400063135313031351C303100063
538343832311C363500063030303138371C3136000838383838383838311C44310
0153030303030313031303030353339351C443200104D4153544552002020201C3
33000163534393833342A2A2A2A2A2A383932341C33310004313930341C353000
063030303030391C443300123135313031353030303435381C4434000231351C39
410007A00000000410101C394200164D6173746572436172640000000000001C39
430001401C394400087A25C8241C039B3B1C3945000500000080001C39460002E
8001C4435002654414E20454E47205741482020202020202020202020202020201
C393700063030303435381C39380010436869702020202020001C5031000353474
41C503200123030303030303030313030301C50330001321C50340009313030303
0303030301C50350001381C44380020313830373130313531303233383838383838
38311C4E300001301C4E310004303030301C4E330004303030301C03BE
Please note that the one highlight BLUE is not at ETX.
VENDORS should not use this 1C03 to determine is the ETX.
The should use the Length 0520 to determine the receive data is completed before
calculating the LRC after the ETX(03)
11 Receipt Printing Format For Kiosk
For Kiosk System where Customer receipt will be printing by the Kiosk instead from
terminal, the Kiosk shall print the fields listed below:
03 Transaction Date
04 Transaction Time
16 Terminal ID
D1 Merchant ID
01 Approval Code
65 Invoice No
30 Card Number
D3 Retrieval Reference
Number
D4 Card Issuer ID
97 Trace No
98 Entry Type
12 UPOS using NETS ECR 2 Specification
Please refer to NETS ECR 2 Interface specification, Annex G. 3rd Party Command
Pass-Through
Request
SL E L
TE Message Header Message Data 1 T R
XN X C
Function Version 3rd Party Command Request - Refer to UOB
ECN RFU Separator
Code Code Commands in Section 8
POS Terminal
Message Header Description

Len
Name Attribute Remark
(Bytes)
ECR Control Number
A numbering sequence that the ECR

ECN ASC 12 define.
The number must be unique to every

Function request.
Function
ASC 2 3rd Party Function Code
Code
Version Code ASC 2 “02” (0x30 0x32) – UOB Commands
RFU ASC 1 Value is 0 (0x30)
Separator HEX 1 Value is (0x1C)
Response
SL E L
TE Message Header Message Data 1 T R
XN X C
Function Response
ECN RFU Separator 3rd Party Command Response
Code Code
POS Terminal
Message Header Description

Len
Name Attribute Remark
(Bytes)
ECN ASC 12 Echoes from the request
Function
ASC 2 Echoes from the request
Code
POS should ignore this response code
Response
ASC 2 and take the response code is UOB
Code
Respsone
RFU ASC 1 Value is 0 (0x30)
Separator HEX 1 Value is (0x1C)
Sample:
SALE $1234, ECR No 1234567890123400001 using VISA Paywave
Request:
02007730303030303331323433393432303032301C3630303030303030303031303
2303030301C343000123030303030303030313233341C4438001931323334353637
3839303132333430303030311C0338
Response:
02040730303030303331323433393432303032301C3630303030303030303031313
2303030301C30320040202020202020202020202020415050524F56414C2020202
0202020202020202020203632303336381C443000694D45524348414E54204E414
D450000000000000000000041444452455353203100000000000000000000000000
0041444452455353203200000000000000000000000000001C30330006313930333
2321C303400063135343833361C303100063632303336381C36350006303030313
0381C3136000836323530393437361C443100153030303030313035303338373837
371C44320010564953410020202020201C333000163431383233382A2A2A2A2A2
A373136321C33310004313931301C353000063030303030331C443300123135343
833363030303136391C4434000230341C39410007A00000000310101C394200160
00000000000000000000000000000001C39430001001C394400083F16176B1C031
2A61C3945000500000000001C3946000200001C393700063030303136391C39380
010504159574156452020201C0358
13 QR Transaction flow with Inquiry
This flow applies for all QR txn, Wechat , Alipay, UPI, and Paynow
14 POS Log Files Format
POS Vendors are to log all commands sent and received into their POS and
provided for investigation if any after system goes live, They are also need to provide
the log file for verification before system goes live.
SAMPLE of Log file format
6/5/2020::11:32:40 AM::Send COMMAND ::

02004736303030303030303030313032303030301C3430001230303030303030303
03230301C44380007313132303534331C0332
6/5/2020::11:32:40 AM::ACK RECEIVED
6/5/2020::11:32:44 AM::Received Response ::
02043836303030303030303030313132303030301C3032004020202020202020202
0202020415050524F56414C20202020202020202020202020203533353432331C4
4300069494354323230205465737400000000000000000000000051332054657374
205465726D696E616C000000000000004144445245535320320000000000000000
0000000000001C303300063230303630351C303400063131333234311C30310006
3533353432331C363500063030303037341C3136000830303031313035301C4431
00153030303030303030303030303030311C443200104D4153544552002020201C
333000163534333933312A2A2A2A2A2A333230381C33310004323231301C35300
0063030303030321C443300123131333234313030303131311C4434000231351C3
9410007A00000000410101C39420016000000000000000000000000000000001C3
9430001001C3944000881F4B03F7E48846E1C3945000500000080001C39460002
00001C393700063030303131311C39380010504159504153532020201C44380020
31313230353433202020202020202020202020201C4E300001301C4E3100043030
30301C4E330004303030301C037E
6/5/2020::11:32:44 AM::LRC Compare :: 126::126
6/5/2020::11:32:44 AM::LRC Matched. Send ACK
15 Testing Cases
S/no Response Amount to Use

1. To Test for Credit Card Declined Txn (Do not $88.88
Honor -05)
2. To Test for QR Transaction with “IN” $0.05
Response

UOB ECR Specification V1.17

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

UOB ECR Specification V1.17

Uploaded by

Copyright:

Available Formats

UOB - ECR Interface Specification Version 1.

UOB - ECR Interface

1. 06 Added INCIDENTAL CHARGE 14/06/2018

6 Transaction Codes Support by Terminal ........................................................... 17

This document provides information on how an external device, such as a cash

2 Message Exchange Sequence

2.1 Communication Protocol

2.1.1 Communication parameter

The terminal model interfaces through an asynchronous serial communications port

Baud Rate 9600

2.1.2 Control Character

Start of Text STX 0x02

2.1.3 Message Checksum

STX Length of Message Data ETX LRC

2.2 Connection diagram

2.2.2 ECR Cable

3 Message REQUEST and RESPONSE Protocol

3.2.1 NACK is received by the external device.

Electronic Resend Request immediately

Resend Request immediately

No response (No ACK)

Electronic Resend Request after 2 sec Terminal

Resend Request after 2 sec

Send ACK (06)

Re-send response after 2 sec

Re-send response after 2 sec

3.2.4 NACK is received by the terminal.

Send ACK (06)

Send Response Terminal

Electronic Send NACK (0x15)

Send NACK (0x15)

Re-send response immediately

Send NACK (0x15)

3.2.5 No response from terminal after Acknowledgement is received by the

S LLLL MESSAGE DATA E L

Transport Presentation Field Data

Field Bytes Value Description

MESSAGE LLLL The message data consists of a Transport

5.1 Transport Header

5.2 Presentation Header

Field Bytes Value Description

Field Separator 1 0x1C This field is used to make it easier to identify

5.3 Field Data

5.3.1 Field Element Format

FIELD ELEMENT FORMAT

Field Bytes Value Description

5.4 Response Code

6 Transaction Codes Support by Terminal

Field Type Field Data Length Attribute

D5 Card Holder Name 26 ANS

D0 Merchant Name and REQD 69 characters, organized as 3 lines

N1 Merchant Receipt OPTL If Receipt Required == x1

Trans Amount 12 ANS

Balance Amount 12 ANS Repeat for the no of pools

Transport Presentation Field

Data ETX LRC

b) SALE transaction with only Amount of $12.34 with Invoice No 004567

9F TSI APPR EMV Data

8.4 TIPS ADJUST

98 Entry Type APPR 10

8.5 OFFLINE SALE

91 Amount Redeem OPTL

Field Type Field Name Reqd/Optl Comments

I2 IPP Tenure OPTL