Menu

Transaction Requests and Responses

This section lists the transaction requests to IPC and responses from the IPC.

The response message can vary according to the circumstances of the transaction, and not all fields shown in the example will be returned at all times. An example of this is the Checkcard transaction, where the response message is very different according to whether a valid card is read, or if the card was invalid e.g. a loyalty card from other merchant, unknown card. (In this case the definition of a valid card is one that falls into the bin ranges of payment cards, gift cards etc. that IPC is aware of).

It is possible for IPC to refuse to entertain a request because it is busy with another activity e.g. IPC is still completing its startup processing. In this case IPC will respond to the request with a busy status.

Examples for different transaction types:

Non transaction type specific examples:

Transaction Type examples

Sale

Request:

Copied!
1=2211
2=0
3=10.99
99=0

Response:

Copied!
7=01042002
29=A0000000031010
6=VISA BARCLAYCARD
5=492949XXXXXX2008
4=729945
10=BMSTESTCARDG6091/G
14=2
1=5
22=Checknet House, I53 East Barnet Road, Barnet EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR13513393
13=22980045
8=07092009
3=1
21=1
9=172748
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=5
37=0101
38=1099
41=0
30=0
31=F8 00
32=40 00 00 80 00
59=0000000000000000000000000000000000000000
60=004
98=2211
99=0

slide1.png

slide2.png

Refund

Request:

Copied!
1=123
2=20
3=10
99=0

Response:

Copied!
7=30121899
6=Maestro
5=679999XXXXXXXXX0919
4=10025
14=8
1=2
22=153 Checknet House East Barnet Road Barnet Herts EN4 8QZ
12=21249872
23=YESpay Demo
28=PGTR860970364
13=22980012
8=24082016
3=2
21=1
9=111100
2=20
34=PLEASE CREDIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=13
37=0101
38=1000
41=0
59=0000000000000000000000000000000000000000
60=009
80=000000000013
98=123
99=0

slide20.png

Sale CNP

Request:

Copied!
1=2214
2=0
3=10.99
12=1
99=0

Response:

Copied!
7=01082004
6=Visa
5=492949XXXXXX2008
4=831842
14=7
1=81
22=Checknet House 153 East Barnet Road Barnet Hertfordshire EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR73221377
15=0804
13=22980045
8=07092009
3=1
21=3
9=125044
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
35=422800
36=14
37=0101
38=1099
41=0
59=0000000000000000000000000000000000000000
60=004
98=2214
99=0

Refund CNP

Request:

Copied!
1=2214
2=20
3=10.99
6=0314
12=1
99=0

Response:

Copied!
7=30121899
6=Visa
5=492949XXXXXX2008
4=10017
14=7
1=81
22=Checknet House 153 East Barnet Road Barnet Hertfordshire EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR73222021
13=22980045
8=07092009
3=1
21=1
9=125351
2=20
34=PLEASE CREDIT MYACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=15
37=0101
38=1099
41=0
59=0000000000000000000000000000000000000000
60=004
98=2214
99=0

Pre-Authorisation

Request:

Copied!
1=2217
2=1
3=10.99
99=0

Response:

Copied!
7=01042008
29=A0000000031010
6=BARCLAYCARD VISA
5=492949XXXXXX2008
4=153422
10=BMSTESTCARDG6091/G
14=2
1=5
22=Checknet House 153 East Barnet Road Barnet Hertfordshire EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR61734250
13=22980045
8=07092009
3=1
21=2
9=125529
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=16
37=0101
38=1099
41=0
30=0
31=F8 00
32=40 00 00 80 00
59=0000000000000000000000000000000000000000
60=004
98=2217
99=0

Pre Sales Completion

This transaction type is used to charge a previously performed pre-authorisation. Request should have the Masked PAN, Expiry date and PGTR number of the pre-authorisation.

Request:

Copied!
1=2218
2=2
3=10.99
5=492949XXXXXX2008
6=0314
13=PGTR61734250
99=0

Response:

