POST /payment

Default value: "application/json"

Data related to a Loyalty program or account. Loyalty cards used with the payment transaction and read by the Sale System.

Amount of a loyalty account. When the Sale System want to award the Loyalty account (not for BalanceInquiryRequest).

Currency of a monetary amount.

Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency. Possible values:

• Monetary
• Point

Possible values:

• "Point"
• "Monetary"

Value of an amount.

Reference to the last CardAcquisition, to use the same card. If the loyalty account ID comes from a previous CardAcquisition.

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

Identification of a Loyalty account. If loyalty identification of the loyalty account is realised by the Sale System.

Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification. Possible values:

• HybridCard
• LinkedCard
• LoyaltyCard
• NoCard

Possible values:

• "LoyaltyCard"
• "NoCard"
• "HybridCard"
• "LinkedCard"

Loyalty account identification conforming to the IdentificationType.

Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values:

• Contactless
• File
• ICC
• Keyed
• MagStripe
• Manual
• Mobile
• RFID
• Scanned
• SynchronousICC
• Tapped

Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

• AccountNumber
• BarCode
• ISOTrack2
• PAN
• PhoneNumber

Possible values:

• "PAN"
• "AccountNumber"
• "BarCode"
• "PhoneNumber"
• "ISOTrack2"

Data related to the payment transaction. If one data element is present.

Requested validity date for the reservation. Allows a specific period for the reservation according to the need of the Merchant for the first reservation and the reservation updates as well.

Customer order attached to a customer, recorded in the POI system. Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.

Currency of a monetary amount.

Date time of the beginning of an operation.

Identification of a Sale global transaction for a sequence of related POI transactions. Identification of a reservation transaction for the sequence of reservation and the completion.

Identification of an entity accessing data to perform an operation. Allow the synchronisation of customer order processing, when several parts of the Sale System access a customer order at the same time. The Sale entity active on the customer order is identified by this data.

Date time of the end of an operation.

Total amount of all completed transactions of a customer order.

Depending on the choice of the sale system it could equal the initial amount of the order or the global amount of the order. If ForecastedAmount equals the initial amount of the order it will allow the system to follow any additional payment. In case of equality with the global amount of the order, the system will then be able to follow remaining amounts.

Additional and optional identification of a customer order.

Specifies if a customer order is currently Open. An open customer order is an order waiting for further operations.

Default value: true

Unqualified information.

Reference to the last CardAcquisition, to use the same card. If the loyalty account ID comes from a previous CardAcquisition.

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

Indicates if the payment of the Sale transaction is split. Allows the POI to decline payment means that cannot accept split payment.

Default value: false

Data related to the instrument of payment for the transaction. Sent in the result of the payment transaction. For a card, it could also be sent in the CardAcquisition response, to be processed by the Sale System.

Type of payment instrument. Possible values:

• Card
• Cash
• Check
• Mobile
• StoredValue

Possible values:

• "Card"
• "StoredValue"
• "Mobile"
• "Check"
• "Cash"

Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.

Identification of the stored value account or the stored value card and the associated product sold by the Sale System for stored value requests.

Identification of the provider of the stored value account load/reload. When the ProductCode is not sufficient to identify the provider host which delivers the load or reload of the stored value account (for example if it contains the identification of the application.)

Date after which the card cannot be used. If EMV expiry date is present, it overrides Track2 information. Format is MMYY.

Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device). Possible values:

• Contactless
• File
• ICC
• Keyed
• MagStripe
• Manual
• Mobile
• RFID
• Scanned
• SynchronousICC
• Tapped

Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account. Possible values:

• GiftCard
• Other
• PhoneCard

Possible values:

• "PhoneCard"
• "GiftCard"
• "Other"

Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

• AccountNumber
• BarCode
• ISOTrack2
• PAN
• PhoneNumber

Possible values:

• "PAN"
• "AccountNumber"
• "BarCode"
• "PhoneNumber"
• "ISOTrack2"

