Synchronous Mode

Messages in synchronous mode require a response from the POS application. They are typically sent by IPC so the EPOS operator can enter additional transaction data e.g. manual authorisation details where a card has been referred; or can influence the transaction flow.

The request from IPC is in the form of key value pairs sent on the Message port. The response from the EPOS application should be sent on the same port.

Following is the list of attributes IPC can send during transaction:

Description

Attribute Name

Data Type

Length

Request Type. Request Type indicates which type of input is required from EPOS application

Additional values may be added with new releases of IPC

Request Type

Description

400

Voice authorization

401

Signature verification

402

Fallback confirmation

403

CNP details confirmation

405

Cashback confirmation

407

Address, ZIP entry

2

Integer

3

User Message, IPC sends the relevant message based on the transaction state and request type

3

Alpha Numeric and Special characters

0-100

Acquirer MID, in case of voice authorization

11

Numeric

6-15

Acquirer contact number, in case of voice authorization request. Multiple contact number is separated by comma

12

Numeric

10-16

End of message indicator, values always 0.

99

Numeric

1

Following is the list of attributes EPOS can send during transaction:

DescriptionAttribute NameData TypeLength
Request Type. Same request type, received from IPC, must be sent back to IPC2IntegerNA
User, value 0 represents accept and else rejected3Integer1
Authorization code, if IPC issues request for voice authorisation confirmation and auth code. If the merchant wants to accept the transaction then auth code needs to be sent in this field.4Alpha Numeric6
Cashback Amount, if IPC issues request for cashback confirmation and cashback amount and customer wants cash back then cashback amount needs to be sent in this field5DecimalNA
Address; provide address in this field if address is requested to be sent to IPC.7Alpha NumericNA
Zip; provide ZIP code in this field if ZIP is requested to be sent to IPC.8Alpha NumericNA

The synchronous mode example below is for a Sale transaction where IPC requests Accept/Reject Signature

Event GUIRequest Socket port e.g. 10000Message port e.g. 8000Message lookup from MessageBundle_en_GB.properties
EPOS sends sale transaction request on socket port1=1234
2=0
3=21.99
99=0
31 3D 31 32 33 34 0D 0A 32 3D 30 0D 0A 33 3D 32 31 2E 39 39 20 0D 0A 39 39 3D 30
PED displays ‘INSERT/SWIPE CARD’info:ClearInstruction
ClearInstruction99=0
69 6E 66 6F 3A 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 39 39 3D 30
ClearInstruction=" "
PED displays ‘INSERT/SWIPE CARD’info:PlsInsSwpCrd99=0
69 6E 66 6F 3A 50 6C 73 49 6E 73 53 77 70 43 72 64 39 39 3D 30
PlsInsCrd=PLEASE INSERT CARD
PED displays ‘PLEASE WAIT’info:ChpWt99=0
69 6E 66 6F 3A 43 68 70 57 74 39 39 3D 30
ChpWt=CHIP : PLEASE WAIT
PED displays ‘PLEASE WAIT’info:Connecting...99=0
69 6E 66 6F 3A 43 6F 6E 6E 65 63 74 69 6E 67 2E 2E 2E 39 39 3D 30
Connecting…= Connecting…
PED displays ‘PLEASE WAIT’info:Authorising...99=0
69 6E 66 6F 3A 41 75 74 68 6F 72 69 73 69 6E 67 2E 2E 2E 39 39 3D 30
Authorising…= Authorising…
IPC requests EPOS application to confirm if signature is accepted

PED displays ‘REMOVE CARD’
2=401
3=AUTH CODE:00492DIs Signature Ok ?
99=0
32 3D 34 30 31 0A 33 3D 41 55 54 48 20 43 4F 44 45 3A 30 30 34 39 32 44 49 73 20 53 69 67 6E 61 74 75 72 65 20 4F 6B 20 3F 0A 39 39 3D 30 0A
PED displays ‘REMOVE CARD’info:PlsWt
ClearInstruction99=0
69 6E 66 6F 3A 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 39 39 3D 30
PlsWt=PLEASE WAIT…
EPOS applications responds that signature is accepted

PED displays ‘REMOVE CARD’
2=401
3=0
99=0
32 3D 34 30 31 0D 0A 33 3D 30 0D 0A 39 39 3D 30
PED displays ‘PLEASE WAIT ’info:PlsWt
ClearInstruction99=0
69 6E 66 6F 3A 50 6C 73 57 74 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 39 39 3D 30
PlsWt=PLEASE WAIT...
PED displays ‘APPROVED’info:AuthCd1 =00492D
AppdOl99=0
69 6E 66 6F 3A 41 75 74 68 43 64 31 20 3D 30 30 34 39 32 44 0A 41 70 70 64 4F 6C 39 39 3D 30
AuthCd=AUTH CODE:
PED displays ‘REMOVE CARD’info:PlsRmvCrd
ClearInstruction99=0
69 6E 66 6F 3A 50 6C 73 52 6D 76 43 72 64 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 39 39 3D 30
PlsRmvCrd=PLEASE REMOVE CARD
PED displays welcome message e.g. Worldpay – IPCinfo:ClearInstruction
ClearInstruction99=0
69 6E 66 6F 3A 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 39 39 3D 30
ClearInstruction=" "
Response received on socket port7=01072009
29=A0000000031010
6=VISA CREDIT
5=476173XXXXXX0119
4=00492D
10=VISA ACQUIRER
TEST CARD 01
14=1
1=5
22=153 Checknet House
East Barnet Road Barnet
Herts EN4 8QZ
12=21249872
23= Worldpay Demo
28=PGTR214582583
13=22980012
8=20092013
3=1
21=2
9=152302
2=0
34=PLEASE DEBIT
MY ACCOUNT
33=PLEASE KEEP
THIS RECEIPT FOR
YOUR RECORDS
36=88
37=1215
38=2199
41=0
30=1
31=F8 00
32=00 00 00 80 00
59=00000000000
00000000000000
60=004
98=1234
99=0

