Payment interface (Payment Provider)

MessageHeader

defined data structure

Message header of the Sale to POI protocol message

Y

     MessageClass

Enum

Class of the message

Y

Service

     MessageCategory

Enum

Category of message.

Y

Payment

     MessageType

Enum

Type of message of the Sale to POI protocol

Y

Request

     ServiceID

TextString

{1,10}

Identification of a message pair, which processes a transaction

Y

H0449FO18082500002PAC

     SaleID

TextString

Identification of a Sale System or a Sale Terminal for the Sale to POI protocol

Y

w-eu-h0416FLS1

     POIID

TextString

Identification of a POI System or a POI Terminal for the Sale to POI protocol

Y

CAP

PaymentRequest

defined data structure

Content of the Payment Request message

Y

     SaleData

defined data structure

Data related to the Sale System.

Y

           OperatorID

TextString

Identification of the Cashier or Operator

Allow to identify the origin of the transaction in the provider extranet

Y

FOLS

           SaleTransactionID

defined data structure

Unique identification of a Sale transaction

Y

                  TransactionID

TextString

Unique identification of a transaction

Y

770221118431

                  TimeStamp

ISODateTime

Date and time of a transaction for the Sale System, the POI System or the Acquirer

Y

"2019-07-09T23:18:00-05:00"

           SaleReferenceID

TextString

ID provided in the field SaleReferenceID in the Pre authorisation response message

Rule : Mandatory if payment reservation or if CustomerOrder is present.

Identification of a Sale global transaction for a sequence of related POI transactions

Y

770221118431

     PaymentTransaction

defined data structure

Data related to the payment and loyalty transaction

Y

           AmountsReq

defined data structure

Rule : Absent only if the maximum amount is unknown.

Various amounts related to the payment and loyalty request from the Sale System

Y

                  Currency

ISOCurrency3A

Currency of a monetary amount

Y

EUR

                RequestedAmount

SimpleAmountType

Amount requested by the Sale for the payment

If the amount do not the total amount of the pre-authorisation, then the rest of the amount should be released

Y

80.00

     PaymentData

defined data structure

Rule: If one data element is present.

Data related to the payment transaction.

Y

           PaymentType

Enum

Rule: default Normal.

Type of payment transaction.

Y

Completion

          PaymentInstrumentData

defined data structure

Rule: If payment instrument data is read by the Sale System.

Data related to the instrument of payment for the transaction.

Y

                PaymentInstrumentType

Enum

• "Token" – indicates that the current token number is used to initiate the transaction.
• "Card" indicates that the actual card number is used to initiate the transaction

Only token will be send from the ACCOR API

Y

Token

                  CardData

defined data structure

Rule: If PaymentInstrumentType is "Card"

Information related to the payment card used for the transaction.”

Y

                         EntryMode

Enumeration

Entry mode of the payment instrument information

• "RFID" indicates that payment instrument information are taken from RFID
• "Keyed" indicates Manual key entry
• "Manual" indicates that reading of embossing or OCR of printed data either at time of transaction or after the event.
• "File" indicates account data on file
• "Scanned" indicates that scanned by a bar code reader.
• "MagStripe" indicates that magnetic stripe card reader.
• "ICC" indicates that contact ICC (asynchronous)
• "SynchronousICC" indicates that contact ICC (synchronous)
• "Tapped" indicates that contactless card reader Magnetic Stripe
• "Contactless" indicates that contactless card reader conform to ISO 14443
• "Mobile" indicates mobile phone.

Y

File

                       SensitiveCardData

defined data structure

Rule: If structure non empty (could be CMS protected EnvelopedData)

Sensitive information related to the payment card, entered or read by the Sale System

Y

                              ExpiryDate

DigitString

{4,4}

Rule: if EntryMode is File, Keyed or Manual and data available on the card.

if EntryMode is File, Keyed or Manual and data available on the card

Y

1224

                                PAN

DigitString

if  EntryMode  is File, Keyed or Manual

