Amadis

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

In this section:

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 for an estimated amount of the purchase and a period of time to perform
    the purchase,

  • Optionally, one or several Update Reservation(s) when the condition of the reservation is changing,

  • And finally, a Completion after the consumption or delivery to complete the payment transaction with the actual amount.

Reference Documents

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).

Processing

Initial Reservation

General

The corresponding nexo-Fast service is a Pre-Authorisation ('04' PRE-AUTH).

The Acceptor shall initiate a Pre-Authorisation including:

  • SaleReferenceID, the sale identifier for the whole reservation transaction.


Sale to Acceptor

If the reservation originates from a Sale System, the Pre-Authorisation Service initiated by the Acceptor shall include:

  • SaleTransactionID, the unique identification of a Sale transaction.


Acceptor to Acquirer

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 to the reservation in the RecepientTransactionID field in the AcceptorAuthorisationResponse.

Initial Reservation with no amount entry

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.

Initial Reservation with an estimated amount

Update Reservation

The corresponding nexo-Fast service is “UPDATE PRE-AUTH”.

The Acceptor shall initiate an update reservation including:

  • SaleReferenceID, the sale identifier for the whole reservation transaction, used for the initial reservation,

  • 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

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 recherche

Completion

The corresponding nexo-Fast service is “PAYMENT COMPLETION”.

The Acceptor shall initiate an update reservation including:

  • SaleReferenceID, the sale identifier for the whole reservation transaction, used for the initial reservation,

  • RequestedAmount: the actual 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

Configuration

Enable Reservation Service

To enable the Reservation Service:

  1. Define the following services proprieties in the Service Settings Table (E4).

    1. '04' : PRE-AUTH

    2. '05' : UPDATE PRE-AUTH

    3. '06' : PAYMENT COMPLETION

  2. Add the Pre-Authorisation Service in the list of configured service in Terminal Data (E1) using:

    1. 'DF13' - Configured Services[1, 5] = 1b (Pre-Authorisation) or

    2. 'DF67' - Configured Services Extended[1, 5] = 1b (Pre-Authorisation)

  3. Add the Update Pre-Authorisation Service in the list of configured service in Terminal Data (E1) using:

    1. 'DF13' - Configured Services[1, 4] = 1b (Update Pre-Authorisation) or

    2. 'DF67' - Configured Services Extended[1, 4] = 1b (Update Pre-Authorisation)

  4. Add the Payment Completion Service in the list of configured service in Terminal Data (E1) using:

    1. 'DF13' - Configured Services[1, 3] = 1b (Payment Completion) or

    2. '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)

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.

Data Transmission

x

Sale to Acceptor

Acceptor To Acquirer

Notes

MessageHeader.SaleID

AccptrAuthstnReq.SaleCntxt.SaleID

PaymentRequest.SaleData.SaleTransactionID.TransactionID

AccptrAuthstnReq.SaleCntxt.SaleRefNb

PaymentRequest.SaleData.SaleTransactionID.SaleReferenceID

AccptrAuthstnReq.Tx.SaleRefId

x

Message Examples

Connected POI

<?xml version="1.0" encoding="UTF-8"?>
<SaleToPOIRequest>
<MessageHeader MessageClass="Service" MessageCategory="Payment"
MessageType="Request" ServiceID="642" SaleID="SaleTermA"
POIID="POITerm1"/>
<PaymentRequest>
 <SaleData>
  <SaleTransactionID TransactionID="78747579" 
  TimeStamp="2021-01-10T23:08:42.4+01:00"/>
  <SaleReferenceID>59786354</SaleReferenceID>
 </SaleData>
 <PaymentTransaction>
  <AmountsReq Currency="EUR" RequestedAmount="500.00"/>
</PaymentTransaction>
<PaymentData PaymentType="FirstReservation"/>
</PaymentRequest>
</SaleToPOIRequest>
<?xml version="1.0" encoding="UTF-8"?>
<Document>
  <AccptrAuthstnReq>
    ***********************************************
    *               Header Section                *
    ***********************************************
    <AuthstnReq>
    ***********************************************
    *               Environment Section           *
    ***********************************************
    <Cntxt>
        <PmtCntxt>
          *****************************************
          *        Payment Context                *
          *****************************************
        </PmtCntxt>
        <SaleCntxt>
           <SaleId>SaleTermA</SaleId>
           <SaleRefNb>78747579</SaleRefNb>
        </SaleCntxt>
      </Cntxt>
      <Tx>
        <TxCaptr>false</TxCaptr>
        <TxTp>RESA</TxTp>
        ...
        <SaleRefId>59786354</SaleRefId>
        <TxId>
          <TxDtTm>2021-01-10T23:08:42.000+02:00</TxDtTm>
          <TxRef>00000016</TxRef>
        </TxId>
       ...
        <TxDtls>
          <Ccy>EUR</Ccy>
          <TtlAmt>500.00</TtlAmt>
          <AmtQlfr>ESTM</AmtQlfr>
          ...
        </TxDtls>
      </Tx>
    </AuthstnReq>
  </AccptrAuthstnReq>
</Document>

nexo Retailers V3 Sale to POI messages

(PAS SUPPORTÉ) RequestedValidityDate: the estimated time period of the purchase to reserve,

 Initial Reservation (PaymentRequest)
<?xml version="1.0" encoding="UTF-8"?>
<SaleToPOIRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="EpasSaleToPOIMessages.xsd">
<MessageHeader MessageClass="Service" MessageCategory="Payment" MessageType="Request" ServiceID="642" SaleID="SaleTermA" POIID="POITerm1"/>
<PaymentRequest>
 <SaleData>
  <SaleTransactionID TransactionID="579" TimeStamp="2021-01-10T23:08:42.4+01:00"/>
  <SaleReferenceID>12345678</SaleReferenceID>
 </SaleData>
 <PaymentTransaction>
  <AmountsReq Currency="EUR" RequestedAmount="104.11"/>
</PaymentTransaction>
<PaymentData PaymentType="FirstReservation"/>
</PaymentRequest>
</SaleToPOIRequest>

MerchantApp Considerations


Messages Flow

  • No labels