Copied!
6=Visa
5=492949XXXXXX2008
14=2
1=5
22=Checknet House 153 East Barnet Road Barnet Hertfordshire EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR73222788
13=22980045
8=07092009
3=20
21=2
9=125731
2=0
36=17
37=0314
38=1099
41=0
59=0000000000000000000000000000000000000000
98=2218
99=0

Cancel

The Cancel request can be used to stop a previously authorised transaction from being charged to the card. The Cancel request is only successful if the transaction is not yet settled by WPH.

Request:

Copied!
1=52
2=3
5=492949XXXXXX2008
6=0314
13=PGTR73222788
99=0

Response:

Copied!
1=0
13=22980045
3=1
2=3
41=0
98=5
99=0

Flow for United States: For United States geography, the IPC utilizes ‘Cancel’ request to cancel bot Credit and Debit type of transaction.

a. Scenario 1 – Credit Transaction If the Cancel request is filed for a transaction which is identified to be originally processed as Credit, the backend at WPH will process the request as per the usual flow.

b.Scenario 2: Debit Transaction Amount and Card being present are mandatory while requesting ‘Cancel’ of a transaction that was originally performed as Debit. If the Cancel request is filed for a transaction which is identified to be originally processed as Debit, the backend will check if the Amount is available in the request: -If yes, then IPC will request to present the card at the terminal, and then WPH will process the request as per the usual flow.

  • If no, then response would be sent to IPC; and the request will be invalid. The user has to file a fresh request with ‘Amount’

Keyed

The Keyed request can be used to perform Keyed Sale and Keyed Refund transactions. IPC allows entry of card details only from the PED (supported with Ingenico iPP350, Ingenico iWL250, VeriFone Vx820). Once the below transaction request is received by IPC, the pinpad will prompt for card details.

Request for Keyed Sale:

Copied!
1=123456
2=0
3=10.00
18=1
99=0

Response for Keyed Sale:

Copied!
7=30121899
6=Visa
5=478825XXXXXX8291
4=096708
14=1
1=1
22=Checknet House 153 East Barnet Road Barnet Herts EN4 8QZ
12=000700000200136
23= Worldpay Retail
28=PGTR1753554
13=23000017
8=28012010
3=1
21=1
9=121702
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=131
37=1210
38=1000
41=0
59=0000000000000000000000000000000000000000
60=004
98=123456
99=0
81=344(If available)

Request for Keyed Refund:

Copied!
1=123456
2=20
3=10.00
18=1
99=0

Response for Keyed Refund:

Copied!
7=30121899
6=Visa
5=478825XXXXXX8291
4=20456
14=1
1=1
22=Checknet House 153 East Barnet Road Barnet Herts EN4 8QZ
12=000700000200136
23= Worldpay Retail
28=PGTR17537543
13=23000017
8=28012010
3=2
21=1
9=121851
2=20
34=PLEASE CREDIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=132
37=1210
38=1000
41=0
59=0000000000000000000000000000000000000000
60=004
98=123456
99=0

Forced Keyed Referral

Note: This transaction is available only with Worldpay US acquirer using the Vx820 PED.

This transaction type can be used to send pre-approved referral transaction information to WPH. It is intended for situations where the store has been through a period of manual trading, using zip-zap machines and calling the bank for voice authorisation, because of e.g. power loss in the store. Once the payment service is restored, this transaction can be used to capture the details of the manually approved transactions via IPC.

Request:

Copied!
1=123456
2=0
3=10.00
18=2
99=0

After placing this request, IPC will prompt for the card details via the UI or the IntraMessage port. Once the card details are provided, IPC will prompt for the previously obtained Authorisation code. If the Auth. code is provided and the transaction accepted, IPC will return a transaction response of ‘Approved Manual’ (3=3) , and the capture will be sent to WPH if IPC is online, or stored locally if it is offline. If the transaction is rejected IPC will return a cancelled response message and the capture will not be sent or stored.

Response:

Copied!
5=413733XXXXXX7780
4=123456
14=1
1=1
22=116 Spadina Avenue Suite 201 Toronto Ontario M5V 2K6
12=542929803213487
23=WorldPay US Retail Test
28=PGTR11585410
13=23000081
8=29072014
3=3
21=2
9=113447
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=281
37=0216
38=1000
41=0
59=0000000000000000000000000000000000000000
60=001
98=2216
99=0