Stored value account identification. The identification of the stored value account conforming to the IdentificationType.

Name of the owner of a stored value account.

Information related to the payment card used for the transaction. If PaymentInstrumentType is Card.

Product codes that are payable by the payment card. If not all the products are accepted for the payment card proposed by the Customer. In this case, Result is failure, ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success. Product codes that are payable by the payment card. If all the products are not accepted for the payment card proposed by the Customer. In this case, Result is failure and ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success.

Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.

Customer order attached to a customer, recorded in the POI system. Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.

Currency of a monetary amount.

Date time of the beginning of an operation.

Identification of a Sale global transaction for a sequence of related POI transactions. Identification of a reservation transaction for the sequence of reservation and the completion.

Identification of an entity accessing data to perform an operation. Allow the synchronisation of customer order processing, when several parts of the Sale System access a customer order at the same time. The Sale entity active on the customer order is identified by this data.

Date time of the end of an operation.

Total amount of all completed transactions of a customer order.

Depending on the choice of the sale system it could equal the initial amount of the order or the global amount of the order. If ForecastedAmount equals the initial amount of the order it will allow the system to follow any additional payment. In case of equality with the global amount of the order, the system will then be able to follow remaining amounts.

Additional and optional identification of a customer order.

Specifies if a customer order is currently Open. An open customer order is an order waiting for further operations.

Default value: true

Unqualified information.

Type of payment card. If card PAN is readable. Indicates the card used to pay in the PaymentResponse. Sent in the CardAcquisitionResponse, to leave the Cashier to choose between several applications in a smartcard, or several brand in a co-branded card. In this case, the CardAcquisitionRequest.ForceCustomerSelectionFlag must contain the value False. Brands are part of the POI and Sale Systems configurations.

Reference of the PAN, which identifies the PAN or the card uniquely, named also PAR (Payment Account Reference). This reference may be defined by the card issuer or by a token service provider under the control of the card issuer, and cannot be used for a payment transaction.

Sensitive information related to the payment card, entered or read by the Sale System. If structure non empty and unprotected.

Magnetic track or magnetic ink characters line. If EntryMode is MagStripe or RFID .

Card track number.

Default value: 2

Card track format. Possible values:

• AAMVA
• ISO

Possible values:

• "AAMVA"
• "ISO"

Card track content.

Primary Account Number.

Date after which the card cannot be used. If EntryMode is File.

Card Sequence Number. If EntryMode is File, Keyed, or Manual.

Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values:

• Contactless
• File
• ICC
• Keyed
• MagStripe
• Manual
• Mobile
• RFID
• Scanned
• SynchronousICC
• Tapped

Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer. Restriction of product payable by a card.

Expiry date and time. Limits the validity of a payment token.

Payment token replacing the PAN of the payment card to identify the payment mean of the customer.

Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

• Customer
• Transaction

Possible values:

• "Customer"
• "Transaction"

Country Code attached to the card (3 numerics). If available in the card.

Product that is payable by the payment card.

Standard product code of item purchased with the transaction.

Product name of an item purchased with the transaction.

Product code of item purchased with the transaction.

Additionl information related to the line item.

Masked Primary Account Number Part of the PAN is replaced by a string of * characters, to identify a customer account or relationship. Presence of this data element, which replace the PAN when SensitiveCardData is protected and replaced by ProtectedCardData. Alternatively the MaskedPAN can be used as a token to identify a customer.

Information related to the paper check used for the transaction. If PaymentInstrumentType is Check.

Magnetic track or magnetic ink characters line. Mandatory if CheckNumber absent.

Card track number.

Default value: 2

Card track format. Possible values:

• AAMVA
• ISO

Possible values:

• "AAMVA"
• "ISO"

Card track content.

Identification of the customer account. Mandatory if TrackData absent.

Country of the bank check. Absent if country of the Sale system.

Identification of the bank. Mandatory if TrackData absent.

