- Home
- All APIs
- Worldpay Total
- Asynchronous Mode
Asynchronous Mode
Messages in asynchronous mode advise progress of the transaction and require no response from the EPOS application. The message is in the form of key value that can be used to look up the full message text in file YESEFT/properties/MessageBundle_en_GB.properties. The POS application can choose to display the message text from the file or replace it with its own preferred text.
The asynchronous mode example below is for a Sale transaction:
Event GUI | Request Socket port e.g. 10000 | Message port e.g. 8000 | Message lookup from MessageBundle_en_GB.properties |
---|---|---|---|
EPOS sends sale transaction request on socket port | 1=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 learInstruction99=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 ‘ENTER PIN’ | info:EntPin ClearInstruction 99=0 69 6E 66 6F 3A 45 6E 74 50 69 6E 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 20 39 39 3D 30 | EntPin=ENTER PIN | |
PED displays ‘PIN OK 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 ‘PIN OK 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 ‘PIN OK 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… | |
PED displays ‘PIN OK PLEASE WAIT’ | info:Finalising…99=0 69 6E 66 6F 3A 46 69 6E 61 6C 69 73 69 6E 67 85 39 39 3D 30 | Finalising…=Finalising… | |
PED displays ‘APPROVED ’ | info:AuthCd1 =013028 AppdOl99=0 69 6E 66 6F 3A 41 75 74 68 43 64 31 20 3D 30 31 33 30 32 38 0A 41 70 70 64 4F 6C 39 39 3D 30 | AuthCd=AUTH CODE: AppdOl = APPROVED | |
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 ‘CARD REMOVED’ | info:CardRemoved ClearInstruction99=0 69 6E 66 6F 3A 43 61 72 64 52 65 6D 6F 76 65 64 20 0A 20 43 6C 65 61 72 49 6E 73 74 72 75 63 74 69 6F 6E 39 39 3D 30 | CardRemoved = CARD REMOVED | |
PED displays welcome message e.g. Worldpay – IPC | 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 | ||
EPOS receives IPC Response Request port | 7=01012004 29=A0000000041010 6=MASTERCARD 5=541333XXXXXX0045 4=013028 10=MTIP08-2 MCD 90A 14=2 1=5 22=153 Checknet House East Barnet Road Barnet Herts EN4 8QZ 12=21249872 23= Worldpay Demo 28=PGTR640970884 13=22980012 8=17092013 3=1 21=4 9=181628 2=0 34=PLEASE DEBITMY ACCOUNT 33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS 36=60 37=1214 38=2199 41=0 30=3 31=E8 00 32=00 00 00 80 00 59=0000000000000000 000000000000000000000 60=005 98=1234 99=0 |
Asynchronous mode messages
Sale
a) Sale - Chip
The request will have this format:
Request
1=reference number
2=0
3=amount
99=0
Message port messages illustration
info:pleaseWait99=0info:insertSwipeCardctls99=0info:chipCardInserted99=0info:pleaseWait99=0info:EnterPin99=0info:waitingMsg99=0info:connectingMsg99=0info:authorisingMsg99=0info:finalisingMsg99=0info:R_authCode =005751R_approved99=0info:CardRemovedClearInstruction99=0
info:insertSwipeCardctls99=0
info:chipCardInserted99=0
info:pleaseWait99=0
info:EnterPin99=0
info:waitingMsg99=0
info:connectingMsg99=0
info:authorisingMsg99=0
info:finalisingMsg99=0
info:R_authCode =005751
R_approved99=0
info:CardRemoved
ClearInstruction99=0
b) Sale - Swipe
The request will have this format:
Request
1=reference number
2=0
3=amount
99=0
Message port messages illustration
info:insertSwipeCardctls99=0info:cardSwiped swipedOk99=0info:pleaseWaitClearInstruction99=0info:connectingMsg99=0info:authorisingMsg99=02=401
3=AUTH CODE:096932, Is Signature Ok?
99=0
info:waitingMsgClearInstruction99=0info:finalisingMsg99=0info:R_authCode =096932R_approved99=0
info:cardSwiped swipedOk99=0
info:pleaseWait
ClearInstruction99=0
info:connectingMsg99=0
info:authorisingMsg99=0
2=401 3=AUTH CODE:096932, Is Signature Ok? 99=0 info:waitingMsg
ClearInstruction99=0
info:finalisingMsg99=0
info:R_authCode =096932
R_approved99=0
c) Sale - CTLS
The request will have this format:
Request
1=reference number
2=0
3=amount
99=0
Message port messages illustration
info:insertSwipeCardctls99=info:cardTappedClearInstruction99=0info:authorisingMsg99=0info:finalisingMsg99=0info:R_authCode =009554R_approved99=0
info:cardTapped
ClearInstruction99=0
info:authorisingMsg99=0
info:finalisingMsg99=0
info:R_authCode =009554
R_approved99=0
Refund
a) Refund - Chip
The request will have this format:
Request
1=reference number
2=20
3=amount
99=0
Message port messages illustration
info:insertSwipeCardctls99=0
info:chipCardInserted99=0info:pleaseWait99=0info:cardSwipedswipedOk99=0info:connectingMsg99=0info:authorisingMsg99=0info:waitingMsgClearInstruction99=0info:finalisingMsg99=0info:R_authCode =259152R_approved99=0info:plsRemoveCard99=0info:CardRemovedClearInstruction99=0
info:pleaseWait99=0
info:cardSwiped
swipedOk99=0
info:connectingMsg99=0
info:authorisingMsg99=0
info:waitingMsg
ClearInstruction99=0
info:finalisingMsg99=0
info:R_authCode =259152
R_approved99=0
info:plsRemoveCard99=0
info:CardRemoved
ClearInstruction99=0
b) Refund - Swipe
The request will have this format:
Request
1=reference number
2=20
3=amount
99=0
Message port messages illustration
info:insertSwipeCardctls99=0info:cardSwiped swipedOk99=0info:finalisingMsg99=0
info:R_authCode =10033R_approved99=0
info:cardSwiped swipedOk99=0
info:finalisingMsg99=0 info:R_authCode =10033
R_approved99=0
c) Refund - CTLS
The request will have this format:
Request
1=reference number
2=20
3=amount
99=0
Message port messages illustration
info:insertSwipeCardctls99=0info:cardTapped ClearInstruction99=0info:finalisingMsg99=0info:R_authCode =10059R_approved99=0
info:cardTapped ClearInstruction99=0
info:finalisingMsg99=0
info:R_authCode =10059
R_approved99=0
Sale CNP
When using the IntraMessage port, IPC allows entry of card details only from the PED (supported with iPP350, iWL250, Vx820 and P400). Once the below transaction request is received by IPC, the PED will prompt card number, expiry date and CVV (if CVV is configured in AVS Details tab in YESEFTConfiguration) entry. The remainder of the details are prompted for on the IntraMessage port based on AVS Details configured in YESEFTConfiguration.
The request will have this format:
Request
1=reference number
2=0
3=amount
12=1
99=0
Message port messages illustration
info:plsKeyCardDataClearInstruction99=0info:CardDatakeyEntSuccessful99=0
info:waitingMsgClearInstruction99=0info:connectingMsg99=0info:authorisingMsg99=0info:waitingMsgClearInstruction99=0info:finalisingMsg99=0info:R_authCode =000736R_approved99=0
ClearInstruction99=0
info:CardDatakeyEntSuccessful99=0 info:waitingMsg
ClearInstruction99=0
info:connectingMsg99=0
info:authorisingMsg99=0
info:waitingMsg
ClearInstruction99=0
info:finalisingMsg99=0
info:R_authCode =000736
R_approved99=0
Refund CNP
When using message port there is only an option to enter card details from the PED (supports with iPP350, iWL250, Vx820 and P400) is valid. Once you send the below transaction request, the PED will prompt card details entry.
The request will have this format:
Request
1=reference number
2=20
3=amount
12=1
99=0
Message port messages illustration
info:ClearInstruction
ClearInstruction99=0
info:PlsWt
ClearInstruction99=0
info:AuthCd1 =00026
AppdOffl99=0
info:ClearInstruction
ClearInstruction99=0
info:Finalising...99=0
Cancel
The request will have this format:
Request
1=reference number
2=3
5=masked card number i.e. as returned in IPC response message
6=expiry Date
13=PGTR
99=0
Message port messages illustration
info:plsKeyCardDataClearInstruction99=0info:CardDatakeyEntSuccessful99=0
info:waitingMsgClearInstruction99=0info:connectingMsg99=0info:authorisingMsg99=0info:waitingMsgClearInstruction99=0info:finalisingMsg99=0info:R_authCode =660272R_approved99=0
ClearInstruction99=0
info:CardDatakeyEntSuccessful99=0 info:waitingMsg
ClearInstruction99=0
info:connectingMsg99=0
info:authorisingMsg99=0
info:waitingMsg
ClearInstruction99=0
info:finalisingMsg99=0
info:R_authCode =660272
R_approved99=0
Check Card
The request will have this format:
Request
1=reference number
2=30
25=true/false
3=10.00(To enablecontactless mode)
99=0
Message port messages illustration
info:insertSwipeCardctls99=0
info:chipCardInserted99=0info:chipCardInsertedClearInstruction99=0info:plsRemoveCard99=0info:CardRemovedClearInstruction99=0info:pleaseWait99=0info:insertSwipeCardctls99=0
info:chipCardInserted99=0info:pleaseWait99=0info:EnterPin99=0info:waitingMsg99=0info:connectingMsg99=0info:authorisingMsg99=0info:finalisingMsg99=0info:R_authCode =005751R_approved99=0info:CardRemovedClearInstruction99=0
info:chipCardInserted
ClearInstruction99=0
info:plsRemoveCard99=0
info:CardRemoved
ClearInstruction99=0
info:pleaseWait99=0
info:insertSwipeCardctls99=0 info:chipCardInserted99=0
info:pleaseWait99=0
info:EnterPin99=0
info:waitingMsg99=0
info:connectingMsg99=0
info:authorisingMsg99=0
info:finalisingMsg99=0
info:R_authCode =005751
R_approved99=0
info:CardRemoved
ClearInstruction99=0
Note : Merchants will be able to perform Checkcard contactless transactions with zero amount
Check Card for Memory Card
This transaction type can be used to read SLE4442 Memory Card using 25=true with additional parameter (112=true) in input request.If the card read by IPC is successful then IPC will provide 1 to 8 digit long plain card number in the response. This functionality will work with iPP350 only.
##Note: This is a bespoke implementation. For further information , please connect with your Worldpay Contact.
Request
1=reference number
2=30
25=true
112=true
99=0
Message port messages illustration
info:insertBootsCard99=0
info:chipCardInserted ClearInstruction99=0
info:CardRemoved ClearInstruction99=0
info:reInsertBootsCard99=0
info:plsRemoveCard ClearInstruction99=0
info:CardRemoved ClearInstruction99=0
Last Transaction Status
No output message on message port
X – Report / Batch Totals
No output message on message port
Z – Report / End of Day
No output message on message port