Perform SaleToPOIRequest
Below you will find a description of the SaleToPOIRequest message, which is used to initiate a payment transaction from an Electronic Cash Register system.
Request MessageHeader
Elements | Required | Description |
---|---|---|
ProtocolVersion | 3.1 | |
MessageClass | Service | |
MessageCategory | Payment | |
MessageType | Request | |
ServiceID | Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used. | |
SaleID | identifier of the ECR initiating the request (e.g., ECR001") | |
POIID | identifier of the Terminal receiving the request (e.g., 456) |
Request body
Elements | Attributes | Required | Description |
---|---|---|---|
PaymentRequest | |||
SaleData | |||
OperatorID | identifier for the operator performing the transaction for the ECR | ||
SaleTransactionID | |||
TransactionID | unique reference to identify a payment. In the Hub, this will show as “Store transaction ID” in transaction details | ||
TimeStamp | date and time of the request in UTC ISO format, e.g., 2025-03-03T10:39:59Z | ||
PaymentTransaction | |||
AmountsReq | |||
Currency | transaction currency code based on ISO-4217 (ie.g., EUR for Euros) | ||
RequestedAmount | transaction amount, e.g., 12.34 | ||
PaymentData | |||
PaymentType | fixed value “Refund” | ||
MarketpayPaymentExtensions |
Example of SaleToPOIRequest
<?xml version="3.1" encoding="UTF-8"?>
<SaleToPOIRequest xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MessageHeader MessageClass="Service" MessageCategory="Payment" MessageType="Request" ServiceID="3930" SaleID="ECR001" POIID="456"></MessageHeader>
<PaymentRequest>
<SaleData OperatorID="666">
<SaleTransactionID TransactionID="123" TimeStamp="2025-03-29T13:00:47Z"></SaleTransactionID>
</SaleData>
<PaymentTransaction>
<AmountsReq Currency="EUR" RequestedAmount="10.00"></AmountsReq>
</PaymentTransaction>
<PaymentData PaymentType="Refund"></PaymentData>
<MarketpayPaymentExtensions></MarketpayPaymentExtensions>
</PaymentRequest>
</SaleToPOIRequest>
Receive SaleToPOIResponse
Example of SaleToPOIResponse for a successful transaction
<SaleToPOIResponse>
<MessageHeader MessageCategory="Payment" MessageClass="Service" MessageType="Response" POIID="456" ProtocolVersion="3.1" SaleID="ECR001" ServiceID="3930"/>
<PaymentResponse>
<MarketpayPaymentExtensions ApplicationID="A0000000041010" BankID="513640" PANSequenceNumber="01"/>
<PaymentReceipt DocumentQualifier="CashierReceipt" RequiredSignatureFlag="false">
<OutputContent OutputFormat="Text">
<OutputText EndOfLineFlag="true">MERCHANT RECEIPT</OutputText>
<OutputText EndOfLineFlag="true">--------------------------------</OutputText>
<OutputText EndOfLineFlag="true">MARKET PAY PRECERT</OutputText>
<OutputText EndOfLineFlag="true">9 RUE DU 4 SEPTEMBRE</OutputText>
<OutputText EndOfLineFlag="true">75002 PARIS</OutputText>
<OutputText EndOfLineFlag="true">REFERENCE: 19</OutputText>
<OutputText EndOfLineFlag="true">TID: 00022302</OutputText>
<OutputText EndOfLineFlag="true">DEVICE NAME: 1760317010</OutputText>
<OutputText EndOfLineFlag="true">MERCHANT: 000000001999065</OutputText>
<OutputText EndOfLineFlag="true">PAN: XXXXXXXXXXXX7462 01</OutputText>
<OutputText EndOfLineFlag="true">CARD TYPE: MASTERCARD</OutputText>
<OutputText EndOfLineFlag="true">REFUND</OutputText>
<OutputText EndOfLineFlag="true">CONTACTLESS</OutputText>
<OutputText EndOfLineFlag="true">AMOUNT:€ 10,00</OutputText>
<OutputText EndOfLineFlag="true">Approved</OutputText>
<OutputText EndOfLineFlag="true">213462</OutputText>
<OutputText EndOfLineFlag="true">TIME: 29-03-2025 14:00</OutputText>
<OutputText EndOfLineFlag="true">PLEASE SIGN BELOW</OutputText>
<OutputText EndOfLineFlag="true"> </OutputText>
<OutputText EndOfLineFlag="true"> </OutputText>
<OutputText EndOfLineFlag="true"> </OutputText>
<OutputText EndOfLineFlag="true">--------------------------------</OutputText>
<OutputText EndOfLineFlag="true">SIGNATURE REQUIRED</OutputText>
<OutputText EndOfLineFlag="true">PLEASE RETAIN FOR YOUR RECORDS</OutputText>
</OutputContent>
</PaymentReceipt>
<PaymentReceipt DocumentQualifier="CustomerReceipt" RequiredSignatureFlag="false">
<OutputContent OutputFormat="Text">
<OutputText EndOfLineFlag="true">RECU PORTEUR</OutputText>
<OutputText EndOfLineFlag="true">--------------------------------</OutputText>
<OutputText EndOfLineFlag="true">MARKET PAY PRECERT</OutputText>
<OutputText EndOfLineFlag="true">9 RUE DU 4 SEPTEMBRE</OutputText>
<OutputText EndOfLineFlag="true">75002 PARIS</OutputText>
<OutputText EndOfLineFlag="true">RÉFÉRENCE: 19</OutputText>
<OutputText EndOfLineFlag="true">TID: 00022302</OutputText>
<OutputText EndOfLineFlag="true">NOM DE L'APPAREIL: 1760317010</OutputText>
<OutputText EndOfLineFlag="true">MARCHAND: 000000001999065</OutputText>
<OutputText EndOfLineFlag="true">PAN: XXXXXXXXXXXX7462 01</OutputText>
<OutputText EndOfLineFlag="true">TYPE DE CARTE: MASTERCARD</OutputText>
<OutputText EndOfLineFlag="true">REMBOURSEMENT</OutputText>
<OutputText EndOfLineFlag="true">SANS CONTACT</OutputText>
<OutputText EndOfLineFlag="true">MONTANT:€ 10,00</OutputText>
<OutputText EndOfLineFlag="true">Approuvé</OutputText>
<OutputText EndOfLineFlag="true">213462</OutputText>
<OutputText EndOfLineFlag="true">TIME: 29-03-2025 14:00</OutputText>
<OutputText EndOfLineFlag="true">VEUILLEZ CONSERVER POUR VOS</OutputText>
<OutputText EndOfLineFlag="true">DOSSIERS</OutputText>
</OutputContent>
</PaymentReceipt>
<PaymentResult MerchantOverrideFlag="false" OnlineFlag="true" PaymentType="Refund">
<AmountsResp AuthorizedAmount="10.00" Currency="EUR"/>
<PaymentAcquirerData AcquirerID="40105611508" AcquirerPOIID="00022302" MerchantID="000000001999065">
<ApprovalCode>213462</ApprovalCode>
</PaymentAcquirerData>
<PaymentInstrumentData PaymentInstrumentType="Card">
<CardData EntryMode="Contactless" MaskedPAN="XXXXXXXXXXXX7462" PaymentBrand="MASTERCARD"/>
</PaymentInstrumentData>
</PaymentResult>
<POIData>
<POITransactionID TimeStamp="2025-03-29T14:00:46.391" TransactionID="19"/>
</POIData>
<Response Result="Success">
<AdditionalResponse>000</AdditionalResponse>
</Response>
<SaleData OperatorID="666">
<SaleTransactionID TimeStamp="2025-03-29T13:00:47Z" TransactionID="123"/>
</SaleData>
</PaymentResponse>
</SaleToPOIResponse>