Should be populated by the token number

Y

8766778345690119

MessageHeader

defined data structure

Message header of the Sale to POI protocol message.

Y

     MessageClass

Enum

Rule: Copy 

Class of the message

Y

Service

     MessageCategory

Enum

Rule: Payment

Category of message.

Y

Payment

     MessageType

Enum

Rule: Response

Type of message of the Sale to POI protocol

Y

Response

     ServiceID

TextString

{1,10}

Rule: Copy

Identification of a message pair, which processes a transaction

Y

H9732FO20101964276PAC

     SaleID

TextString

Rule: Copy

Identification of a Sale System or a Sale Terminal for the Sale to POI protocol

Y

w-eu-h0867FLS1

     POIID

TextString

Rule: Copy

Identification of a POI System or a POI Terminal for the Sale to POI protocol

Y

CNP: CAP

PaymentResponse

defined data structure

Content of the Payment Response message

Y

     Response

defined data structure

Result of a message request processing.

Y

           Result

Enum

Transaction Result

• Success
• Failure

Y

Success

           ErrorCondition

Enum

If the result is set to Failure then the condition should be part of the message.

Transaction Result

If Transaction Result = VOICE AUTHORISATION, set ErrorCondition =  "Referral"

N

DeviceOut

           AdditionnalResponse

TextString

Processing Status, Nok Reason, Terminal Verification Results (TVR) and Transaction Status Information (TSI).

Set as TLV structure

N

     SaleData

defined data structure

Data related to the Sale System.

Y

           SaleTransactionID

defined data structure

Rule: Copy

Unique identification of a Sale transaction

Y

                  TransactionID

TextString

Unique identification of a transaction

Y

770229891123

                  TimeStamp

ISODateTime

Date and time of a transaction for the Sale System, the POI System or the Acquirer.

Y

2020-07-09T09:18:00-05:00

             SaleReferenceID

TextString

Rule: Mandatory if payment reservation or if CustomerOrder is present.

Identification of a Sale global transaction for a sequence of related POI transactions

Y

770229891123

     POIData

defined data structure

Data related to the POI System.

Y

           POITransactionID

defined data structure

Unique identification of a POI transaction for a POI

Y

                  TransactionID

TextString

Unique identification of a transaction

Transaction Sequence Counter

Identification of the transaction for the POI

Y

84548739443

                  TimeStamp

ISODateTime

Date and time of a transaction for the Sale System, the POI System or the Acquirer.

Transaction Date Transaction Time

Local Date and Time of the POI

Y

2020-07-09T09:18:00-05:00

     PaymentResult

defined data structure

Rule: If one data element is present.

Data related to the result of a processed payment transaction.

Y

           PaymentType

Enum

Rule: Copy, default Normal

Y

Completion

          PaymentInstrumentData

defined data structure

Rule: If a payment instrument is analysed by the POI.

Data related to the instrument of payment for the transaction.

Y

                PaymentInstrumentType

Enum

Type of payment instrument.

Values:

-Card

-Check

-Mobile

-StoredValue

-Cash

Y

Token

                  CardData

defined data structure

Rule: If PaymentInstrumentType is "Card"

Information related to the payment card used for the transaction.

Y

                       PaymentBrand

TextString

Rule: If card PAN is readable.

Type of payment card.

One digit identifier with the meaning below:

V - VISA

N - VISAElectron

P - VPAY

M - MasterCard

E - Maestro

A - Amex

Y

V

                       MaskedPAN

TextString

PAN masked

required for the card, instead of clear PAN

Y

xxxxxxxxxxxx4121

                         EntryMode

Enum

Copy from request

Technology selected

Y

File

                       SensitiveCardData

defined data structure

Sensitive information related to the payment card, entered or read by the Sale System

Y

                                   ExpiryDate

DigitString

{4,4}

Expiration Date

If data available on the card

Y

1222

           AmountsResp

defined data structure

Rule: If Result is Success or Partial

