In this section:
Table of Contents | ||||
---|---|---|---|---|
|
Definition
A Reservation service is a transaction initiated by an Acceptor to make reservation of an estimated amount, for a certain time preceding the consumption of a service or delivery of goods and the actual payment. It consists in:
An initial reservation Initial Reservation for an estimated amount of the purchase and a period of time to perform
the purchase,Optionally, one or several update reservationsUpdate Reservation(s) when the condition of the reservation is changing,
A completion And finally, a Completion after the consumption or delivery to complete the payment transaction with the actual amount.
Reference Documents
nexo Card Payment Message Usage Guide
nexo-FAST Specifications
The complete catalog of official ISO 20022 CAPE messages, including the Message Definition Reports (MDR) and XML Schemas, is available on the ISO 20022 official Web site (http://www.iso20022.org) All other CAPE or nexo related information can be found by visiting the nexo Web site (http://www.nexo-standards.org).
AKHD-278
Processing
Initial Reservation | The corresponding nexo-Fast service is | “PRE-AUTH”.
Info |
---|
(PAS SUPPORTÉ) RequestedValidityDate: the estimated time period of the purchase to reserve, |
//
Connected POI
If the reservation originates from a Sale System, the Acceptor shall also include:
SaleTransactionIDa Pre-Authorisation ('04' PRE-AUTH
).
The Pre-Authorisation Service must be authorised online.
The Acceptor requests an authorization the Acquirer by sending an AcceptorAuthorisationRequest.
The Acquirer may indicate a specific reference associated to the reservation
using
RecepientTransactionID
in the authorization response.
The POI is not validating the value returned in RecepientTransactionID
.
Update Reservation
The corresponding nexo-Fast service is “UPDATE ('05' UPDATE PRE-
AUTH”AUTH
).
The Acceptor shall initiate an update reservation including:
SaleReferenceID, the sale identifier for the A unique Reference Data identifiying the whole reservation transaction, used for the initial reservation,
The RequestedAmount: the new estimated amount of the purchase,
The Acceptor may include (optionally):
RequestedValidityDate: the new estimated time period of the purchase,
Connected POI
If the reservation originates from a Sale System, the Acceptor shall also include:
SaleTransactionID.
Note |
---|
To extend the validity of the reservation, the Acceptor shall initiate an update reservation with RequestedAmount = 0. The host shall extend the length of the reservation and may return the value in the validitydate field in the response. If present, the validitydate shall be by Arkos to the merchantapp |
The Acceptor requests an authorization the Acquirer by sending an AcceptorAuthorisationRequest. The Acquirer may indicate a specific reference to the reservation in the RecepientTransactionID field (it should be same value used for the initial reservation).
Toujours online
Update Reservation avec rechercheNote |
---|
Completion
The corresponding nexo-Fast service is “PAYMENT COMPLETION”('06' PAYMENT COMPLETION
).
The Acceptor shall initiate an update a payment reservation including:
SaleReferenceID, the sale identifier for the A unique Reference Data identifiying the whole reservation transaction, used for the initial reservation,
The RequestedAmount: the actual new estimated amount of the purchase,
Connected POI
If the reservation originates from a Sale System, the Acceptor shall also include:
SaleTransactionID
The Acceptor may an authorization the Acquirer by sending an AcceptorAuthorisationRequest.
An CompletionAdvice is sent to the Acquirer to indicate the completion of the reservation.
Completion Reservation avec recherche.
Note |
---|
Cancellation of the Initial Reservation
This shall be done by a Completion with RequestedAmount = 0.
Cancellation of a Completion (or update reservation)
The corresponding nexo-Fast service is “CANCELLATION”.
See “Online Cancellation without searching from the log” Cancellation Service
The reference data is mandatory (same as the unique Reference Data identifiying the whole reservation transaction).
No Show
(Q3 2022)
Note |
---|
Not documented in Nexo. Search from log is mandatory. |
Additional Payment after Reservation
The corresponding nexo-Fast service is “PAYMENT COMPLETION”.
The Acceptor shall initiate a payment reservation including:
A unique Reference Data identifiying the whole reservation transaction,
The RequestedAmount: the new estimated amount of the purchase.
Note |
---|
The Acceptor makes no assumption on the validity date.
Configuration
Enable Reservation Service
To enable the Reservation Service:
Define the following services proprieties in the Service Settings Table (E4).
'04' : PRE-AUTH
'05' : UPDATE PRE-AUTH
'06' : PAYMENT COMPLETION
Add the Pre-Authorisation Service in the list of configured service in Terminal Data (E1) using:
'DF13' - Configured Services[1, 5] = 1b (Pre-Authorisation)
or'DF67' - Configured Services Extended[1, 5] = 1b (Pre-Authorisation)
Add the Update Pre-Authorisation Service in the list of configured service in Terminal Data (E1) using:
'DF13' - Configured Services[1, 4] = 1b (Update Pre-Authorisation)
or'DF67' - Configured Services Extended[1, 4] = 1b (Update Pre-Authorisation)
Add the Payment Completion Service in the list of configured service in Terminal Data (E1) using:
'DF13' - Configured Services[1, 3] = 1b (Payment Completion)
or'DF67' - Configured Services Extended[1, 3] = 1b (Payment Completion)
Enable Reservation Service Cancellation
Cancellation of Pre-Authorisation
To allow the Cancellation of Pre-Authorization, set 'DF28' - Application Profile Settings(APS) for Cancellation [1, 6] = 1b (Cancellation of Pre-Authorisation)
Cancellation of Payment Completion
To allow the Cancellation of Payment Completion, set 'DF28' - Application Profile Settings(APS) for Cancellation [1, 5] = 1b (Cancellation of Payment Completion)
Note |
---|
RECOMMENDATION:
|
Message Examples
nexo Retailers V3 Sale to POI messages
Expand | |||||
---|---|---|---|---|---|
| |||||
|
MerchantApp Considerations
Messages Flow
Reservation Amount
The estimated amount of the purchase to reserve will be retrieved by the Acceptor from the Application Profile after Application Selection:
If the
Pre-Authorisation Default Amount
is present in the configuration, then the Acceptor shall use the specified value as the estimated amount.Otherwise, the estimated amount shall be set to 0.
Reservation Validity Period Handling
For validity period handling, a configurable parameter Pre-Authorisation Validity Number of Days
is optionally stored in the Application Profile and, if present, indicates the maximum validity period for a Pre-Authorisation and an Update Pre-Authorisation according to scheme rules.
If the Pre-Authorisation Validity Number of Days
is not present, then a default value of '00 00' will be used, meaning that the Acceptor provides no estimated time period of the purchase to reserve.
Arkos API
See Amadis Developers' Guide page on Reservation Service for more information.
Sequence Diagrams
Standalone POI
First Reservation
Update Reservation
Note |
---|
Requested Amount is mandatory in the Update Reservation. |
Payment Completion
Note |
---|
Requested Amount is mandatory in the Payment Completion. |
Connected POI
First Reservation
Update Reservation
Note |
---|
Requested Amount is mandatory in the Update Reservation. |
Payment Completion
Note |
---|
Requested Amount is mandatory in the Payment Completion. |