Wiki source code of Payment Service Provider API ISO 8583:1993 (IFSF) H2H description

Version 34.1 by Cecilie Tyldum on 2017/11/08 12:26

4.1	1	(% class="WordSection1" %)
	2	(((
19.1	3	= Overview =
5.2	4
30.24	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.
5.2	6
	7
31.1	8	{{lucidchart documentId="35a45310-6ed3-4c48-931d-59c4b5bda7a7" size="600"/}}
5.2	9
	10
	11
19.1	12	The third party host can be a single or dual host system.
	13	PayEx has a fully redundant system, with an active/active configuration.
30.23	14	The third party host(s) connects to a load balancer at PayEx.
19.1	15
	16
20.1	17	== Supported massage types ==
19.1	18
4.1	19
21.1	20	\|=Message Type\|=Reference
23.1	21	\|1100/1110\|[[AUTHORISATION REQUEST>>doc:AUTHORISATION REQUEST 1100/1110]]
23.2	22	\|1200/1210\|[[FINANCIAL TRANSACTION REQUEST>>doc:.FINANCIAL TRANSACTION REQUEST 1200/1210.WebHome]]
	23	\|1220/1221/1230\|[[FINANCIAL TRANSACTION ADVICE>>doc:FINANCIAL TRANSACTION ADVICE 1220/1221/1230]]
	24	\|1420/1421/1430\|[[REVERSAL ADVICE>>doc:REVERSAL ADVICE 1420/1421/1430]]
	25	\|1820/1830\|[[NETWORK MANAGEMENT>>doc:.NETWORK MANAGEMENT 1820/1830.WebHome]]
30.3	26	\|1520/1521/1530\|RECONCILIATION REQUEST (Currently not supported)
4.1	27
30.15	28	* Message types included in the table above are supported unless otherwise specified. E-g reconciliation is not currently supported.
	29	Use links to different message types for details on specific messages.
30.31	30	Only the Financial transaction advice (1220), Reversal Advice (1420) use repeat messages(1221 and 1421). Repeats are to be sent according to rules below.
	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 with exponential wait period between retires. After 6 retry attempts have failed manual intervention by third party and PayEx support must be initiated.
4.1	32
19.1	33	== Message layout ==
	34
16.1	35	This section covers message types and fields supported by PayEx
4.1	36
17.2	37
16.1	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
17.2	44	)))
4.1	45
30.15	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 get action code 904 - Format Error.
17.2	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
24.2	83	== Message protocol ==
17.2	84
24.2	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).
30.26	91	* An 8 byte message bitmap, which is a binary field (not ASCII encoded).
24.2	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:
17.2	100
24.2	101
24.3	102	\|=Length\|=(((
	103	Message ID
	104	)))\|=Bitmap
24.2	105	\|=0x30 0x30 0x31 0x32\|=0x30 0x33 0x30 0x30\|=0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
	106
24.3	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
30.26	113	\|Message ID\|n\|ASCII\|31383230\|1820
30.9	114	\|Bitmap\|b\|Binary\|0230010100000000\|
24.3	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
30.9	119	\|33 - Forwarding institution identification code\|n\|ASCII\|(((
	120	30323135
	121	)))\|15
24.3	122
30.19	123	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)
24.3	124
30.27	125	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.
24.3	126
30.31	127	== ==
30.13	128
25.1	129	== PIN Validation ==
	130
29.2	131	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	132
	133	Fields required for PIN validation are:
	134
	135	* P-48-14 – PIN encryption Methodology
	136	* P-52 – PIN data
	137	* P-53 – Security related information
	138