Various amounts related to the payment response from the POI System.

Y

                  Currency

ISOCurrency3A

Rule: Mandatory for currency conversion.

Currency of a monetary amount.

Y

EUR

                AuthorizedAmount

SimpleAmountType

The amount authorized by the Acquirer for the payment transaction.

Y

100.00

           CurrencyConversion

defined data structure

This field could be populated when a DCC transaction will be processed.

If the customer currency is not the same as the hotel currency.

N

                ConvertedAmount

AmountType

Could be populated if CurrencyConversion is present

N

                       AmountValue

SimpleAmountType

Could be populated if ConvertedAmount is present

N

110.00

                         Currency

ISOCurrency3A

Could be populated if ConvertedAmount is present

N

USD

           PaymentAcquirerData

defined data structure

Rule: If card is analysed and data available

Data related to the response from the payment Acquirer.

Y

                  MerchantID

TextString

Identification of the Merchant for the Acquirer

Y

64022201

                  AcquirerPOIID

TextString

Identification of the POI for the payment Acquirer

Y

54017810

                  ApprovalCode

TextString

Rule: If available

Code assigned to a transaction approval by the Acquirer.

Y

936069

     PaymentReceipt

defined data structure

Rule : If Basic profile implementation with no printer on the POI.

Number of occurrences will be controlled by terminal parameters. ECR must support 0, 1 or 2 occurrences of this tag.

0 – No receipt will be printed

1 – Only one receipt copy will be printed, type will be specified by DocumentQualifier

2 – Two receipt copies to be printed, each type specified by DocumentQualifier.

Y

           DocumentQualifier

Enum

Rule: SaleReceipt or CashierReceipt

Qualification of the document to print to the Cashier or the Customer.

Values:

-CustomerReceipt (Client Copy)

-CashierReceipt – (Merchant Copy)

Y

MerchantReceipt

          RequiredSignatureFlag

Boolean

Rule: default False

Indicate that the cardholder payment receipt requires a physical signature by the Customer.

N

False

           OutputContent

defined data structure

Content to display or print

Y

                  OutputFormat

Enum

Rule : Text, XHTML

Format of the content to display or print.

Always set to “Text” -

Always set to “Text” -

The DisplayOutput is then an OutputText data structure.

Y

Text

                  OutputText

defined data structure

Content of text message to display or print.

At least one occurrence of this tag will be required when OutputFormat is set to “Text”. Each occurrence will be a formatted receipt line.

Y

                         Text

TextString

Content of text message to display, print or play.

Formatted receipt line content to be printed. Character set will be Basic Latin.

Y

MERCHANT RECEIPT

                       EndOfLineFlag

Boolean

Text is at the end of a line.

Indicates if the characters of the displayed Text must be terminated by an end of line.

Y

true

{

    "SaleToPOIRequest": {
        "MessageHeader": {
            "MessageCategory": "Payment",
            "MessageClass": "Service",
            "MessageType": "Request",
            "POIID": "CAP",
            "SaleID": "w-eu-h0416FLS1",
            "ServiceID": "H9732FO20101964276PAC"
        },
        "PaymentRequest": {
            "PaymentData": {
                "PaymentType": "Completion",
                "PaymentInstrumentData": {
                    "PaymentInstrumentType": "Token",
                    "CardData": {
                        "EntryMode": "File",
                        "SensitiveCardData": {
                            "ExpiryDate": "1222",
                            "PAN": "2879834888340043"
                        }
                    }
                }
            },
            "PaymentTransaction": {
                "AmountsReq": {
                    "Currency": "EUR",
                    "RequestedAmount": "20.00"
                }
            },
            "SaleData": {
                "OperatorID": "FOLS",
                "SaleReferenceID": "770234303596",
                "SaleTransactionID": {
                    "TimeStamp": "2020-10-19T15:05:38+02:00",
                    "TransactionID": "770234303596"
                }
            }
        }
    }
}

