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

Version 30.31 by Pål-Eirik Askerød on 2017/11/07 14:44

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
	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.23	15	The third party host(s) connects to a load balancer at PayEx.
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.
30.31	31	Only the Financial transaction advice (1220), Reversal Advice (1420) use repeat messages(1221 and 1421). Repeats are to be sent according to rules below.
	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 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	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).
30.26	92	* An 8 byte message bitmap, which is a binary field (not ASCII encoded).
24.2	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
30.26	114	\|Message 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.19	124	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	125
30.27	126	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	127
30.31	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.22	145	Here you can find details regarding the security elements of this H2H integration.
30.7	146
30.13	147	__[[SECURITY SPECIFICATION>>doc:.PayEx IFSF H2H Security specification.WebHome]]__
30.12	148
30.21	149	== Response codes ==
	150
	151	Here you can find the response codes which may be returned from PayEx.
	152
	153	[[RESPONSE CODES>>doc:.Response codes.WebHome]]
	154
30.31	155	== ==
30.21	156
30.18	157	== Message field overview ==
26.1	158
	159	P-3 PROCESSING CODE
	160
30.28	161	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	162
30.13	163
26.1	164	P-4 AMOUNT, TRANSACTION
	165
30.29	166	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	167
30.13	168
26.1	169	P-7 DATE AND TIME, TRANSMISSION
	170
	171	Date and time of message transmission from the third party host.
	172
30.13	173
26.1	174	P-11 SYSTEM TRACE AUDIT NUMBER
	175
30.28	176	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	177
	178
26.1	179	P-12 DATE AND TIME, LOCAL TRANSACTION
	180
	181	Date and time of the transaction when performed on the POS.
	182
30.13	183
26.1	184	P-22 POINT OF SERVICE DATA CODE
	185
	186	A series of codes intended to identify terminal capability, terminal environment and presentation security data.
	187
	188
	189	P-24 FUNCTION CODE
	190
	191	\|=Function code\|=Description
	192	\|101\|Original authorization, amount estimated used in 1100
	193	\|200\|Original financial request/advice Used in 1200/1220/1221
	194	\|201\|Previously approved authorisation, amount the same Used in 1220/1221
	195	\|202\|Previously approved authorisation, amount differs Used in 1220/1221
	196	\|400\|Full reversal Used in 1420/1421
	197	\|831\|Echo test Used in 1820
	198
	199	P-25 MESSAGE REASON CODE
	200
	201	\|=reason code \|=Description
30.19	202	\|1003\|Card issuer unavailable
26.1	203	\|1004\|Terminal processed
30.20	204	\|1005\|ICC processed
26.1	205	\|1508\|On-line forced by terminal
	206	\|4000\|Customer cancellation
	207	\|4020\|Invalid response, no action taken
	208	\|4021\|Timeout waiting for response
	209	\|4351\|Cancellation - unmatched signature
	210
	211	P-30 ORIGINAL AMOUNT
	212
	213	The original amount data element is a constructed element of two parts with a total of 24 positions:
	214	a) Original amount transaction, n 12;
	215	b) Original amount reconciliation, n 12.
	216	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.
	217
30.13	218
26.1	219	P-33 FORWARDING INSTITUTION IDENTIFICATION CODE
	220
	221	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.
	222
30.13	223
26.1	224	P-38 APPROVAL CODE
	225
	226	Code assigned by the authorising institution indicating approval.
	227
30.13	228
26.1	229	P-39 ACTION CODE
	230
30.30	231	See action code page for codes that can be returned by PayEx.
27.1	232
30.13	233
27.1	234	P-41 Card acceptor terminal identification
30.30	235	Needs to be unique per POS terminal at the merchant site.
27.1	236
30.13	237
27.1	238	P-42 Card acceptor identification code
	239
	240	8 digit unique ID provided by PayEx for each merchant.
	241
30.13	242
27.1	243	P-43 Card acceptor name/location
	244
	245	The name and location of the card acceptor.
	246
30.13	247
27.1	248	P-48 MESSAGE CONTROL DATA ELEMENTS
	249	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.
	250
	251
30.13	252	P-48-4 BATCH/SEQUENCE NUMBER
	253
27.1	254	This field identifies the transactions associated with a particular settlement period. This number starts at one and increments with each Reconciliation.
	255
	256
30.13	257	P-48-8 CUSTOMER DATA
	258
27.1	259	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.
	260
	261	\|=Element\|=Name\|=Attribute\|=Description
	262	\|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.
	263	\|48-8-2\|Type of customer data\|an 1\|Identifies the type of customer data entered. (see P48-8-2)
	264	\|48-8-3\|Value of customer data\|ans...99\|Data entered by customer orcashier.
	265
