Version 30.7 by Pål-Eirik Askerød on 2017/10/26 09:51
Show last authors
1 (% class="WordSection1" %)
2 (((
3 = Overview =
4
5 The purpose of the H2H PayEx link is to enable authorization and settlement of card transactions, where PayEx is end host for that card, or just an PSP. The third party host acts as a gateway in between payment terminals and PayEx.
6
7
8 [[image:pos server.png]]
9
10
11
12
13 The third party host can be a single or dual host system.
14 PayEx has a fully redundant system, with an active/active configuration.
15 The third party host(s) connects through PayEx load balanser.
16
17
18 == Supported massage types ==
19
20
21 |=Message Type|=Reference
22 |1100/1110|[[AUTHORISATION REQUEST>>doc:AUTHORISATION REQUEST 1100/1110]]
23 |1200/1210|[[FINANCIAL TRANSACTION REQUEST>>doc:.FINANCIAL TRANSACTION REQUEST 1200/1210.WebHome]]
24 |1220/1221/1230|[[FINANCIAL TRANSACTION ADVICE>>doc:FINANCIAL TRANSACTION ADVICE 1220/1221/1230]]
25 |1420/1421/1430|[[REVERSAL ADVICE>>doc:REVERSAL ADVICE 1420/1421/1430]]
26 |1820/1830|[[NETWORK MANAGEMENT>>doc:.NETWORK MANAGEMENT 1820/1830.WebHome]]
27 |1520/1521/1530|RECONCILIATION REQUEST (**Currently not supported)**
28
29 * Message types not included in the table above are not supported. E-g reconciliation is not supported
30 Only the Financial transaction advice (1220), Reversal Advice (1420) use repeat messages. Repeats are to be sent according to xxxxxxx rules
31 * Advice can be declined by PayEx for technical reasons. In this case the third party host need to retry the advice until manual intervention or the advice has been accepted. It’s expected that the third party implement a retry delay (to-be-defined). After 6 retry attemps have failed manual intervention by third party and PayEx support must be initiated.
32
33 == Message layout ==
34
35 This section covers message types and fields supported by PayEx
36
37
38 |=Presence|=Title|=Description
39 |C|Conditional|The data element’s presence depends on specific circumstances, witch are described either directly or by reference in the message content table.
40 |CE|Conditional echo|The response message must have the same data element if the data element was present in the original message
41 |M|Mandatory|Data element must be present in the specified message
42 |ME|Mandatory echo|The response message must have the same data element and value as sent in the original message request or advice message
43 |O|Optional|The data element may or may not be present in the message
44 )))
45
46 Optional fields may always be present in requests, even when not needed. In such case, they will be ignored. Requests received missing a mandatory field will be 904 - Format Error.
47
48 The third party host must ignore unknown fields included in the response messages.
49
50 When no usage notes are given in the field description, the field should be used as described in IFSF [1].
51
52 The “Format”-column can contain following info:
53
54 * LL: Variable length field, max 99 bytes as data. The field contains 2 bytes holding the length of the data. Example: 303101 a one byte field with LL = 3031 and the data is 01.
55 * LLL: Variable length field, max 999 bytes as data. The field contains 3 bytes holding the length of the data. Example: 30303101 a one byte field with LLL = 303031 and the data is 01.
56 * Date/time field formats, YYMMDDhhmmss (or variations), where:
57 ** YY : Last 2 digits of the year, 00 through 99
58 ** MM: Month, 01 through 12.
59 ** DD: Day, 01 through 31
60 ** hh: Hour, 00 through 23
61 ** mm: Minutes, 00 through 59
62 ** ss: Seconds, 00 through 59
63
64 The “Type”-column can contain:
65
66 * a : Alphabetic character [a..z,A..Z]
67 * n : Numeric BCD-digit. [0..9]
68 * ans: alphabetic, numeric and special characters
69 * an : alphabetic and numeric.
70 * s : Special characters.
71 * b : Binary
72 * p: pad character, space
73 * x: “C” for credit, “D” for debit and shall always be associated with a numerical amount data element.
74
75 The “Size”-column can contain:
76
77 * Variable length fields have a size that looks like “..nn”, where nn is the maximum number of characters or bytes.
78 * A fixed length field has “n” as size content, with n the number of characters or bytes.
79
80 All fixed length “n” data elements are assumed to be right justified with leading zeroes. All other fixed length data elements are left justified with trailing spaces. In all “b” data elements, blocks of 8 bits are assumed to be left justified with trailing zeroes.
81
82
83 == Message protocol ==
84
85 All messages are transferred using TCP/IP sockets.
86
87 The message will be encapsulated in a transmission frame as follows:
88
89 * The first 4 digits contain the length of the message in ASCII (decimal value, most significant digit first). The length field includes all bytes from the first byte of the message ID up to the last byte of the last field.
90 * This 4-digit length field is immediately followed by the message ID, also in ASCII (decimal value, most significant digit first).
91 * An 8 byte message bitmap, which is a binary field (so not ASCII encoded).
92 * Message fields, which could be ASCII or binary encoded. The fields with format ‘n, ns, an, ans, anp or x’ are ASCII encoded, while the fields with format ‘b’ are binary encoded. The following conventions shall be applied to all data elements:
93 ** All fixed length numeric data element values shall be right justified with leading zeroes.
94 ** All fixed length data elements with alphabetic or special characters shall be left justified with trailing blanks.
95 ** All fixed length binary data elements shall be right justified with leading zeroes.
96 ** The position of a character or a bit in a data element shall be counted from the left beginning with one (1).(See also section 5.1 Attribute specification in [01])
97 ** No trailer is included.
98
99 Example: An imaginary message which consists only of a message ID “0300” and an empty bitmap (all zeros) will be transmitted as follows:
100
101
102 |=Length|=(((
103 Message ID
104 )))|=Bitmap
105 |=0x30 0x30 0x31 0x32|=0x30 0x33 0x30 0x30|=0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
106
107 Example: An 1820 message, without MAC, will be transmitted as follows: Message bytes (hex):
108 303035303138323002300101000000003039313031353238343133383239313030393039313031353238343138333130353130303331
109
110
111 |=Field|=Format|=Encoding|=Data|=Parsed
112 |Message Length|n|ASCII|30303530|0050
113 |Massage ID|n|ASCII|31383230|1820
114 |Bitmat|b|Binary|0230010100000000|
115 |7 - Date/Time|n|ASCII|30393130313532383431|0910152841
116 |11 - STAN|n|ASCII|333832393130|382910
117 |12 - Date/Time|n|ASCII|303930393130313532383431|090910152841
118 |24 - Function code|n|ASCII|383331|831
119 |32 - Acquiring institution identification code|n|ASCII|TODO eksempel|TODO eksempel
120
121 The PayEx response timeout is set to XX seconds. If after xx+1 seconds, no response has been received, the third party host needs to take the appropriate action based on the message type. (E.g. send a reversal)
122
123 The third party host has the possibility to perform offline stand-in, thought this needs to be agreed with the indididual card issuers. Otherwise the station might not be reimbursed.
124
125
126 == PIN Validation ==
127
128 PayEx perform online PIN validation on payment cards where PayEx is the acquirer, on all other cartds PIN is validated by the third party acuirer. PayEx will not interpret P-22 Point-Of-Service code to determine if it needs to validate PIN or not on PayEx fuel cards, but 3rd patry aquirers might so it's good practice to use P-22 correctly.
129
130 Fields required for PIN validation are:
131
132 * P-48-14 – PIN encryption Methodology
133 * P-52 – PIN data
134 * P-53 – Security related information
135
136 == Security documentation ==
137
138 Here you can find details regarding the security aspects of this H2H integration. TODO create link to security page..
139
140 (% class="wikigeneratedid" %)
141 == ==
142
143 == Message field details ==
144
145
146 **P-2 PAN**
147
148 Personal Account Number, identifies the card. Only mandatory for Manual PAN transactions (replacement for Track2Data P35)
149
150 **P-3 PROCESSING CODE**
151
152 Code used to describe the effect of a transaction on the customer account and the accounts affected. Fixed 00000000 : Goods and services
153
154 **P-4 AMOUNT, TRANSACTION**
155
156 The amount is a numeric value, expressed without a decimal separator. Where a minor unit of currency applies, the relevant minor unit data element indicates the number of decimal places in the relevant amount. Example : 1 kr = 100
157
158 **P-7 DATE AND TIME, TRANSMISSION**
159
160 Date and time of message transmission from the third party host.
161
162 **P-11 SYSTEM TRACE AUDIT NUMBER**
163
164 Number assigned by the third party host to assist in identifying a transaction uniquely. Range 000001 till 999999. Every message must have a new STAN, repeats use the same STAN as the original message.
165 **P-12 DATE AND TIME, LOCAL TRANSACTION**
166
167 Date and time of the transaction when performed on the POS.
168
169 **P-14 DATE EXPIRY**
170
171 Month and year of card expiry. Only mandatory for a manual PAN transaction
172
173 **P-22 POINT OF SERVICE DATA CODE**
174
175 A series of codes intended to identify terminal capability, terminal environment and presentation security data.
176
177 |=Point of service date code|=Description
178 |POS 1: Card data input capabilities|2: magnetic stripe read A: RFID
179 B: Magnetic stripe reader and key entry
180 C: Magnetic stripe reader, ICC and key entry
181 D: Magnetic stripe reader and ICC
182 |Pos 2: Cardholder authentication capability|1: PIN
183 Y: Signature,plaintext/enciphered PIN offline and ‘no cvm’ capable, enciphered pin online
184 |Pos 3: Card capture capability|0:None
185 T: None and SDA/DDA/CDA capable
186 |Pos 4: Operating environment|(((
187 1: On premises of card acceptor, attended
188 2: On premises of card acceptor, unattended
189 )))
190 |Pos 5: Cardholder present|0: Cardholder present
191 |Pos 6: Card present|1: Card present
192 |Pos 7: Card data input mode|2: Magnetic stripe read
193 3: Bar code
194 5: ICC
195 6: Key entered A: RFID
196 D: Magnetic stripe read following failed chip card read
197 |Pos 8: Cardholder authentication method|0: Not authenticated
198 1: PIN
199 5: Manual signature verification
200 |Pos 9: Cardholder authentication entity|0: Not authenticated
201 1: ICC
202 2: Card acceptor device 3: Authorizing Agent
203 |Pos 10: Card data output capability|1: None
204 3: ICC
205 |Pos 11: Terminal output capability|2: Printing
206 4: Printing and display
207 |Pos 12: PIN capture capability|C: Twelve characters
208
209 **P-24 FUNCTION CODE**
210
211 |=Function code|=Description
212 |101|Original authorization, amount estimated used in 1100
213 |200|Original financial request/advice Used in 1200/1220/1221
214 |201|Previously approved authorisation, amount the same Used in 1220/1221
215 |202|Previously approved authorisation, amount differs Used in 1220/1221
216 |400|Full reversal Used in 1420/1421
217 |831|Echo test Used in 1820
218
219 **P-25 MESSAGE REASON CODE**
220
221 |=reason code |=Description
222 |1003|Card issuer unabailable
223 |1004|Terminal processed
224 |1508|On-line forced by terminal
225 |4000|Customer cancellation
226 |4020|Invalid response, no action taken
227 |4021|Timeout waiting for response
228 |4351|Cancellation - unmatched signature
229
230 **P-30 ORIGINAL AMOUNT**
231
232 The original amount data element is a constructed element of two parts with a total of 24 positions:
233 a) Original amount transaction, n 12;
234 b) Original amount reconciliation, n 12.
235 Absence of data shall be indicated by zeroes. These parts shall be used when attempting to perform a partial approval and shall contain the original amounts.
236
237
238 **P-33 FORWARDING INSTITUTION IDENTIFICATION CODE**
239
240 10 digit code identifying the 3rd patry host. Each 3rd party integrated with PayEx will be assigned a unique code that they are to use in all messages where P-33 is specified.
241
242
243 **P-35 TRACK 2 DATA**
244
245 The information encoded on track 2 of the magnetic stripe as defined in ISO7813, excluding beginning and ending sentinels and longitudinal redundancy check characters as defined therein.
246
247 Example: 123456789012345=00112233
248
249
250 **P-38 APPROVAL CODE**
251
252 Code assigned by the authorising institution indicating approval.
253
254
255 **P-39 ACTION CODE**
256
257 See action code page for codes that can be returned by PayEx.
258
259
260 **P-41 Card acceptor terminal identification**
261 Needs to be unique per POS terminal at the merchant site. For Indoor terminals use the range 1-99 and for outdoor terminals 100-199. PayEx needs to be informed of how many terminals that are installed at the merchant site.
262
263 **P-42 Card acceptor identification code**
264
265 8 digit unique ID provided by PayEx for each merchant.
266
267 **P-43 Card acceptor name/location**
268
269 The name and location of the card acceptor.
270
271 **P-48 MESSAGE CONTROL DATA ELEMENTS**
272 Used for the control of messages between the POS and the FEP. These are present in field 48 as a variable content data element. It uses a standard bit map to identify the specific data elements present in field 48. The format is LLLVAR with a maximum length of 999. The 8 byte bit map is the first item (element 48-0) in the data element.
273
274 P-48-4 BATCH/SEQUENCE NUMBER
275
276 This field identifies the transactions associated with a particular settlement period. This number starts at one and increments with each Reconciliation.
277
278 P-48-8 CUSTOMER DATA
279
280 The customer data is any data entered by the customer or cashier as required by the authorizer to complete the transaction. Transactions requiring customer data may be related to fleet fuelling, cheque authorizations or any other type of retail store management functions. Up to sixteen separate entries are supported. Each entry consists of two elements, the type of customer data entered and the variable length value of the entered data. Successive entries are separated by a back-slash (\). (Note: the LVAR method is not used for these entries.) The entire data element has a maximum length of 250 bytes and is parsed as an LLLVAR field.
281
282 |=Element|=Name|=Attribute|=Description
283 |48-8-1|Number of customer data fields|n2|Count of customer data entries to follow.Note: this value must be from 1 to 16.
284 |48-8-2|Type of customer data|an 1|Identifies the type of customer data entered. (see P48-8-2)
285 |48-8-3|Value of customer data|ans...99|Data entered by customer orcashier.
286
287 **P-48-8-2 TYPE OF CUSTOMER DATA**
288
289 1 - Vehicle Number
290 3 - Driver ID
291 4 - Mileage
292 5 - Driver license number
293 B - Unit number/fleet ID
294 D - Customer verification code
295 G - Alphanumeric entered data
296
297
298 The information encoded on track 2 of the magnetic stripe as defined in ISO7813, excluding beginning and ending sentinels and longitudinal redundancy check characters.**P-48-9 TRACK II OF VEHICLE CARD**
299
300 **P-48-14 PIN ENCRYPTION METHODOLOGY**
301
302 ‘13’: PayEx H2H shared keys
303
304 ‘33’: ZKA MS/SK PAC H2H (**Currently not supported**)
305
306
307 When P-52 is present, this field must also be present. When field P-52 is NOT present, field 48-14 should also NOT be present.
308
309 The value currently supported by PayEx is ‘13’ and refers to PayEx H2H shared keys. **Other values are currently not supported**.
310
311 PayEx H2H shared key scheme defines a pin encryption key that is used to encrypt the pin block. See security documentation for details. TODO ref security documentation
312
313 **P-48-32 VAT PERCENTAGES**
314
315 List of VAT codes accompanied with their corresponding VAT percentage.
316
317 The purpose of this field is to link the VAT codes as used in field P-63 Product data, P-63-8 tax code, to actual VAT percentages. As the incoming link can be multi-country, and PayEx does not have product codes per VAT rate, the VAT rates need to be provided in every transaction.
318
319 Individual items are separated with a backslash character.
320 Only VAT codes used in the product data (P-63) need to be described in this array. Others will be ignored.
321
322
323 **P-48-37 VEHICLE IDENTIFICATION ENTRY MODE**
324 Only present when a vehicle number is available (P48-8). Defines how the vehicle number was entered:
325
326 0 - Manual entry
327 1- On the Card
328 2 - Automatic Licence Plate Recognition
329
330 **P-48-38 PUMP LINKED INDICATOR**
331
332 Indicating whether the fuel pump reading is is linked to the payment terminal:
333 0 – Unspecified
334 1 – Pump-linked
335 2 – Pump not linked
336
337
338 **P-48-39 DELIVERY NOTE NUMBER**
339 Number allocated by the terminal given to the customer as printed on the ticket.
340
341 **P-49 CURRENCY CODE , TRANSACTION**
342 All transactions are in local currency, as defined during system installation. Actual value is as defined by ISO 4217.
343
344 **P-52 PIN DATA**
345 ISO 9564-1 format 0 PIN block encrypted with PIN encryption key.
346
347
348 **P-53 SECURITY RELATED CONTROL INFORMATION**
349
350 (% style="width:1468px" %)
351 |=Element|=Name|=Format|=Attribute|=(% style="width: 731px;" %)Description
352 |53| |n|2|(% style="width:731px" %)LLVAR length field
353 |53-1|Master key generation number|n|1|(% style="width:731px" %)Identifies the master key generation. **Currently NOT supported**
354 |53-2|Key version of master key|n|1|(% style="width:731px" %)Identifies the key version. **Currently NOT supported**
355 |53-3|MAC random value|b|16|(% style="width:731px" %)ZKA MAC random value. **Currently NOT supported**
356 |53-4|PAC random value|b|16|(% style="width:731px" %)(((
357 ZKA PAC random value. Zero filled if no PIN block in the message. **Currently NOT supported**
358 )))
359 |53-5|Data encryption random value|b|16|(% style="width:731px" %)ZKA Data encryption random value. **Currently NOT supported**
360 |53-6|H2H Key version|n|2|(% style="width:731px" %)Version of keys shared by PayEx with 3rd party.
361
362 **PayEx shared key scheme**
363
364 PayEx supplies key version to be sent in 53-6. This scheme defines 3 different keys for MAC, PIN and Data encryption which will be shared between PayEx and 3rd party.
365
366
367 **ZKA scheme (Currently not supported)**
368
369 PayEx defines the value of 53-1 and 53-2. Note that a set of different values are defined for both TEST and LIVE, and is unique for every third party (host).
370
371 For optimal security it is a good practice to use different random values for the MAC and PAC. However the security impact of having the same random number for PAC and MAC is very limited. Especially because in the MK/SK security scheme an XOR of the Master key with a fixed Control Mask is done, where the Control Mask value is different for PIN and MAC. So even if the MAC session key would be compromised the PIN session key still cannot be determined even when the same random number is used.
372
373 It is important to assure that different random numbers are used for every transaction.
374
375
376 **P-56 ORIGINAL DATA ELEMENTS**
377
378 Data elements of original transaction which contains the original “message identifier”, original “STAN” and original “date and time – local transaction”. This must be present if the message is preceded by an 1100 Authorisation Request, it can be omitted if the message is as a result of a store and forward transaction.
379 In Payment advice : Link to previous Authorisation dialog
380 In reversal advice : Link to previous Authorisation request or previous Payment request being reversed.
381
382
383 **P-62 PRODUCT SETS AND MESSAGE DATA**
384
385 This field contains allowed product sets and message data.
386
387 |=Number|=Name|=Format|=Attribute|=Description
388 |62| |n|3|LLLVAR length field. Sets the length of P-62 data
389 |62-1|Allowed products|ans|...99|LLVAR field, contains the products that are allowed
390 |62-2|Device text|n|1|For what device 62-3 is to be sent to
391 |62-3|Massage text|ans|...999|LLLVAR field. Display text
392
393 All subfields must be present when bit 62 is set. Field 62 shall not be sent if none of the three subfields need to be sent. If one of the subfields needs to be sent, all three subfields shall be sent.
394
395
396 **P-63 PRODUCT DATA**
397
398 This data element provides the detailed information on the products purchased or selected by the customer. The first two fields (63-1, 63-2) appear once per transaction. The next seven fields can be repeated up to 18 times.
399
400 Each product is represented by seven fields: Product Code, Unit of Measure, Quantity, Unit Price, Amount, Taxcode and Additional product code. The variable length fields and the succeeding entry are separated by a back-slash (\).
401 Unit price and amount may be negative or positive, but the sum of the amounts in the product data must equal the transaction amount.
402 The values of Quantity and Unit price may have a value that includes both integer and fractional values. The format of these fields consists of a single digit, which specifies the number of fractional digits following the integer, followed by the numeric value.
403 The value must be numeric. The number of fractional digits has a maximum of 4. The Amount field may have fractional digits. The number of fractional digits is specified by the currency code.
404
405 The list of sales items can contain a mixture of normal sales items and refund items. These are included in the online Host message as follows:
406
407
408 |=Number|=Format|=Field|=Description
409 |63|n 3|Product data|LLLVAR length field. Sets the length of P-63 data
410 |63-1|a 1|Service level|(((
411 S - Self-serve
412 F - Full serve
413 Space - Information not available
414 )))
415 |63-2|n 2|Number of products|Count of products (sale item) reported for this transaction.
416
417 Each Sales item consists of the following components:
418
419
420 |=Number|=Format|=Field|=Description
421 |63-3|n 3 |Product code|3-digit product code that defines the type of product sold
422 |63-4|a 1 |Unit ofg measure|Indicates the meaning of the Quantity field. ‘U’ Sold per Unit
423 ‘O’ Unit of Measurement undefined ‘L’ Sold per Litre
424 |63-5|n 9|Quantity|Number of product units
425 | | |Separator|‘\’ To separate Quantity from Unit-Price
426 |63-6|sn 9|Unit price|Starts with a Minus sign when Unit price is negative. First digit is exponent. Typically 3 for fuels, and 2 for shop articles. Remaining digits are actual unit price
427 | | |Separator|‘\’ To separate Unit price from Amount
428 |63-7|sn 12|Amount|Starts with a minus sign in case Item amount is negative. 2 decimals are always implied.
429 | | |Separator|‘\’ To separate the Amount from the Vat Code
430 |63-8|an 1|Tax code|1 digit VAT code
431 |63-9|n 14|Additional Product code|Up to 14 digits article number as known in the POS
432 | | |Teminator |‘\’ To mark the end of this sales item
433
434 **P-64 MAC**
435
436 MAC is calculated/verified according to the “IFSF X9.19 Retail CBC MAC (3DES)” (see Appendix D in [2]), using the “Derivation of the MAC session key” (see 5.2.2 Derivation of the MAC session key in [2]).
437
438 The input for the MAC calculation/verification will be the SHA-256 of the IFSF message. The message length header and the MAC block itself are not included, however the MAC bit in the bitmap is part of the message and is already set when calculating the MAC.
439
440
441 In pseudo code it is as follows (the sign is used for assignment):
442 Input :
443
444 * The four 8-byte blocks B1 .. B4 from the SHA256
445 * MAC session key <Kl, Kr> (left and right halfs)
446
447 Output :
448
449 * 8-byte MAC M
450
451 Function X9.19retailMAC:
452
453 * M <- 0x0000 0000 0000 0000
454
455 For each 8-byte block b in B1 to B4 do:
456
457 * M <- M XOR b
458 * M <- 1DES_encrypt(Kl, M)
459
460 Done
461
462 * M <- 1DES_decrypt(Kr, M)
463 * M <- 1DES_encrypt(Kl, M)
464
465 End function
466