This service can be used by the Payment Connector to cancel a pre-authorization to the Payment Terminals Provider only via online channel.
COMPATIBILITY
| Type | Compatibility |
|---|---|
| Card present (CP) | No |
| Card not present (CNP) | Yes |
REQUEST
| Type | Endpoint |
|---|---|
| POST | /payment/v1/interface/terminalprovider/cancel |
PARAMETERS
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
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 |
Reversal |
|
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 |
H9732FO20100894862PAR |
|
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 |
|
ReversalRequest |
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 |
|
SaleReferenceID |
TextString |
ID provided in the field SaleReferenceID in the Preauthorisation 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 |
|
ReversalReason |
Enum |
Reason of the payment reversal
|
|
Y |
CustCancel
|
|
CustomerOrder |
defined data structure |
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 |
|
Y |
|
|
CustomerOrderID |
TextString |
Additional and optional identification of a customer order |
|
Y |
|
|
StartDate |
ISODateTime
|
Beginning Date time of an operation |
|
Y |
2020-07-09T09:18:00-05:00 |
|
ForecastedAmount |
SimpleAmountType
|
Amount of a transaction
|
|
Y |
10.00 |
|
OpenOrderState |
|
True by default |
|
Y |
true |
|
Currency |
ISOCurrency3A
|
Currency of a monetary amount |
|
Y |
EUR |
|
AdditionalInformation |
TextString |
Unqualified information |
|
Y |
|
RESPONSE
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
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: Reversal
Category of message. |
|
Y |
Reversal |
|
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 |
H9732FO20100894862PAR |
|
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 |
|
ReversalResponse |
defined data structure |
Content of the Reversal Response message |
|
Y |
|
|
Response |
defined data structure |
Result of a message request processing.
|
|
Y |
|
|
Result |
Enum |
Transaction Result
|
Y |
Success
|
|
|
ErrorCondition |
Enum |
If the result is set to Failure then the condition should be part of the message. Condition that has produced an error on the processing of a message request |
|
Y |
DeviceOut |
|
AdditionnalResponse |
TextString |
Processing Status, Nok Reason, Terminal Verification Results (TVR) and Transaction Status Information (TSI).
Set as TLV structure |
|
N |
|
|
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
|
|
Y |
84547982062 |
|
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 |
|
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 |
EXAMPLE 1
This example show request/response for a card not present transaction.
Example of request :
|
{ "SaleToPOIRequest": { "MessageHeader": { "MessageCategory": "Reversal", "MessageClass": "Service", "MessageType": "Request", "POIID": "CAP", "SaleID": "L-457JU", "ServiceID": "H9732FO20100894862PAR" }, "ReversalRequest": { "SaleData": { "OperatorID": "FOLS", "SaleReferenceID": "770233356426" }, "ReversalReason": "CustCancel", "CustomerOrder": { "CustomerOrderID": "", "StartDate": "2020-10-08T15:10:28+02:00", "ForecastedAmount": "60.00", "OpenOrderState": "True", "Currency": "EUR", "AdditionalInformation": "" } } } } |
Example of response OK:
|
"SaleToPOIResponse": { "MessageHeader": { "MessageCategory": "Reversal", "MessageClass": "Service", "MessageType": "Response", "POIID": "CAP", "SaleID": "L-457JU ", "ServiceID": "H9732FO20100894862PAR" }, "ReversalResponse": { "CustomerOrder": { "SaleReferenceID": "770233356426" }, "POIData": { "POITransactionID": { "TimeStamp": "2020-10-08T13:10:28", "TransactionID": "84547982062" } }, "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": "08.10.20 15:10" }, { "EndOfLineFlag": true, "Text": " KUNDENBELEG " }, { "EndOfLineFlag": true, "Text": "--------------------------------" }, { "EndOfLineFlag": true, "Text": "TERMINAL: 54040554 " }, { "EndOfLineFlag": true, "Text": "HANDLER: 147777778 " }, { "EndOfLineFlag": true, "Text": "PAN: XXXXXXXXXXXX0043 " }, { "EndOfLineFlag": true, "Text": "KARTENTYP: Visa " }, { "EndOfLineFlag": true, "Text": "MANUELLES STORNO " }, { "EndOfLineFlag": true, "Text": "MANUELLER EINTRAG " }, { "EndOfLineFlag": true, "Text": "BETRAG: 60,00 EUR" }, { "EndOfLineFlag": true, "Text": "REFERENZ: 770233356426 " }, { "EndOfLineFlag": true, "Text": "GENEHMIGUNGS-NR.: 216443 " }, { "EndOfLineFlag": true, "Text": " (00) " }, { "EndOfLineFlag": true, "Text": " AUTORISIERUNG ERFOLGT " }, { "EndOfLineFlag": true, "Text": " KEINE KARTENINH. VERIFIZIERUNG " }, { "EndOfLineFlag": true, "Text": "BITTE FUR 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": "08.10.20 15:10" }, { "EndOfLineFlag": true, "Text": " HANDLERBELEG " }, { "EndOfLineFlag": true, "Text": "--------------------------------" }, { "EndOfLineFlag": true, "Text": "TERMINAL: 54040554 " }, { "EndOfLineFlag": true, "Text": "HANDLER: 147777778 " }, { "EndOfLineFlag": true, "Text": "PAN: XXXXXXXXXXXX0043 " }, { "EndOfLineFlag": true, "Text": "KARTENTYP: Visa " }, { "EndOfLineFlag": true, "Text": "MANUELLES STORNO " }, { "EndOfLineFlag": true, "Text": "MANUELLER EINTRAG " }, { "EndOfLineFlag": true, "Text": "BETRAG: 60,00 EUR" }, { "EndOfLineFlag": true, "Text": "REFERENZ: 770233356426 " }, { "EndOfLineFlag": true, "Text": "GENEHMIGUNGS-NR.: 216443 " }, { "EndOfLineFlag": true, "Text": " (00) " }, { "EndOfLineFlag": true, "Text": " AUTORISIERUNG ERFOLGT " }, { "EndOfLineFlag": true, "Text": " KEINE KARTENINH. VERIFIZIERUNG " }, { "EndOfLineFlag": true, "Text": "BITTE FUR IHRE UNTERLAG. AUFBEW." } ] }, "RequiredSignatureFlag": "" } ], "Response": { "Result": "Success" } } } } |