28.1	266	P-48-8-2 TYPE OF CUSTOMER DATA
27.1	267
30.19	268	1 - Vehicle ID
28.1	269	3 - Driver ID
	270	4 - Mileage
30.19	271
27.1	272
30.19	273	P-48-9 TRACK II OF VEHICLE CARD
27.1	274
30.19	275	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	276
	277
30.13	278	P-48-14 PIN ENCRYPTION METHODOLOGY
30.5	279
30.13	280	See [[security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] section for details.
30.5	281
27.1	282
	283	P-48-37 VEHICLE IDENTIFICATION ENTRY MODE
	284	Only present when a vehicle number is available (P48-8). Defines how the vehicle number was entered:
	285
	286	0 - Manual entry
	287	1- On the Card
30.19	288	2 - Automatic License Plate Recognition
27.1	289
30.13	290
27.1	291	P-48-38 PUMP LINKED INDICATOR
	292
28.1	293	Indicating whether the fuel pump reading is is linked to the payment terminal:
27.1	294	0 – Unspecified
	295	1 – Pump-linked
	296	2 – Pump not linked
	297
	298
	299	P-48-39 DELIVERY NOTE NUMBER
	300	Number allocated by the terminal given to the customer as printed on the ticket.
	301
30.13	302
27.1	303	P-49 CURRENCY CODE , TRANSACTION
	304	All transactions are in local currency, as defined during system installation. Actual value is as defined by ISO 4217.
	305
30.13	306
27.1	307	P-52 PIN DATA
28.1	308
30.13	309	See[[ security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] section for details.
28.1	310
30.13	311
28.1	312	P-53 SECURITY RELATED CONTROL INFORMATION
	313
30.13	314	See[[ security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] section for details.
28.1	315
	316
28.2	317	P-56 ORIGINAL DATA ELEMENTS
	318
	319	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	320	In Payment advice : Link to previous Authorization dialog
	321	In reversal advice : Link to previous Authorization request or previous Payment request being reversed.
28.1	322
28.2	323
	324	P-62 PRODUCT SETS AND MESSAGE DATA
	325
	326	This field contains allowed product sets and message data.
	327
	328	\|=Number\|=Name\|=Format\|=Attribute\|=Description
	329	\|62\| \|n\|3\|LLLVAR length field. Sets the length of P-62 data
	330	\|62-1\|Allowed products\|ans\|...99\|LLVAR field, contains the products that are allowed
	331	\|62-2\|Device text\|n\|1\|For what device 62-3 is to be sent to
30.29	332	\|62-3\|Message text\|ans\|...999\|LLLVAR field. Display text
28.2	333
	334	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.
	335
28.3	336
	337	P-63 PRODUCT DATA
	338
	339	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.
	340
30.19	341	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	342	Unit price and amount may be negative or positive, but the sum of the amounts in the product data must equal the transaction amount.
	343	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.
	344	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.
	345
	346	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:
	347
	348
	349	\|=Number\|=Format\|=Field\|=Description
	350	\|63\|n 3\|Product data\|LLLVAR length field. Sets the length of P-63 data
	351	\|63-1\|a 1\|Service level\|(((
	352	S - Self-serve
	353	F - Full serve
	354	Space - Information not available
	355	)))
	356	\|63-2\|n 2\|Number of products\|Count of products (sale item) reported for this transaction.
	357
	358	Each Sales item consists of the following components:
	359
	360
	361	\|=Number\|=Format\|=Field\|=Description
	362	\|63-3\|n 3 \|Product code\|3-digit product code that defines the type of product sold
30.13	363	\|63-4\|a 1 \|Unit of measure\|Indicates the meaning of the Quantity field. ‘U’ Sold per Unit
	364	‘O’ Unit of Measurement undefined ‘L’ Sold per Litre.
28.3	365	\|63-5\|n 9\|Quantity\|Number of product units
	366	\| \| \|Separator\|‘\’ To separate Quantity from Unit-Price
	367	\|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
	368	\| \| \|Separator\|‘\’ To separate Unit price from Amount
	369	\|63-7\|sn 12\|Amount\|Starts with a minus sign in case Item amount is negative. 2 decimals are always implied.
	370	\| \| \|Separator\|‘\’ To separate the Amount from the Vat Code
	371	\|63-8\|an 1\|Tax code\|1 digit VAT code
	372	\|63-9\|n 14\|Additional Product code\|Up to 14 digits article number as known in the POS
30.13	373	\| \| \|Terminator \|‘\’ To mark the end of this sales item
28.3	374
	375	P-64 MAC
	376
30.14	377	See [[security documentation>>doc:.PayEx IFSF H2H Security specification.WebHome]] for details.
28.3	378
	379
30.11	380	P-127 Encrypted data
	381
30.13	382	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	383
30.17	384
	385	P-128 MAC
	386
30.19	387	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	388
30.14	389