CheckCard

This transaction type can be used to read the card details. If the card is not accepted by IPC, then the transaction is cancelled and response send back to the EPOS application. In the response only the first 6 and last four digits for the card number are returned, except for whitelisted cards where more than 6 digits can be returned. For non-whitelisted cards the digits in between the first 6 and the last four are all zeroed out (replaced by 0).

There are two ways of using Checkcard depending on the value of ‘Remove Card’ flag. If this field is true then IPC will ask the cardholder to remove the card after returning card details. If this field is False then IPC will wait for a transaction request using the same card i.e., the cardholder is not prompted to remove the card unless the next request does not arrive within the configurable timeout period (default 10 seconds).

Checkcard has been enhanced to support contactless tender. To allow contactless operation the Checkcard request must include a transaction amount. If an amount is present in the request then IPC will enable contactless mode, otherwise only contact mode (Insert/Swipe) will be enabled.

An optional ‘Go online’ flag can also be sent in the input request when Checkcard is being used for Credit/Debit recognition. If this field is true IPC will go online to the WPT payment service (if connectivity is available) to check against detailed bin tables whether the tendered card is Credit (C) or Debit (D).

If this flag is not provided in the input request IPC will check online or offline according to configuration of the Online Credit/debit option in IPC Configuration General Tab.

IPC will display additional field track2 data in CheckCard response for whitelisted cards only, the field will be in response is “46”. Note: For United States, Check Card is online and will provide the response for card recognition as Credit, Debit or Hybrid. Request:

Copied!
1=2216
2=30
25=true
3= 10.00 (Amount is mandatory if check card needs to perform in contactless mode)
26=true (Go Online flag)

Response:

Copied!
6=BARCLAYCARD VISA
5=4929490000002008
1=5
13=22980045
3=19
2=30
37=0314
41=0
46=3B363030303038383532303133303939303D323030353130313538313F
59=0000000000000000000000000000000000000000
64=D|Online
98=2216
99=0

Note: Response field 5 i.e. PAN will be returned in plain text for card numbers that fall under the whitelisted bin range and bin ranges are not present in issuer data set.

Response field 64 will have a pipe separated value where the first part of pipe separated value indicates whether card is Credit or Debit (C-Credit, D-Debit) and second part indicates verification is done online or offline (using local card bin ranges).

Response field 46 will be returned Track2 data for white-listed cards only, This functionality will work only for swipe transactions.

To perform the check card transaction followed by, for example, a sale, or break request, implement the following steps

Check card Request:

Copied!
1=123
2=30
25=false
3= 10.00 (Amount is mandatory if check card needs to perform in contactless mode)
26=true (Go Online flag)
99=0

On receiving this request IPC will prompt the cardholder to tender the card. If the card is read successfully IPC will return a response to the EPOS application and wait for the next transaction request for a configurable time (default 10 sec).

At the Checkcard stage, IPC does not prompt Cardholder Verification. Any cardholder verification required will be prompted when proceeding to the payment transaction stage.

IPC handles fallback within the Checkcard without interaction with the EPOS application, such as Chip to Swipe and Swipe to Keyed. For example, if the Chip is not readable, IPC will cause the PED to prompt for a Card Swipe; if a Magnetic Swipe card fails on card swipe, IPC prompt for PKE.

Note: There are no IntraMessage port messages during the fallback event.

If the EPOS application wishes to continue the financial transaction with the tendered card then the request below should be sent

If Checkcard has been previously called with an amount present in the input request (to allow contactless tender) the amount provided in the follow up financial request will be ignored and IPC will process the transaction with the initial amount received i.e. amount received with check card transaction.

The financial requests supported after check card transaction are Sale and Refund.

This is an example of a Sale request following Checkcard:

Sale Request:

Copied!
1=123 (This must be same as check card request)
2=0
3=10.00
99=0

If the EPOS application wishes to break or exit immediately from waiting state then a ‘Sale’ or any other request can be sent with a different transaction reference number to the one used in ‘Check Card’ request. This will cause the Check Card process to terminate immediately and prompt the cardholder to remove their card