32.1	139	(% class="wikigeneratedid" id="H-1" %)
30.16	140	See [[security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] for details.
30.13	141
30.7	142	== Security documentation ==
	143
30.22	144	Here you can find details regarding the security elements of this H2H integration.
30.7	145
30.13	146	__[[SECURITY SPECIFICATION>>doc:.PayEx IFSF H2H Security specification.WebHome]]__
30.12	147
30.21	148	== Response codes ==
	149
	150	Here you can find the response codes which may be returned from PayEx.
	151
	152	[[RESPONSE CODES>>doc:.Response codes.WebHome]]
	153
30.31	154	== ==
30.21	155
30.18	156	== Message field overview ==
26.1	157
	158	P-3 PROCESSING CODE
	159
30.28	160	Code used to describe the effect of a transaction on the customer account and the accounts affected. Currently fixed 000000 : Goods and services
26.1	161
30.13	162
26.1	163	P-4 AMOUNT, TRANSACTION
	164
30.29	165	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
26.1	166
30.13	167
26.1	168	P-7 DATE AND TIME, TRANSMISSION
	169
	170	Date and time of message transmission from the third party host.
	171
30.13	172
26.1	173	P-11 SYSTEM TRACE AUDIT NUMBER
	174
30.28	175	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.
30.13	176
	177
26.1	178	P-12 DATE AND TIME, LOCAL TRANSACTION
	179
	180	Date and time of the transaction when performed on the POS.
	181
30.13	182
26.1	183	P-22 POINT OF SERVICE DATA CODE
	184
	185	A series of codes intended to identify terminal capability, terminal environment and presentation security data.
	186
	187
	188	P-24 FUNCTION CODE
	189
	190	\|=Function code\|=Description
	191	\|101\|Original authorization, amount estimated used in 1100
	192	\|200\|Original financial request/advice Used in 1200/1220/1221
	193	\|201\|Previously approved authorisation, amount the same Used in 1220/1221
	194	\|202\|Previously approved authorisation, amount differs Used in 1220/1221
	195	\|400\|Full reversal Used in 1420/1421
	196	\|831\|Echo test Used in 1820
	197
	198	P-25 MESSAGE REASON CODE
	199
	200	\|=reason code \|=Description
30.19	201	\|1003\|Card issuer unavailable
26.1	202	\|1004\|Terminal processed
30.20	203	\|1005\|ICC processed
26.1	204	\|1508\|On-line forced by terminal
	205	\|4000\|Customer cancellation
	206	\|4020\|Invalid response, no action taken
	207	\|4021\|Timeout waiting for response
	208	\|4351\|Cancellation - unmatched signature
	209
	210	P-30 ORIGINAL AMOUNT
	211
	212	The original amount data element is a constructed element of two parts with a total of 24 positions:
	213	a) Original amount transaction, n 12;
	214	b) Original amount reconciliation, n 12.
	215	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.
	216
30.13	217
26.1	218	P-33 FORWARDING INSTITUTION IDENTIFICATION CODE
	219
	220	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.
	221
30.13	222
26.1	223	P-38 APPROVAL CODE
	224
	225	Code assigned by the authorising institution indicating approval.
	226
30.13	227
26.1	228	P-39 ACTION CODE
	229
30.30	230	See action code page for codes that can be returned by PayEx.
27.1	231
30.13	232
27.1	233	P-41 Card acceptor terminal identification
30.30	234	Needs to be unique per POS terminal at the merchant site.
27.1	235
30.13	236
27.1	237	P-42 Card acceptor identification code
	238
	239	8 digit unique ID provided by PayEx for each merchant.
	240
30.13	241
27.1	242	P-43 Card acceptor name/location
	243
	244	The name and location of the card acceptor.
	245
30.13	246
27.1	247	P-48 MESSAGE CONTROL DATA ELEMENTS
	248	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.
	249
	250
30.13	251	P-48-4 BATCH/SEQUENCE NUMBER
	252
27.1	253	This field identifies the transactions associated with a particular settlement period. This number starts at one and increments with each Reconciliation.
	254
	255
30.13	256	P-48-8 CUSTOMER DATA
	257
27.1	258	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.
	259
	260	\|=Element\|=Name\|=Attribute\|=Description
	261	\|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.
	262	\|48-8-2\|Type of customer data\|an 1\|Identifies the type of customer data entered. (see P48-8-2)
	263	\|48-8-3\|Value of customer data\|ans...99\|Data entered by customer orcashier.
	264
28.1	265	P-48-8-2 TYPE OF CUSTOMER DATA
27.1	266
30.19	267	1 - Vehicle ID
28.1	268	3 - Driver ID
	269	4 - Mileage
30.19	270
27.1	271
30.19	272	P-48-9 TRACK II OF VEHICLE CARD
27.1	273
30.19	274	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.
27.1	275
	276