Accept/reject Signature

This request is issued by IPC on the message port when a transaction requires signature validation.

Request from IPC:

Copied!
2=401
3= AUTH CODE:XXXXXXIs Signature Ok ?
99=0

The response from the EPOS application is in the format below

Response from EPOS:

Copied!
2=401
3= 0  ( Accepted), 1 (Rejected)
99=0

Referral Request

This request is issued by IPC on the message port when a transaction is referred by the acquiring bank and requires the EPOS application either to reject it or to supply a manual authorisation code to complete it.

The IPC request provides the information required by the EPOS operator to contact the acquiring bank i.e. the contact numbers and the merchant id (MID) in use for the transaction.

Request from IPC:

Copied!
2=400
3=CALL BANK Amount:xx.xx
11=MID e.g. 21249872
12=Acquirer contact numbers e.g. 02083871299,02083871295
99=0

Response from EPOS:

Copied!
2=400
3=0 (Accepted), 1  (Rejected)
4=Authorisation Code received from bank (Present only if the above value is 0)
99=0

Fallback Confirmation Request

This request is issued if a transaction requires card fallback i.e. the card cannot be verified using the optimum method available on both the card and terminal. IPC issues this request when a magnetic swipe card falls back. The intention is that the sales operator may reject fallback and thereby cancel the transaction if there is any doubt about it.

Request from IPC:

Copied!
2=402
3= Swipe card fallback allowed ?
99=0

Response from EPOS:

Copied!
2=402
3= 0 (Accepted), 1 (Rejected)
99=0

CNP Confirmation Request

IPC will send this request to EPOS application for CNP Confirmation if merchant has selected AVS details Mandatory in YESEFTConfig. However, if merchant has selected AVS details Mandatory and Apply AVSRules in YESEFTConfig then IPC will not send this request.

Request from IPC:

Copied!
2=403
3=Security Code Matched, Address Matched, ZIP code Matched
99=0

Response from EPOS:

Copied!
2=403
3= 0  (Accepted), 1 (Rejected)
99=0

Cashback Confirmation Request

Where IPC is enabled to allow cashback, and a cashback candidate card is read by the PED, IPC will send this request to the EPOS application to confirm cashback, and the cashback amount. If the cashback amount is greater than the allowed limit, IPC sends an error message and will attempt the cashback request twice more. If IPC does not receive valid amount in three attempts then IPC will process the transaction with the original amount.

Request from IPC:

Copied!
2=405
99=0

Response from EPOS:

Copied!
2=405
3= 0 (Accepted), 1 (Rejected)
5=Cashback amount (present only if the above value is 0) e.g. 50.00
99=0

Address and Postcode (ZIP code) Enter Request

The Address and Postcode (ZIP code) request is issued under these scenarios:

CNP transaction

If the merchant has selected ‘AVS details Mandatory’ in YESEFTConfig, IPC will always send the request below to the EPOS application to prompt for entry of CNP address and postcode/ZIP code details. However, if the merchant has selected ‘AVS details Mandatory and Apply AVSRules’ in YESEFTConfig, this request will be sent according to the AVS confirmation rules set. Similarly, if the merchant has selected only ‘Apply AVSRules’ in YESEFTConfig, then IPC will send this request according to the AVS confirmation rules.

Keyed/Forced keyed Referral transaction

This request is issued on message port for Keyed/Forced keyed referral transactions if IPC is being used with Worldpay US acquirer using the Vx820 PED. IPC prompts for Card number, expiry date, CVV and State code on the PED. CVV and State code are not mandatory entries.

After these entries on the PED are complete, IPC will send the request below to the EPOS application for Address and ZIP code entry. If the merchant does not have the values for Address and ZIP code then both the fields can be sent empty with accept response (3=0). In the Keyed/Forced keyed scenario this message port request is not configurable through the AVS details tab.

Request format

According to the CNP rules configured, the application can prompt

Only for Address, request from IPC :

Copied!
2=407
3=Address
99=0

Expected Response from POS:

Copied!
2=407
3=(Accepted), 1 (Rejected)
7=Cardholder Address
99=0

Only for ZIP code, request from IPC:

Copied!
2=407
3=ZipCode
99=0

Expected Response from POS

Copied!
2=407
3=(Accepted), 1 (Rejected)
8=Cardholder Zipcode
99=0

For both Address and ZIP code, request from IPC:

Copied!
2=407
3=Address,ZipCode
99=0

Expected Response from POS:

Copied!
2=407
3=(Accepted), 1 (Rejected)
7=Cardholder Address
8=Cardholder Zipcode
99=0

Cancel Transaction Request

This request is issued by IPC on the message port after having commenced a new transaction (Sale or Refund). Whilst the ‘Insert or Swipe Card’ message is displayed on the PED. the transaction may be cancelled by sending a string formed of the keyword ‘Cancel’ on the message port.

The string is not case sensitive can be send in either capital or small letters.