Identification of the bank check. Mandatory if TrackData absent.

Check guarantee card number. If provided by the customer.

Type of bank check. Possible values:

• Company
• Personal

Possible values:

• "Company"
• "Personal"

Information related to the mobile for the payment transaction. If PaymentInstrumentType is Mobile.

Masked Mobile Subscriber Integrated Service Digital Network. If data available.

Geographic location specified by geographic or UTM coordinates. If data available.

Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.

Angular distance of a location on the earth south or north of the equator.

Y-coordinate of the Universal Transverse Mercator coordinate system.

X-coordinate of the Universal Transverse Mercator coordinate system.

UTM grid zone combination of the longitude zone (1 to 60) and the latitude band (C to X, excluding I and O).

Sensitive information related to the mobile phone, protected by CMS. SensitiveMobileData.

Identifies the mobile phone operator inside a country. If data available.

Identifies the country of a mobile phone operator. If data available.

Sensitive information related to the mobile phone. If unprotected mobile data.

Mobile Subscriber Integrated Service Digital Network (i.e. mobile phone number of the SIM card). Country, National Destination Code, and Subscriber Number.

International Mobile Subscriber Identity. Unique number associated with the mobile phone user, containing the Mobile Country Code (MCC), the Mobile Network Code (MNC), and the Mobile Identification Number (MSIN)

International Mobile Equipment Identity. Unique number associated with the mobile phone device.

Information related an instalment transaction. To request an instalment to the issuer, or to make individual instalments of a payment transaction.

Type of instalment transaction. Possible values:

• Annual
• Daily
• Monthly
• Weekly

Possible values:

• "Annual"
• "Monthly"
• "Daily"
• "Weekly"

Charges related to a transaction. Charge related to the payment instalments.

Total number of payments. For instalment, the number of payments, including the first one.

Sum of a collection of amounts. Total amount of the payment instalments.

First amount of the payment instalments.

First date of a payment. For instalment, the date of the first payments, if not immediate.

Identification of an instalment plan.

Sequence number of the instalment. For an instalment payment transaction, number of the payment, from 1 to TotalNbOfPayments.

Period of time with defined unit of time. A period between 2 payment instalments.

Type of instalment transaction. For requesting an instalment payment transaction. Possible values:

• DeferredInstalments
• EqualInstalments
• InequalInstalments

Possible values:

• "EqualInstalments"
• "DeferredInstalments"
• "InequalInstalments"

Type of payment transaction. Elements requested by the Sale System that are related to the payment only. Possible values:

• CashAdvance
• CashDeposit
• Completion
• FirstReservation
• Instalment
• IssuerInstalment
• Normal
• OneTimeReservation
• PaidOut
• Recurring
• Refund
• UpdateReservation

Possible values:

• "CashDeposit"
• "Completion"
• "Recurring"
• "PaidOut"
• "OneTimeReservation"
• "Normal"
• "Instalment"
• "CashAdvance"
• "Refund"
• "IssuerInstalment"
• "UpdateReservation"
• "FirstReservation"

Data related to the payment and loyalty transaction.

Identification of a previous POI transaction. In the Payment or the Loyalty Request message, it allows using the card of a previous CardAcquisition or Payment/Loyalty request.

Identification of the Acquirer. Restrict to the Acquirer if present.

Indicates if the card data has to be retrieved from a previous transaction.

Default value: true

Unique identification of a POI transaction for a POI. Absent if SaleReferenceID is sufficient to identify the transaction.

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

Identification of a payment terminal for the NEXO SaletoPOI protocol. If original transaction is coming from another POI.

Identification of the transaction by the host in charge of the stored value transaction. If POITransactionID not present.

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

Code assigned to a transaction approval by the Acquirer. If referral.

Value of an amount.

Identification of a Sale System for the NEXO SaletoPOI protocol.

Sale items of a transaction. In loyalty or value added payment card transaction, the items of the sale that are processed in the transaction.