30.13	277	P-48-14 PIN ENCRYPTION METHODOLOGY
30.5	278
30.13	279	See [[security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] section for details.
30.5	280
27.1	281
	282	P-48-37 VEHICLE IDENTIFICATION ENTRY MODE
	283	Only present when a vehicle number is available (P48-8). Defines how the vehicle number was entered:
	284
	285	0 - Manual entry
	286	1- On the Card
30.19	287	2 - Automatic License Plate Recognition
27.1	288
30.13	289
27.1	290	P-48-38 PUMP LINKED INDICATOR
	291
28.1	292	Indicating whether the fuel pump reading is is linked to the payment terminal:
27.1	293	0 – Unspecified
	294	1 – Pump-linked
	295	2 – Pump not linked
	296
	297
	298	P-48-39 DELIVERY NOTE NUMBER
	299	Number allocated by the terminal given to the customer as printed on the ticket.
	300
30.13	301
27.1	302	P-49 CURRENCY CODE , TRANSACTION
	303	All transactions are in local currency, as defined during system installation. Actual value is as defined by ISO 4217.
	304
30.13	305
27.1	306	P-52 PIN DATA
28.1	307
30.13	308	See[[ security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] section for details.
28.1	309
30.13	310
28.1	311	P-53 SECURITY RELATED CONTROL INFORMATION
	312
30.13	313	See[[ security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] section for details.
28.1	314
	315
28.2	316	P-56 ORIGINAL DATA ELEMENTS
	317
	318	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.
30.19	319	In Payment advice : Link to previous Authorization dialog
	320	In reversal advice : Link to previous Authorization request or previous Payment request being reversed.
28.1	321
28.2	322
	323	P-62 PRODUCT SETS AND MESSAGE DATA
	324
	325	This field contains allowed product sets and message data.
	326
	327	\|=Number\|=Name\|=Format\|=Attribute\|=Description
	328	\|62\| \|n\|3\|LLLVAR length field. Sets the length of P-62 data
	329	\|62-1\|Allowed products\|ans\|...99\|LLVAR field, contains the products that are allowed
	330	\|62-2\|Device text\|n\|1\|For what device 62-3 is to be sent to
30.29	331	\|62-3\|Message text\|ans\|...999\|LLLVAR field. Display text
28.2	332
	333	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.
	334
28.3	335
	336	P-63 PRODUCT DATA
	337
	338	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.
	339
30.19	340	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 (\).
28.3	341	Unit price and amount may be negative or positive, but the sum of the amounts in the product data must equal the transaction amount.
	342	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.
	343	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.
	344
	345	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:
	346
	347
	348	\|=Number\|=Format\|=Field\|=Description
	349	\|63\|n 3\|Product data\|LLLVAR length field. Sets the length of P-63 data
	350	\|63-1\|a 1\|Service level\|(((
	351	S - Self-serve
	352	F - Full serve
	353	Space - Information not available
	354	)))
	355	\|63-2\|n 2\|Number of products\|Count of products (sale item) reported for this transaction.
	356
	357	Each Sales item consists of the following components:
	358
	359
	360	\|=Number\|=Format\|=Field\|=Description
	361	\|63-3\|n 3 \|Product code\|3-digit product code that defines the type of product sold
30.13	362	\|63-4\|a 1 \|Unit of measure\|Indicates the meaning of the Quantity field. ‘U’ Sold per Unit
	363	‘O’ Unit of Measurement undefined ‘L’ Sold per Litre.
28.3	364	\|63-5\|n 9\|Quantity\|Number of product units
	365	\| \| \|Separator\|‘\’ To separate Quantity from Unit-Price
	366	\|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
	367	\| \| \|Separator\|‘\’ To separate Unit price from Amount
	368	\|63-7\|sn 12\|Amount\|Starts with a minus sign in case Item amount is negative. 2 decimals are always implied.
	369	\| \| \|Separator\|‘\’ To separate the Amount from the Vat Code
	370	\|63-8\|an 1\|Tax code\|1 digit VAT code
	371	\|63-9\|n 14\|Additional Product code\|Up to 14 digits article number as known in the POS
30.13	372	\| \| \|Terminator \|‘\’ To mark the end of this sales item
28.3	373
	374	P-64 MAC
	375
30.14	376	See [[security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] for details.
28.3	377
	378
30.11	379	P-127 Encrypted data
	380
30.13	381	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	382
30.17	383
	384	P-128 MAC
	385
30.19	386	This field is used for MAC if P-127 is present. See [[security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] for details.
30.18	387
30.14	388