Last modified by Bjørnar Ruud on 2021/03/18 10:47
Show last authors
1 (% class="WordSection1" %)
2 (((
3 = Overview =
4
5 The H2H PayEx link enables authorization and capture of card transactions. Depending on the card, PayEx is either a PSP or the end host (card issuer). The third party host acts as a gateway between payment terminals and PayEx.
6
7
8 [[image:architecture.png]]
9
10
11 The third party host can be a single or dual host system.
12 PayEx has a fully redundant system, with an active/active configuration.
13 The third party host(s) connects to a load balancer at PayEx.
14
15
16 == Test system ==
17
18 Our test system is reachable over internet.
19
20 Host: **pospaydirecttx.externaltest.payex.com**
21
22 TCP Port: **9046**
23
24 For production, secure connection are required. Contact PayEx for production setup.
25
26 == Supported message types ==
27
28
29 |=Message Type|=Reference
30 |1100/1110|[[AUTHORISATION REQUEST>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.AUTHORISATION REQUEST 1100/1110]]
31 |1200/1210|[[FINANCIAL TRANSACTION REQUEST>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.FINANCIAL TRANSACTION REQUEST 1200/1210.WebHome]]
32 |1220/1221/1230|[[FINANCIAL TRANSACTION ADVICE>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.FINANCIAL TRANSACTION ADVICE 1220/1221/1230]]
33 |1420/1421/1430|[[REVERSAL ADVICE>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.REVERSAL ADVICE 1420/1421/1430]]
34 |1820/1830|[[NETWORK MANAGEMENT>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.NETWORK MANAGEMENT 1820/1830.WebHome]]
35 |1520/1521/1530|RECONCILIATION REQUEST (**Currently not supported)**
36
37 * Message types included in the table above are supported unless otherwise specified. E-g reconciliation is not currently supported.
38 Use links to different message types for details on specific messages.
39 Only the Financial transaction advice (1220), Reversal Advice (1420) use repeat messages(1221 and 1421). Repeats are to be sent according to rules below.
40 * 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 with exponential wait period between retires. After 6 retry attempts have failed manual intervention by third party and PayEx support must be initiated.
41
42 == Message layout ==
43
44 This section covers message types and fields supported by PayEx
45
46
47 |=Presence|=Title|=Description
48 |C|Conditional|The data element’s presence depends on specific circumstances, witch are described either directly or by reference in the message content table.
49 |CE|Conditional echo|The response message must have the same data element if the data element was present in the original message
50 |M|Mandatory|Data element must be present in the specified message
51 |ME|Mandatory echo|The response message must have the same data element and value as sent in the original message request or advice message
52 |O|Optional|The data element may or may not be present in the message
53 )))
54
55 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 get action code 904 - Format Error.
56
57 The third party host must ignore unknown fields included in the response messages.
58
59 When no usage notes are given in the field description, the field should be used as described in IFSF [1].
60
61 The “Format”-column can contain following info:
62
63 * 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.
64 * 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.
65 * Date/time field formats, YYMMDDhhmmss (or variations), where:
66 ** YY : Last 2 digits of the year, 00 through 99
67 ** MM: Month, 01 through 12.
68 ** DD: Day, 01 through 31
69 ** hh: Hour, 00 through 23
70 ** mm: Minutes, 00 through 59
71 ** ss: Seconds, 00 through 59
72
73 The “Type”-column can contain:
74
75 * a : Alphabetic character [a..z,A..Z]
76 * n : Numeric BCD-digit. [0..9]
77 * ans: alphabetic, numeric and special characters
78 * an : alphabetic and numeric.
79 * s : Special characters.
80 * b : Binary
81 * p: pad character, space
82 * x: “C” for credit, “D” for debit and shall always be associated with a numerical amount data element.
83
84 The “Size”-column can contain:
85
86 * Variable length fields have a size that looks like “..nn”, where nn is the maximum number of characters or bytes.
87 * A fixed length field has “n” as size content, with n the number of characters or bytes.
88
89 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.
90
91
92 == Message protocol ==
93
94 All messages are transferred using TCP/IP sockets.
95
96 The message will be encapsulated in a transmission frame as follows:
97
98 * 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.
99 * This 4-digit length field is immediately followed by the message ID, also in ASCII (decimal value, most significant digit first).
100 * An 8 byte message bitmap, which is a binary field (not ASCII encoded).
101 * 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:
102 ** All fixed length numeric data element values shall be right justified with leading zeroes.
103 ** All fixed length data elements with alphabetic or special characters shall be left justified with trailing blanks.
104 ** All fixed length binary data elements shall be right justified with leading zeroes.
105 ** 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])
106 ** No trailer is included.
107
108 Example: An imaginary message which consists only of a message ID “0300” and an empty bitmap (all zeros) will be transmitted as follows:
109
110
111 |=Length|=(((
112 Message ID
113 )))|=Bitmap
114 |=0x30 0x30 0x31 0x32|=0x30 0x33 0x30 0x30|=0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
115
116 Example: An 1820 message, without MAC, will be transmitted as follows: Message bytes (hex):
117 303035303138323002300101000000003039313031353238343133383239313030393039313031353238343138333130353130303331
118
119
120 |=Field|=Format|=Encoding|=Data|=Parsed
121 |Message Length|n|ASCII|30303530|0050
122 |Message ID|n|ASCII|31383230|1820
123 |Bitmap|b|Binary|0230010100000000|
124 |7 - Date/Time|n|ASCII|30393130313532383431|0910152841
125 |11 - STAN|n|ASCII|333832393130|382910
126 |12 - Date/Time|n|ASCII|303930393130313532383431|090910152841
127 |24 - Function code|n|ASCII|383331|831
128 |33 - Forwarding institution identification code|n|ASCII|(((
129 30323135
130 )))|15
131
132 The PayEx response timeout is set to 35 seconds. If after 35+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)
133
134 The third party host has the possibility to perform offline stand-in, thought this needs to be agreed with the individual card issuers. Otherwise the merchant might not be reimbursed.
135
136 == ==
137
138 == PIN Validation ==
139
140 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.
141
142 Fields required for PIN validation are:
143
144 * P-48-14 – PIN encryption Methodology
145 * P-52 – PIN data
146 * P-53 – Security related information
147
148 (% class="wikigeneratedid" id="H-1" %)
149 See [[security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] for details.
150
151 == Security documentation ==
152
153 Here you can find details regarding the security elements of this H2H integration.
154
155 __[[SECURITY SPECIFICATION>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]]__
156
157 == Response codes ==
158
159 Here you can find the response codes which may be returned from PayEx.
160
161 [[RESPONSE CODES>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.Response codes.WebHome]]
162
163 == ==
164
165 == Message field overview ==
166
167 **P-3 PROCESSING CODE**
168
169 Code used to describe the effect of a transaction on the customer account and the accounts affected. Currently fixed 000000 : Goods and services
170
171
172 **P-4 AMOUNT, TRANSACTION**
173
174 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 : NOK 1 = 100
175
176
177 **P-7 DATE AND TIME, TRANSMISSION**
178
179 Date and time of message transmission from the third party host.
180
181
182 **P-11 SYSTEM TRACE AUDIT NUMBER**
183
184 Number assigned by the third party host to assist in identifying a transaction uniquely. Range from 000001 to 999999. Every message must have a new STAN, repeats use the same STAN as the original message.
185
186
187 **P-12 DATE AND TIME, LOCAL TRANSACTION**
188
189 Date and time of the transaction when performed on the POS.
190
191
192 **P-22 POINT OF SERVICE DATA CODE**
193
194 A series of codes intended to identify terminal capability, terminal environment and presentation security data.
195
196
197 **P-24 FUNCTION CODE**
198
199 |=Function code|=Description
200 |101|Original authorization, amount estimated used in 1100
201 |200|Original financial request/advice Used in 1200/1220/1221
202 |201|Previously approved authorisation, amount the same Used in 1220/1221
203 |202|Previously approved authorisation, amount differs Used in 1220/1221
204 |400|Full reversal Used in 1420/1421
205 |831|Echo test Used in 1820
206
207 **P-25 MESSAGE REASON CODE**
208
209 |=reason code |=Description
210 |1003|Card issuer unavailable
211 |1004|Terminal processed
212 |1005|ICC processed
213 |1508|On-line forced by terminal
214 |4000|Customer cancellation
215 |4020|Invalid response, no action taken
216 |4021|Timeout waiting for response
217 |4351|Cancellation - unmatched signature
218
219 **P-30 ORIGINAL AMOUNT**
220
221 The original amount data element is a constructed element of two parts with a total of 24 positions:
222 a) Original amount transaction, n 12;
223 b) Original amount reconciliation, n 12.
224 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.
225
226
227 **P-33 FORWARDING INSTITUTION IDENTIFICATION CODE**
228
229 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.
230
231
232 **P-38 APPROVAL CODE**
233
234 Code assigned by the authorising institution indicating approval.
235
236
237 **P-39 ACTION CODE**
238
239 See action code page for codes that can be returned by PayEx.
240
241
242 **P-41 Card acceptor terminal identification**
243 Needs to be unique per POS terminal at the merchant site.
244
245
246 **P-42 Card acceptor identification code**
247
248 8 digit unique ID provided by PayEx for each merchant.
249
250
251 **P-43 Card acceptor name/location**
252
253 The name and location of the card acceptor.
254
255
256 **P-48 MESSAGE CONTROL DATA ELEMENTS**
257 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.
258
259
260 **P-48-4 BATCH/SEQUENCE NUMBER**
261
262 This field identifies the transactions associated with a particular settlement period. This number starts at one and increments with each Reconciliation.
263
264
265 **P-48-8 CUSTOMER DATA**
266
267 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.
268
269 |=Element|=Name|=Attribute|=Description
270 |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.
271 |48-8-2|Type of customer data|an 1|Identifies the type of customer data entered. (see P48-8-2)
272 |48-8-3|Value of customer data|ans...99|Data entered by customer orcashier.
273
274 **P-48-8-2 TYPE OF CUSTOMER DATA**
275
276 1 - Vehicle ID
277 3 - Driver ID
278 4 - Mileage
279
280
281 **P-48-9 TRACK II OF VEHICLE CARD**
282
283 Used to specify the second card in a transaction if a special card is needed in addition to the payment card to link a transaction to a loyalty account.
284
285
286 **P-48-14 PIN ENCRYPTION METHODOLOGY**
287
288 See [[security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] section for details.
289
290
291 **P-48-37 VEHICLE IDENTIFICATION ENTRY MODE**
292 Only present when a vehicle number is available (P48-8). Defines how the vehicle number was entered:
293
294 0 - Manual entry
295 1- On the Card
296 2 - Automatic License Plate Recognition
297
298
299 **P-48-38 PUMP LINKED INDICATOR**
300
301 Indicating whether the fuel pump reading is is linked to the payment terminal:
302 0 – Unspecified
303 1 – Pump-linked
304 2 – Pump not linked
305
306
307 **P-48-39 DELIVERY NOTE NUMBER**
308 Number allocated by the terminal given to the customer as printed on the ticket.
309
310
311 **P-49 CURRENCY CODE , TRANSACTION**
312 All transactions are in local currency, as defined during system installation. Actual value is as defined by ISO 4217.
313
314
315 **P-52 PIN DATA**
316
317 See[[ security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] section for details.
318
319
320 **P-53 SECURITY RELATED CONTROL INFORMATION**
321
322 See[[ security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] section for details.
323
324
325 **P-56 ORIGINAL DATA ELEMENTS**
326
327 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.
328 In Payment advice : Link to previous Authorization dialog
329 In reversal advice : Link to previous Authorization request or previous Payment request being reversed.
330
331
332 **P-61 PIN KSN**
333
334 This optional field contains a KSN for the PinBlock. To be used instead of the PinKey indicated in P53. See[[ security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] section for more details.
335
336 |=Number|=(% style="width: 229px;" %)Name|=(% style="width: 216px;" %)Format|=Attribute|=Description
337 |61|(% style="width:229px" %) |(% style="width:216px" %)n|3|LLLVAR length field. Sets the length of P-61 data
338 |62-1|(% style="width:229px" %)PIN KSN|(% style="width:216px" %)ans|20|PIN KSN for the PinBlock. Formated as a Hex encoded string
339
340 **P-62 PRODUCT SETS AND MESSAGE DATA**
341
342 This field contains allowed product sets and message data.
343
344 |=Number|=Name|=Format|=Attribute|=Description
345 |62| |n|3|LLLVAR length field. Sets the length of P-62 data
346 |62-1|Allowed products|ans|...99|LLVAR field, contains the products that are allowed
347 |62-2|Device text|n|1|For what device 62-3 is to be sent to
348 |62-3|Message text|ans|...999|LLLVAR field. Display text
349
350 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.
351
352
353 **P-63 PRODUCT DATA**
354
355 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.
356
357 Each product is represented by seven fields: Product Code, Unit of Measure, Quantity, Unit Price, Amount, Tax code and Additional product code. The variable length fields and the succeeding entry are separated by a back-slash (\).
358 Unit price and amount may be negative or positive, but the sum of the amounts in the product data must equal the transaction amount.
359 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.
360 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.
361
362 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:
363
364
365 |=Number|=Format|=Field|=Description
366 |63|n 3|Product data|LLLVAR length field. Sets the length of P-63 data
367 |63-1|a 1|Service level|(((
368 S - Self-serve
369 F - Full serve
370 Space - Information not available
371 )))
372 |63-2|n 2|Number of products|Count of products (sale item) reported for this transaction.
373
374 Each Sales item consists of the following components:
375
376
377 |=Number|=Format|=Field|=Description
378 |63-3|n 3 |Product code|3-digit product code that defines the type of product sold
379 |63-4|a 1 |Unit of measure|Indicates the meaning of the Quantity field. ‘U’ Sold per Unit
380 ‘O’ Unit of Measurement undefined ‘L’ Sold per Litre.
381 |63-5|n 9|Quantity|Number of product units
382 | | |Separator|‘\’ To separate Quantity from Unit-Price
383 |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
384 | | |Separator|‘\’ To separate Unit price from Amount
385 |63-7|sn 12|Amount|Starts with a minus sign in case Item amount is negative. 2 decimals are always implied.
386 | | |Separator|‘\’ To separate the Amount from the Vat Code
387 |63-8|an 1|Tax code|1 digit VAT code
388 |63-9|n 14|Additional Product code|Up to 14 digits article number as known in the POS
389 | | |Terminator |‘\’ To mark the end of this sales item
390
391 **P-64 MAC**
392
393 See [[security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] for details.
394
395
396 **P-127 Encrypted data**
397
398 This field contains the encrypted track2 data. See [[security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] section for details on how to generate this field.
399
400
401 **P-128 MAC**
402
403 **This field is used for MAC if P-127 is present**. See [[security documentation>>doc:Main.POS.Payment Service provider API ISO8583_2 ( IFSF) H2H description.PayEx IFSF H2H Security specification.WebHome]] for details.