Item identification inside a transaction (0 to n).

Total amount of the item line.

Type of taxes associated with the line item. If data is sent, POI has to store it and send it if the host protocol allows it.

Product quantity. If data is sent, POI has to store it and send it if the host protocol allows it.

Commercial or distribution channel associated with the line item. If data sent, POI has to store it and send it if the host protocol allows it.

Standard product code of item purchased with the transaction. If data sent, POI has to store it and send it if the host protocol allows it.

Product name of an item purchased with the transaction.

Product code of item purchased with the transaction.

Additional information related to the line item. If data sent, POI has to store it and send it if the host protocol allows it.

Price per unit of product. If Quantity is present.

Unit of measure of a quantity. If Quantity is present. Possible values:

• Case
• Centilitre
• Centimetre
• Foot
• Gram
• Inch
• Kilogram
• Kilometre
• Litre
• Meter
• Mile
• Other
• Ounce
• Pint
• Pound
• Quart
• UKGallon
• USGallon
• Yard

Possible values:

• "Foot"
• "Centimetre"
• "Other"
• "Centilitre"
• "Meter"
• "UKGallon"
• "USGallon"
• "Inch"
• "Gram"
• "Quart"
• "Case"
• "Pound"
• "Litre"
• "Mile"
• "Kilometre"
• "Kilogram"
• "Ounce"
• "Pint"
• "Yard"

Conditions on which the transaction must be processed.

Type of Loyalty processing requested by the Sale System. Possible values:

• Allowed
• Forbidden
• Processed
• Proposed
• Required

Possible values:

• "Proposed"
• "Required"
• "Forbidden"
• "Processed"
• "Allowed"

Identification of the Acquirer. Restrict to these Acquirer if present.

The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.

Payment instrument entry mode requested by the Sale System. Restrict entry mode if sent. Possible values:

• CheckReader
• Contactless
• File
• ICC
• Keyed
• MagStripe
• Manual
• RFID
• Scanned
• SynchronousICC
• Tapped

Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.

The preferred type of payment is a debit transaction rather than a credit transaction.

Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.

Default value: false

Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.

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

Currency of a monetary amount.

Amount paid for a tip. Allow the printing of the tip on the receipt, and to qualify the tip part of the amount.

Amount already paid in case of split payment. Depending on the context, a split payment is either a split amount, or a split basket (required by some payment means as fleet cards). The PaidAmount is present when the split payment is a split of the amount. Split of the basket involves two Sale Transactions, and does not have to be recognised by the POI.

Minimum amount the Sale System is allowed to deliver for this payment. For the OneTimeReservation, when the maximum amount is unknown, the Sale System indicates the minimum amount it allows.

Maximum amount which could be requested for cash-back to the Sale System. Allows the Cashier to limit the amount value of cash-back to deliver to the Customer.

Amount requested by the Sale for the payment.

The cash-back part of the amount requested by the Sale for the payment.

Minimum amount of a split, which could be requested by a Customer.Allows the Merchant to limit the number of split requested by the Customer.

Data related to the Sale System.

Identification of the Cashier or Operator.

Sale information intended for the Acquirer. Send to the Acquirer if present.

Shift number. If different from the Login, see Login SaleData.

Identification of a Sale transaction.

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.

List of customer order open, closed or both to be sent in the response messages. Possible values:

• Both
• Closed
• Open

Sale information intended for the POI. Stored with the transaction.

Language of the Cashier or Operator. If different from the Login.

Information related to the software and hardware features of the Sale Terminal. If content is not empty.

Identification of a group of transactions on a POI Terminal, having the same Sale features. Could be used to group POI for reconciliation or other purpose defined by the Sale System. The default value is assigned by the Login Request.

Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

• Customer
• Transaction

Possible values:

• "Customer"
• "Transaction"

Additional and optional identification of a customer order.

Sale information intended for the Issuer. Send to the Acquirer if present.

Label to print on the bank statement.