Break Transaction Request:

Copied!
1=124
2=0
99=0

Response:

Copied!
13=23000081
3=10
2=14
8=29072014
9=111913
98=123
99=0
### Check Card for Boots Advantage Card This transaction type can be used to read Boots Advantage card (SLE4442 Memory Card) using 25=true with additional parameter (112=true) in input request. In case card read by IPC successfully then IPC will provide 1 to 8 digit long plain Boots advantage card number in the response. Request: 1=2216 2=30 25=true 112=true 99=0 Response: 5=73912802 1=5 13=22980012 3=19 2=30 98=2216 99=0 ### CheckStatus The CheckStatus request can be used to check the IPC status. There are only two states, which may be returned in the result: Status Busy and Status Not Busy. Request:
Copied!
1=1234
2=34
99=0

Response:

Copied!
3=43
99=0

Check Pinpad Connection

The Check pinpad connection request can be used to check the PED is connected with IPC or not. There are only two states which are returned in the result, they are the pinpad is connected (45) and pinpad is not connected (44).

Request

Copied!
1=12345
2=24
99=0

Response:

Copied!
2=24
3=45
13=22980045
98=12345
99=0

The Printing Duplicate Merchant can be used to print Merchant Receipt of the last transaction available to IPC. If IPC has been restarted since the last transaction there will be no transaction available to IPC and below response will be returned by IPC. The response message is as shown below. For this transaction the value of attribute 1, Transaction Reference, has no significance and any value can be used: IPC always references the last transaction performed.

Request:

Copied!
1=121
2=22
99=0

Response:

Copied!
2=22
3=10
13=22980045
98=121
99=0

The Printing Duplicate Customer can be used to print Customer Receipt of the last transaction available to IPC. If IPC has been restarted since the last transaction there will be no transaction available to IPC and below response will be returned by IPC. The response message is as shown below. For this transaction the value of attribute 1, Transaction Reference, has no significance and any value can be used: IPC always references the last transaction performed.

Request:

Copied!
1=1234
2=23
99=0

Response:

Copied!
2=23
3=10
13=22980045
98=1234
99=0

Get Number of Offline Stored Transactions

The Get Number of Offline Stored Transactions can be used to get total number of offline stored transactions. The status returned in the result will have one of two values: successful, in which case the total number of offline stored transactions is returned in field 75; or failure, if the transaction log file is corrupted.

Request:

Copied!
1=1010
2=25
99=0

Response:

Copied!
2=25
3=10
13=22980045
75=5
98=1010
99=0

Get Pinpad Serial Number

The Get Pinpad Serial number Transaction can be used to get serial number of connected PED with IPC.

Request:

Copied!
1=111
2=26
99=0

Response:

Copied!
2=26
3=10
13=22980045
76=123456789
98=111
99=0

Get Territory

The Get Territory Transaction can be used to get Acquirer Name.

Request:

Copied!
1=111
2=15
99=0

Response:

Copied!
98=1234
2=15
13=23000081
65=WorldPay US Test
8=29072014
9=111913
3=10
99=0

Cash Transaction

If merchant is taking payment in Cash, It can be recorded to WPH server by Cash transaction request and can be viewed on merchant portal.

Cash tender amount (Field 20) must be equal to or greater than Goods amount (Field 3).

Request:

Copied!
1=113
2=0
3=35.50      (Goods amount)
20=50.00    (Cash tender)
28=1
99=0

Response:

Copied!
5=000000XXXXXX0000
1=21
22=Kinetic Business Centre Theobald Street Elstree Hertfordshire WD6 4PJ
12=6818780
23= Worldpay HSBC Agent
13=22980045
8=02012014
3=2
21=2
9=100126
2=0
36=129
38=3550
41=0
98=113
99=0

Close IPC

The close IPC request can be used to close IPC if it is running. There is no response is generated for this request.

Request:

Copied!
1=1200
2=99
99=0

Last Transaction Result

