Payment Service provider API ISO8583_2 ( IFSF) H2H description
Overview
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.
The third party host can be a single or dual host system.
PayEx has a fully redundant system, with an active/active configuration.
The third party host(s) connect to PayEx loadbalanser
Supported massage types
Message Type | Reference |
---|---|
1100/1110 | AUTHORISATION REQUEST |
1200/1210 | FINANCIAL TRANSACTION REQUEST |
1220/1221/1230 | FINANCIAL TRANSACTION ADVICE |
1420/1421/1430 | REVERSAL ADVICE |
1820/1830 | NETWORK MANAGEMENT |
- Message types not included in the table above are not supported. E-g reconciliation is not supported
Only the Financial transaction advice (1220), Reversal Advice (1420) use repeat messages. Repeats are to be sent according to xxxxxxx rules - 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 attemps have failed manual intervention by third party and PayEx support must be initiated.
Message layout
This section covers message types and fields supported by PayEx
Presence | Title | Description |
---|---|---|
C | Conditional | The data element’s presence depends on specific circumstances, witch are described either directly or by reference in the message content table. |
CE | Conditional echo | The response message must have the same data element if the data element was present in the original message |
M | Mandatory | Data element must be present in the specified message |
ME | Mandatory echo | The response message must have the same data element and value as sent in the original message request or advice message |
O | Optional | The data element may or may not be present in the message |
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 be 904 - Format Error.
The third party host must ignore unknown fields included in the response messages.
When no usage notes are given in the field description, the field should be used as described in IFSF [1].
The “Format”-column can contain following info:
- 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.
- 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.
- Date/time field formats, YYMMDDhhmmss (or variations), where:
- YY : Last 2 digits of the year, 00 through 99
- MM: Month, 01 through 12.
- DD: Day, 01 through 31
- hh: Hour, 00 through 23
- mm: Minutes, 00 through 59
- ss: Seconds, 00 through 59
The “Type”-column can contain:
- a : Alphabetic character [a..z,A..Z]
- n : Numeric BCD-digit. [0..9]
- ans: alphabetic, numeric and special characters
- an : alphabetic and numeric.
- s : Special characters.
- b : Binary
- p: pad character, space
- x: “C” for credit, “D” for debit and shall always be associated with a numerical amount data element.
The “Size”-column can contain:
- Variable length fields have a size that looks like “..nn”, where nn is the maximum number of characters or bytes.
- A fixed length field has “n” as size content, with n the number of characters or bytes.
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.
Message protocol
All messages are transferred using TCP/IP sockets.
The message will be encapsulated in a transmission frame as follows:
- 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.
- This 4-digit length field is immediately followed by the message ID, also in ASCII (decimal value, most significant digit first).
- An 8 byte message bitmap, which is a binary field (so not ASCII encoded).
- 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:
- All fixed length numeric data element values shall be right justified with leading zeroes.
- All fixed length data elements with alphabetic or special characters shall be left justified with trailing blanks.
- All fixed length binary data elements shall be right justified with leading zeroes.
- 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])
- No trailer is included.
Example: An imaginary message which consists only of a message ID “0300” and an empty bitmap (all zeros) will be transmitted as follows:
Length | Message ID | Bitmap |
---|---|---|
0x30 0x30 0x31 0x32 | 0x30 0x33 0x30 0x30 | 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 |
Example: An 1820 message, without MAC, will be transmitted as follows: Message bytes (hex):
303035303138323002300101000000003039313031353238343133383239313030393039313031353238343138333130353130303331
Field | Format | Encoding | Data | Parsed |
---|---|---|---|---|
Message Length | n | ASCII | 30303530 | 0050 |
Massage ID | n | ASCII | 31383230 | 1820 |
Bitmat | b | Binary | 0230010100000000 | |
7 - Date/Time | n | ASCII | 30393130313532383431 | 0910152841 |
11 - STAN | n | ASCII | 333832393130 | 382910 |
12 - Date/Time | n | ASCII | 303930393130313532383431 | 090910152841 |
24 - Function code | n | ASCII | 383331 | 831 |
32 - Acquiring institution identification code | n | ASCII | TODO eksempel | TODO eksempel |
The PayEx response timeout is set to XX seconds. If after xx+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)
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.
PIN Validation
PayEx perform online PIN validation on paye,ent 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.
Fields required for PIN validation are:
- P-48-14 – PIN encryption Methodology
- P-52 – PIN data
- P-53 – Security related information
Message field details
P-2 PAN
Personal Account Number, identifies the card.Only mandatory for Manual PAN transactions (replacement for Track2Data P35)
P-3 PROCESSING CODE
Code used to describe the effect of a transaction on the customer account and the accounts affected. Fixed 00000000 : Goods and services
P-4 AMOUNT, TRANSACTION
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
P-7 DATE AND TIME, TRANSMISSION
Date and time of message transmission from the third party host.
P-11 SYSTEM TRACE AUDIT NUMBER
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.
P-12 DATE AND TIME, LOCAL TRANSACTION
Date and time of the transaction when performed on the POS.
P-14 DATE EXPIRY
Month and year of card expiry. Only mandatory for a manual PAN transaction
P-22 POINT OF SERVICE DATA CODE
A series of codes intended to identify terminal capability, terminal environment and presentation security data.
Point of service date code | Description |
---|---|
POS 1: Card data input capabilities | 2: magnetic stripe read A: RFID B: Magnetic stripe reader and key entry C: Magnetic stripe reader, ICC and key entry D: Magnetic stripe reader and ICC |
Pos 2: Cardholder authentication capability | 1: PIN Y: Signature,plaintext/enciphered PIN offline and ‘no cvm’ capable, enciphered pin online |
Pos 3: Card capture capability | 0:None T: None and SDA/DDA/CDA capable |
Pos 4: Operating environment | 1: On premises of card acceptor, attended |
Pos 5: Cardholder present | 0: Cardholder present |
Pos 6: Card present | 1: Card present |
Pos 7: Card data input mode | 2: Magnetic stripe read 3: Bar code 5: ICC 6: Key entered A: RFID D: Magnetic stripe read following failed chip card read |
Pos 8: Cardholder authentication method | 0: Not authenticated 1: PIN 5: Manual signature verification |
Pos 9: Cardholder authentication entity | 0: Not authenticated 1: ICC 2: Card acceptor device 3: Authorizing Agent |
Pos 10: Card data output capability | 1: None 3: ICC |
Pos 11: Terminal output capability | 2: Printing 4: Printing and display |
Pos 12: PIN capture capability | C: Twelve characters |
P-24 FUNCTION CODE
Function code | Description |
---|---|
101 | Original authorization, amount estimated used in 1100 |
200 | Original financial request/advice Used in 1200/1220/1221 |
201 | Previously approved authorisation, amount the same Used in 1220/1221 |
202 | Previously approved authorisation, amount differs Used in 1220/1221 |
400 | Full reversal Used in 1420/1421 |
831 | Echo test Used in 1820 |
P-25 MESSAGE REASON CODE
reason code | Description |
---|---|
1003 | Card issuer unabailable |
1004 | Terminal processed |
1508 | On-line forced by terminal |
4000 | Customer cancellation |
4020 | Invalid response, no action taken |
4021 | Timeout waiting for response |
4351 | Cancellation - unmatched signature |
P-30 ORIGINAL AMOUNT
The original amount data element is a constructed element of two parts with a total of 24 positions:
a) Original amount transaction, n 12;
b) Original amount reconciliation, n 12.
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.
P-32 ACQUIRING INSTITUTION IDENTIFICATION CODE
ISO 3166 - numeric country code of country where the POS transaction took place.
Country | ISO numeric country code |
---|---|
Norway | |
Sweden | |
Danmark | |
Finland |
P-33 FORWARDING INSTITUTION IDENTIFICATION CODE
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.
P-35 TRACK 2 DATA
The information encoded on track 2 of the magnetic stripe as defined in ISO7813, excluding beginning and ending sentinels and longitudinal redundancy check characters as defined therein.
Example: 123456789012345=00112233
P-38 APPROVAL CODE
Code assigned by the authorising institution indicating approval.
P-39 ACTION CODE
The following action codes are supported by OASE. Every action code not present in this table should be considered as declined.