{

{
    "SaleToPOIResponse": {
        "MessageHeader": {
            "MessageCategory": "Payment",
            "MessageClass": "Service",
            "MessageType": "Response",
            "POIID": "CAP",
            "SaleID": "w-eu-h0416FLS1",
            "ServiceID": "H9732FO20101964276PAC"
        },
        "PaymentResponse": {
            "POIData": {
                "POITransactionID": {
                    "TimeStamp": "2020-10-19T13:05:41",
                    "TransactionID": "84548739443"
                }
            },
            "PaymentReceipt": [
                {
                    "DocumentQualifier": "CustomerReceipt",
                    "OutputContent": {
                        "OutputFormat": "Text",
                        "OutputText": [
                            {
                                "EndOfLineFlag": true,
                                "Text": "APOL MERCURE VALENCIENNES CENTRE"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "         Musterstr. 01          "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "       Musterstadt 90111        "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "            GERMANY             "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "--------------------------------"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": ""
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "19.10.20                   15:05"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "          KUNDENBELEG           "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "--------------------------------"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "TERMINAL: 54094619              "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "HÄNDLER: 147777778              "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "PAN: XXXXXXXXXXXX0043           "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "KARTENTYP: Visa                 "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "BUCHUNG                         "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "MANUELLER EINTRAG               "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "ENDGÜLTIGER BETRAG:    20,00 EUR"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "REFERENZ: 770234303596          "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "GENEHMIGUNGS-NR.: 042712        "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "              (00)              "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "     AUTORISIERUNG ERFOLGT      "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": " KEINE KARTENINH. VERIFIZIERUNG "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "BITTE FÜR IHRE UNTERLAG. AUFBEW."
                            }
                        ]
                    },
                    "RequiredSignatureFlag": ""
                },
                {
                    "DocumentQualifier": "CashierReceipt",
                    "OutputContent": {
                        "OutputFormat": "Text",
                        "OutputText": [
                            {
                                "EndOfLineFlag": true,
                                "Text": "APOL MERCURE VALENCIENNES CENTRE"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "         Musterstr. 01          "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "       Musterstadt 90111        "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "            GERMANY             "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "--------------------------------"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": ""
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "19.10.20                   15:05"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "          HÄNDLERBELEG          "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "--------------------------------"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "TERMINAL: 54094619              "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "HÄNDLER: 147777778              "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "PAN: XXXXXXXXXXXX0043           "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "KARTENTYP: Visa                 "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "BUCHUNG                         "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "MANUELLER EINTRAG               "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "ENDGÜLTIGER BETRAG:    20,00 EUR"
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "REFERENZ: 770234303596          "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "GENEHMIGUNGS-NR.: 042712        "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "              (00)              "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "     AUTORISIERUNG ERFOLGT      "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": " KEINE KARTENINH. VERIFIZIERUNG "
                            },
                            {
                                "EndOfLineFlag": true,
                                "Text": "BITTE FÜR IHRE UNTERLAG. AUFBEW."
                            }
                        ]
                    },
                    "RequiredSignatureFlag": ""
                }
            ],
            "PaymentResult": {
                "AmountsResp": {
                    "AuthorizedAmount": "20.00",
                    "Currency": "EUR"
                },
                "PaymentAcquirerData": {
                    "AcquirerPOIID": "54094619",
                    "ApprovalCode": "042712",
                    "MerchantID": "147777778"
                },
                "PaymentInstrumentData": {
                    "CardData": {
                        "EntryMode": "File",
                        "MaskedPAN": "XXXXXXXXXXXX0043",
                        "PaymentBrand": "V"
                    },
                    "PaymentInstrumentType": "Token"
                },
                "PaymentType": "Completion"
            },
            "Response": {
                "Result": "Success"
            },
            "SaleData": {
                "SaleReferenceID": "770234303596",
                "SaleTransactionID": {
                    "TimeStamp": "2020-10-19T15:05:38+02:00",
                    "TransactionID": "770234303596"
                }
            }
        }
    }
}