To find the result of the last transaction use transaction type of 35. If the IPC instance has been restarted since the last transaction, there will be no result available. As IPC references the latest transaction, any value can be used for attribute 1, Transaction Reference.

Request:

Copied!
1=231224
2=35
99=0

Response (When the last transaction response is present in IPC):

Copied!
7=01042002
29=A0000000031010
6=VISA BARCLAYCARD
5=492949XXXXXX2008
4=729945
10=BMSTESTCARDG6091/G
14=2
1=5
22=Checknet House, I53 East Barnet Road, Barnet EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR13513393
13=22980045
8=07092009
3=1
21=1
9=172748
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=537=0101
38=1099
41=0
30=0
31=F8 00
32=40 00 00 80 00
59=0000000000000000000000000000000000000000
60=004
98=231224
99=0

Response (When Last transaction response is not available in IPC):

Copied!
1=0
2=0
41=0
99=0

Account Payment

Account card payments are based on two step process and both are completely independent transactions within IPC and are not linked in anyway. POS is expected to maintain link between the funds collection stage and Account payment request.

  1. POS collects funds to be paid into the account.
    Where these funds are taken from a card, they are processed through the Sale transaction

  2. Account Payment request
    Once all necessary funds have been collected, POS places as Account Payment request specifying the total to be paid against the account. Key entry transactions will require POS to provide additional attribute (18=1) to the Account Payment transaction request.

Request:

Copied!
1=123
2=18
3=10
99=0

Response:

Copied!
7=30121899
6=Mastercard
5=541333XXXXXX0101
14=1
1=2
22=Kensington & Chelsea 2 EN4 8QZ
12=21249872
23=Royal Borough
28=PGTR500955744
13=22980012
8=25012018
3=1
21=2
9=125238
2=18
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=248
37=0101
38=1000
41=0
60=005
80=000000000248
98=123
99=0

Account Verfication

Account verifications is a Zero value account verification method, which in turn issues payment token for futuristic payments with reference to this transaction, only -Adhoc or pay-as-you-go. AVR (Account Verification Request) is meant to be used only by merchants who opted for Account Verification feature(currently manually). Mandatory input identifier for AVR request will be “58” (AVR transaction Type) & “103” (Transaction Purpose), Input attribute “103” can only contains N (Ad-hoc or pay as you go) values. (103=N)

Request:

Copied!
1=AVR
2=58
103=N
99=0

Response:

Copied!
7=01012004
29=A000000004101002
6=MasterCard
5=541333XXXXXX0045
4=008011
14=2
1=5
22=153 Checknet House East Barnet Road Barnet Herts EN4 8QZ
12=21249872
23=YESpay Demo
13=22980011
8=03012019
3=1
21=1
9=130816
2=58
34=YOU WILL NOT BE CHARGED FOR THIS TRANSACTION
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=255
37=1225
38=0
41=0
30=3
31=E8 00 
32=02 00 00 80 00 
61=99541333008682000045
59=0000000000000000000000000000000000000000
60=005
80=000000000255
98=AVR
99=0

Note: - If AVR transaction is Decline, with special response code sent by acquirer, then customer needs to advice that “Don’t reattempt this card” this advice message will sent to customer with transaction result output identifier. 3= 4001

Alipay Sale using BarCode

This transaction type can be used to perform an Alipay sale transaction using barcode.

Points to note:

• The barcode utilized for performing the Alipay Sale Transaction will be provided in the Output.TXT along with the PGTR, both of which should be stored by the merchant.

• Both these fields will be required while placing a Refund or Cancel request to IPC against an older Alipay sale transaction performed using the barcode.

Request:

Copied!
1=MerchantAlipayReference(Unique) 
2=51(sale)
3=(AMOUNT)
5=(barcode)
108=sendAttempt(optional)
109=Quantity(optional)
110=Transaction Name(optional) 
111=029(Alipay Identifier)
99=0

Response:

Copied!
7=30121899
6=ALIPAY BARCODE
5=281768579629176187
14=8
1=1
22=, , , , ,
12=12345678
23=Test 1 MBH
28=PGTR500068667
13=31300136
8=27062019
3=1
21=19
9=150346
2=51
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=1170
37=0619
38=200
41=0
59=0000000000000000000000000000000000000000
60=029
80=000000001170
98=BR_102
99=0

