Version 30.6 by Pål-Eirik Askerød on 2017/10/25 14:52
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 == Message field details ==
137
138
139 **P-2 PAN**
140
141 Personal Account Number, identifies the card. Only mandatory for Manual PAN transactions (replacement for Track2Data P35)
142
143 **P-3 PROCESSING CODE**
144
145 Code used to describe the effect of a transaction on the customer account and the accounts affected. Fixed 00000000 : Goods and services
146
147 **P-4 AMOUNT, TRANSACTION**
148
149 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
150
151 **P-7 DATE AND TIME, TRANSMISSION**
152
153 Date and time of message transmission from the third party host.
154
155 **P-11 SYSTEM TRACE AUDIT NUMBER**
156
157 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.
158 **P-12 DATE AND TIME, LOCAL TRANSACTION**
159
160 Date and time of the transaction when performed on the POS.
161
162 **P-14 DATE EXPIRY**
163
164 Month and year of card expiry. Only mandatory for a manual PAN transaction
165
166 **P-22 POINT OF SERVICE DATA CODE**
167
168 A series of codes intended to identify terminal capability, terminal environment and presentation security data.
169
170 |=Point of service date code|=Description
171 |POS 1: Card data input capabilities|2: magnetic stripe read A: RFID
172 B: Magnetic stripe reader and key entry
173 C: Magnetic stripe reader, ICC and key entry
174 D: Magnetic stripe reader and ICC
175 |Pos 2: Cardholder authentication capability|1: PIN
176 Y: Signature,plaintext/enciphered PIN offline and ‘no cvm’ capable, enciphered pin online
177 |Pos 3: Card capture capability|0:None
178 T: None and SDA/DDA/CDA capable
179 |Pos 4: Operating environment|(((
180 1: On premises of card acceptor, attended
181 2: On premises of card acceptor, unattended
182 )))
183 |Pos 5: Cardholder present|0: Cardholder present
184 |Pos 6: Card present|1: Card present
185 |Pos 7: Card data input mode|2: Magnetic stripe read
186 3: Bar code
187 5: ICC
188 6: Key entered A: RFID
189 D: Magnetic stripe read following failed chip card read
190 |Pos 8: Cardholder authentication method|0: Not authenticated
191 1: PIN
192 5: Manual signature verification
193 |Pos 9: Cardholder authentication entity|0: Not authenticated
194 1: ICC
195 2: Card acceptor device 3: Authorizing Agent
196 |Pos 10: Card data output capability|1: None
197 3: ICC
198 |Pos 11: Terminal output capability|2: Printing
199 4: Printing and display
200 |Pos 12: PIN capture capability|C: Twelve characters
201
202 **P-24 FUNCTION CODE**
203
204 |=Function code|=Description
205 |101|Original authorization, amount estimated used in 1100
206 |200|Original financial request/advice Used in 1200/1220/1221
207 |201|Previously approved authorisation, amount the same Used in 1220/1221
208 |202|Previously approved authorisation, amount differs Used in 1220/1221
209 |400|Full reversal Used in 1420/1421
210 |831|Echo test Used in 1820
211
212 **P-25 MESSAGE REASON CODE**
213
214 |=reason code |=Description
215 |1003|Card issuer unabailable
216 |1004|Terminal processed
217 |1508|On-line forced by terminal
218 |4000|Customer cancellation
219 |4020|Invalid response, no action taken
220 |4021|Timeout waiting for response
221 |4351|Cancellation - unmatched signature
222
223 **P-30 ORIGINAL AMOUNT**
224
225 The original amount data element is a constructed element of two parts with a total of 24 positions:
226 a) Original amount transaction, n 12;
227 b) Original amount reconciliation, n 12.
228 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.
229
230
231 **P-33 FORWARDING INSTITUTION IDENTIFICATION CODE**
232
233 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.
234
235
236 **P-35 TRACK 2 DATA**
237
238 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.
239
240 Example: 123456789012345=00112233
241
242
243 **P-38 APPROVAL CODE**
244
245 Code assigned by the authorising institution indicating approval.
246
247
248 **P-39 ACTION CODE**
249
250 See action code page for codes that can be returned by PayEx.
251
252
253 **P-41 Card acceptor terminal identification**
254 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.
255
256 **P-42 Card acceptor identification code**
257
258 8 digit unique ID provided by PayEx for each merchant.
259
260 **P-43 Card acceptor name/location**
261
262 The name and location of the card acceptor.
263
264 **P-48 MESSAGE CONTROL DATA ELEMENTS**
265 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.
266
267 P-48-4 BATCH/SEQUENCE NUMBER
268
269 This field identifies the transactions associated with a particular settlement period. This number starts at one and increments with each Reconciliation.
270
271 P-48-8 CUSTOMER DATA
272
273 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.
274
275 |=Element|=Name|=Attribute|=Description
276 |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.
277 |48-8-2|Type of customer data|an 1|Identifies the type of customer data entered. (see P48-8-2)
278 |48-8-3|Value of customer data|ans...99|Data entered by customer orcashier.
279
280 **P-48-8-2 TYPE OF CUSTOMER DATA**
281
282 1 - Vehicle Number
283 3 - Driver ID
284 4 - Mileage
285 5 - Driver license number
286 B - Unit number/fleet ID
287 D - Customer verification code
288 G - Alphanumeric entered data
289
290
291 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**
292
293 **P-48-14 PIN ENCRYPTION METHODOLOGY**
294
295 ‘13’: PayEx H2H shared keys
296
297 ‘33’: ZKA MS/SK PAC H2H (**Currently not supported**)
298
299
300 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.
301
302 The value currently supported by PayEx is ‘13’ and refers to PayEx H2H shared keys. **Other values are currently not supported**.
303
304 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
305
306 **P-48-32 VAT PERCENTAGES**
307
308 List of VAT codes accompanied with their corresponding VAT percentage.
309
310 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.
311
312 Individual items are separated with a backslash character.
313 Only VAT codes used in the product data (P-63) need to be described in this array. Others will be ignored.
314
315
316 **P-48-37 VEHICLE IDENTIFICATION ENTRY MODE**
317 Only present when a vehicle number is available (P48-8). Defines how the vehicle number was entered:
318
319 0 - Manual entry
320 1- On the Card
321 2 - Automatic Licence Plate Recognition
322
323 **P-48-38 PUMP LINKED INDICATOR**
324
325 Indicating whether the fuel pump reading is is linked to the payment terminal:
326 0 – Unspecified
327 1 – Pump-linked
328 2 – Pump not linked
329
330
331 **P-48-39 DELIVERY NOTE NUMBER**
332 Number allocated by the terminal given to the customer as printed on the ticket.
333
334 **P-49 CURRENCY CODE , TRANSACTION**
335 All transactions are in local currency, as defined during system installation. Actual value is as defined by ISO 4217.
336
337 **P-52 PIN DATA**
338 ISO 9564-1 format 0 PIN block encrypted with PIN encryption key.
339
340
341 **P-53 SECURITY RELATED CONTROL INFORMATION**
342
343 (% style="width:1468px" %)
344 |=Element|=Name|=Format|=Attribute|=(% style="width: 731px;" %)Description
345 |53| |n|2|(% style="width:731px" %)LLVAR length field
346 |53-1|Master key generation number|n|1|(% style="width:731px" %)Identifies the master key generation. **Currently NOT supported**
347 |53-2|Key version of master key|n|1|(% style="width:731px" %)Identifies the key version. **Currently NOT supported**
348 |53-3|MAC random value|b|16|(% style="width:731px" %)ZKA MAC random value. **Currently NOT supported**
349 |53-4|PAC random value|b|16|(% style="width:731px" %)(((
350 ZKA PAC random value. Zero filled if no PIN block in the message. **Currently NOT supported**
351 )))
352 |53-5|Data encryption random value|b|16|(% style="width:731px" %)ZKA Data encryption random value. **Currently NOT supported**
353 |53-6|H2H Key version|n|2|(% style="width:731px" %)Version of keys shared by PayEx with 3rd party.
354
355 **PayEx shared key scheme**
356
357 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.
358
359
360 **ZKA scheme (Currently not supported)**
361
362 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).
363
364 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.
365
366 It is important to assure that different random numbers are used for every transaction.
367
368
369 **P-56 ORIGINAL DATA ELEMENTS**
370
371 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.
372 In Payment advice : Link to previous Authorisation dialog
373 In reversal advice : Link to previous Authorisation request or previous Payment request being reversed.
374
375
376 **P-62 PRODUCT SETS AND MESSAGE DATA**
377
378 This field contains allowed product sets and message data.
379
380 |=Number|=Name|=Format|=Attribute|=Description
381 |62| |n|3|LLLVAR length field. Sets the length of P-62 data
382 |62-1|Allowed products|ans|...99|LLVAR field, contains the products that are allowed
383 |62-2|Device text|n|1|For what device 62-3 is to be sent to
384 |62-3|Massage text|ans|...999|LLLVAR field. Display text
385
386 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.
387
388
389 **P-63 PRODUCT DATA**
390
391 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.
392
393 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 (\).
394 Unit price and amount may be negative or positive, but the sum of the amounts in the product data must equal the transaction amount.
395 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.
396 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.
397
398 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:
399
400
401 |=Number|=Format|=Field|=Description
402 |63|n 3|Product data|LLLVAR length field. Sets the length of P-63 data
403 |63-1|a 1|Service level|(((
404 S - Self-serve
405 F - Full serve
406 Space - Information not available
407 )))
408 |63-2|n 2|Number of products|Count of products (sale item) reported for this transaction.
409
410 Each Sales item consists of the following components:
411
412
413 |=Number|=Format|=Field|=Description
414 |63-3|n 3 |Product code|3-digit product code that defines the type of product sold
415 |63-4|a 1 |Unit ofg measure|Indicates the meaning of the Quantity field. ‘U’ Sold per Unit
416 ‘O’ Unit of Measurement undefined ‘L’ Sold per Litre
417 |63-5|n 9|Quantity|Number of product units
418 | | |Separator|‘\’ To separate Quantity from Unit-Price
419 |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
420 | | |Separator|‘\’ To separate Unit price from Amount
421 |63-7|sn 12|Amount|Starts with a minus sign in case Item amount is negative. 2 decimals are always implied.
422 | | |Separator|‘\’ To separate the Amount from the Vat Code
423 |63-8|an 1|Tax code|1 digit VAT code
424 |63-9|n 14|Additional Product code|Up to 14 digits article number as known in the POS
425 | | |Teminator |‘\’ To mark the end of this sales item
426
427 **P-64 MAC**
428
429 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]).
430
431 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.
432
433
434 In pseudo code it is as follows (the sign is used for assignment):
435 Input :
436
437 * The four 8-byte blocks B1 .. B4 from the SHA256
438 * MAC session key <Kl, Kr> (left and right halfs)
439
440 Output :
441
442 * 8-byte MAC M
443
444 Function X9.19retailMAC:
445
446 * M <- 0x0000 0000 0000 0000
447
448 For each 8-byte block b in B1 to B4 do:
449
450 * M <- M XOR b
451 * M <- 1DES_encrypt(Kl, M)
452
453 Done
454
455 * M <- 1DES_decrypt(Kr, M)
456 * M <- 1DES_encrypt(Kl, M)
457
458 End function
459