Wiki source code of Payment Service provider API ISO8583_2 ( IFSF) H2H description

Version 30.18 by Pål-Eirik Askerød on 2017/11/02 14:46

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