Alipay Cancel using BarCode

This transaction type can be used to cancel an Alipay sale transaction which was performed using barcode.

Points to note:

• Barcode and PGTR will be required for initiating a Cancel request to IPC against an existing Alipay sale transaction.

Request:

Copied!
1=(MerchantAlipayReference)(Unique)
2=3(Cancel)
5=(barcode value)
13=(PGTR) 
108=sendAttempt(optional)
110=Transaction Name(optional)
111=029(Alipay Identifier)
99=0

Response:

Copied!
1=0
13=31300136
3=1
2=3
41=0
98=BR_105
99=0

Alipay Refund using BarCode

This transaction type can be used to refund an Alipay sale transaction which was performed using a barcode.

Notes:

• Barcode & PGTR will be required for initiating a refund request to IPC against an existing Alipay sale transaction.

• IPC-229 supports only one refund attempt against an Alipay sale transaction. The one-time refund amount can be full or partial sale amount.

• In case of any discrepancy with Alipay transactions, merchants are advised to contact Worldpay Customer Support desk (total.support@worldpay.com, UK: +44 (0) 345 850 9605, ROI: 1800 262 636 option 3). Shoppers need to contact Alipay customer support for resolution.

Request:

Copied!
1=MerchantAlipayReference(Unique) 
2=52(Refund)
3=(AMOUNT)
5=(BARCODE)
13= (PGTR)
108=(SendAttempt)(optional)
111=029(Alipay Identifier)
99=0

Response:

Copied!
7=30121899
6=ALIPAY BARCODE
5=286700XXXXXXX0495
14=8
1=1
22=, , , , ,
12=12345678
23=Test 1 MBH
28=PGTR500068664
13=31300136
8=27062019
3=1
21=17
9=145739
2=52
34=PLEASE CREDIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=1168
37=1299
38=200
41=0
59=0000000000000000000000000000000000000000
60=029
80=000000001168
98=BR_101
99=0

Non transaction type specific examples

X Report

The X Report returns the current totals in the terminal batch in an XML format. This is an online function only. If the network is not available then the transaction will be cancelled and no report data will be returned in response.

Request:

Copied!
1=2217
2=36
3=0
99=0

Response:

Copied!
1=0
2=36
13=22980045
41=0
19=47959
18=245099
17=8
16=71
25=541505
48=54150515102007Delta003900Visa74726433203726Mastercard16953540473
98=2217
99=0

Z Report

The Z Report returns the current totals from the terminal batch in an XML format and also closes the terminal batch. This is an online function only. If network is not available then transaction will be cancelled and no report data will be returned in response.

Request:

Copied!
1=2218
2=37
3=0
99=0

Response:

Copied!
1=0
2=37
13=22980045
41=0
19=47959
18=245099
17=8
16=71
25=541505
48=54150515102007Delta003900Visa74726433203726Mastercard16953540473
98=2218
99=0

Tokenisation Of Card Numbers

IPC provides a Tokenisation mechanism for card numbers.

The WPH system can create a unique Token reference for an IPC card present transaction if the merchant is configured on WPH for token creation.

The WPH token references the customer’s card details to enable payment through the card by the merchant at a later date, without a requirement to retrieve the PAN, or to have the cardholder present. Examples are CCA (Continuous Charge Authority) payments for hire-purchase type transactions.

The merchant application can use IPC transaction types 12 to charge a card using the token reference.

Below is the attribute returned by IPC for a Token in the Response:

DescriptionAttribute Name
Token Reference (e.g.: 532931432DB44ABB5)61

Sample Request for Charging a Token

Transaction type 12 can be used for charging a token through IPC. Mandatory elements required are Token Reference and amount.

Charging a Token can have a new additional optional input attribute i.e. Transaction Purpose “103”, value for this input attribute is be single character I/N/R (Instalment/Ad-hoc/Recurring). This indicate the purpose of the transaction to the acquiring system.

Request:

Copied!
1=3101
2=12
3=10.00
19=532931432DB44ABB5
103=I/N/R (optional)
99=0

Response:

Copied!
7=30121899
4=005872
14=7
1=81
22=Kinetic Business Centre Theobald Street Elstree Hertfordshire WD6 4PJ
12=79808991
23=YESpay HSBC Agent
28=PGTR281978350
13=22980071
8=10102014
3=1
9=082141
2=12
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=121
38=1000
41=0
61=532931432DB44ABB5
59=0000000000000000000000000000000000000000
98=3101
99=0

Sample Request to Refund a Token

Transaction type 13 can be used for refunding to a token through IPC. A refund via the token can be performed for a previously completed sale transaction or a sale performed with a token

Mandatory elements required for the request are Amount, and Token. Optionally the PGTR of the previously completed sale transaction may be provided.

Where a PGTR is provided, the refund is validated against the previously completed sale transaction. Multiple refunds can be performed for the referenced transaction but the sum total of all refunds must be equal to or less than the sale amount.

Request:

Copied!
1=3101
2=13
3=5.00
13=PGTR61734250
19=532931432DB44ABB5
99=0

Response:

Copied!
7=30121899
4=05017
14=7
1=81
22=Kinetic Business Centre Theobald Street Elstree Hertfordshire WD6 4PJ
12=79808991
23=YESpay HSBC Agent
28=PGTR697126959
13=22980071
8=10102014
3=1
21=1
9=082320
2=13
34=PLEASE CREDIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=122
38=500
41=0
61=532931432DB44ABB5
59=0000000000000000000000000000000000000000
98=3101
99=0

Sale with Dynamic Currency Conversion

IPC supports DCC transactions to provide merchants a service that allows cardholders to pay for goods and services internationally using their local currency.

The IPC output response has been enhanced to provide the card currency code as new output attributes where the card is a candidate for DCC.

If DCC is configured for the TID, and the card currency is different to base currency for the TI, the request will be forwarded online to the DCC service to provide the DCC offer. Once the transaction completes and IPC returns the transaction response message, it will contain the card currency as ISO 3 letter code via attribute 82.

If the currency of the card is the same as the TID currency, attribute 82 will not be populated.

Request:

Copied!
1=231234
2=0
3=50
99=0

Response:

Copied!
7=01042002
29=A0000000031010
6=VISA
5=492949XXXXXX2008
4=729945
10=BMSTESTCARDG6091/G
14=2
1=5
22=Checknet House, I53 East Barnet Road, Barnet EN4 8QZ
12=6818780
23= Worldpay Retail
28=PGTR13513393
13=22980045
8=07092009
3=1
21=1
9=172748
2=0
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=537=0101
38=1099
41=0
60=004
70=HKD
71=905.83
72=12.0777
81=344
82=344
98=231234
99=0

Gift Card Redemption/Sale

The Gift Card Redemption transaction is used when a card holder wishes to use their gift card to pay for goods.

For E-Gift Card transactions PAN number must be present in Input request.

The Expiry Date is optional.

Note: Gift card transactions are available for merchants who are opted for gift card functionality at the time of contract with Worldpay total.

Request:

Copied!
1=2345
2=51
3=20
99=0

Response:

Copied!
7=30121899
6=PPS Gift Card
5=633145XXXXXX2414
4=072428
14=8
1=2
22=Kensington & Chelsea 2 EN4 8QZ
12=1234567
23= Royal Borough 
28=PGTR724156878
13=22980061
8=12022015
3=1
21=11
9=072424
2=51
34=PLEASE DEBIT MY ACCOUNT33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=11
37=0913
38=2000
41=0
59=0000000000000000000000000000000000000000
60=090
73=173.50
80=000000000217
98=2345
99=0

Below are some sample request and response for E-gift card transactions.

Request with only PAN in input request:

Copied!
1=1234
2=51
3=1
5=633145XXXXXX2414
99=0

Response:

Copied!
7=30121899
6=PPS Gift Card
5=633145XXXXXX2414
4=67777
14=8 
1=1
22=Kensington & Chelsea 2 EN4 8QZ
12=111111111111
23=Royal Borough 
28=PGTR500958725 
13=22980012 
8=26022018 
3=1 
21=9 
9=154120 
2=51 
34=PLEASE DEBIT MY ACCOUNT 
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS 
36=110 
37=0101 
38=100 
41=0 
59=0000000000000000000000000000000000000000 
73=209.1 
60=091 
80=000000000110 
98=1234 
99=0

Request using PAN and Expiry:

Copied!
1=1234
2=51
3=1
5=6331456347742414
6=1225
99=0

Response:

Copied!
7=30121899
6=PPS Gift Card
5=633145XXXXXX2414
4=40723
14=8 
1=1
22=Kensington & Chelsea 2 EN4 8QZ
12=111111111111
23=Royal Borough
28=PGTR500958726
13=22980012
8=26022018
3=1
21=10
9=154220
2=51
34=PLEASE DEBIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=111 
37=1225
38=100
41=0
59=0000000000000000000000000000000000000000 
73=208.1 
60=091
80=000000000111
98=1234 
99=0

Gift Card Refund

Refund transaction is used when cardholder returns purchased goods and wishes the refunded amount to be loaded on the card.

For E-Gift Card transactions PAN number must be present in Input request. Expiry date is optional for that.

Request:

Copied!
1=2234
2=52
3=20
99=0

Response:

Copied!
7=30121899
6=PPS Gift Card
5=633145XXXXXX2414
4=072553
14=8
1=2
22=Kensington & Chelsea 2 EN4 8QZ
12=1234567
23=Royal Borough
28=PGTR724156922
13=22980061
8=12022015
3=1
21=12
9=072549
2=52
34=PLEASE CREDIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=12
37=0913
38=2000
41=0
59=0000000000000000000000000000000000000000
60=090
80=000000000217
98=2234
99=0

Gift Card Top Up/Load

The Top Up transaction is used to load value onto the card.

For E-Gift Card transactions PAN number must be present in Input request.

Expiry date is optional for that.

Request:

Copied!
1=2234
2=53
3=20
99=0

Response:

Copied!
7=30121899
6=PPS Gift Card
5=633145XXXXXX2414
4=072716
14=8
1=2
22=Kensington & Chelsea 2 EN4 8QZ
12=1234567
23=Royal Borough
28=PGTR724156963
13=22980061
8=12022015
3=1
21=13
9=072710
2=53
34=PLEASE CREDIT MY ACCOUNT
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=13
37=0913
38=2000
41=0
59=0000000000000000000000000000000000000000
60=090
80=000000000219
98=2234
99=0

Gift Card Check Balance/Balance Enquiry

Check balance is used to obtain the balance of a card. For E-Gift Card transactions PAN number must be present in Input request.

Request:

Copied!
1=2345
2=55
99=0

Response:

Copied!
7=30121899
6=PPS Gift Card
5=633145XXXXXX2414
4=073125
14=8
1=2
22=Kensington & Chelsea 2 EN4 8QZ
12=1234567 
23=Royal Borough
28=PGTR307625694
13=22980061
8=12022015
3=1
21=16
9=073120
2=55
33=PLEASE KEEP THIS RECEIPT FOR YOUR RECORDS
36=16
37=0913
41=0
59=0000000000000000000000000000000000000000
73=50.50
60=090
98=2234
99=0

TaxFree Voucher for Cash Transaction

TaxFree voucher generation is a mechanism to generate TaxFree Voucher for a cash transaction. It will be applicable only if merchant is enabled for TaxFree Voucher. The TaxFree voucher text will be generated in a file (VATRefundVoucher.txt) under \YESEFT folder. Each text line of VATRefundVoucher.txt file is preceded by formatting character which is used for printing. The formatting character details are given in the section -Print Command details for Tax Free Voucher

Request:

Copied!
1=2345

2=8

3=50.50

99=0

Response:

Copied!
1=0

22=153 East Barnet Road Barnet Hertfordshire Hertfordshire EN4 8QZ

12=6818780

23=First Retailer Site

13=22980046

8=13052010

3=1

9=105700

2=8

41=0

98=2354

99=0