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