Reversal Request

API Version

It conveys Information related to the reversal of a previous payment or a loyalty transaction. Content of the Reversal Request message.

Request Parameters

Required

Optional

Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.

Identification of the Cashier or Operator.

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

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

Identification of a transaction for the Sale System or the POI System.

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

Information related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.

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

Additional and optional identification of a customer order.

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.

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

Sale information intended for the Issuer. The POI System receives this information and sends it to the Acquirer for the Issuer without any change.

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

Maximum: 99999999.999999

Amount of the payment or loyalty to reverse. ReversedAmount is implicitly equal to the AuthorizedAmount if absent.

Reason of the payment or loyalty reversal. Possible values:

CustCancel
Malfunction
MerchantCancel
Unable2Compl

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200
It conveys Information related to the reversal processed by the POI System. Content of the Reversal Response message.
Responseobject
Result of a message request processing. If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements.
Resultstring
Result of the processing of the message. Possible values:

Failure

Partial

Success

ErrorConditionstring
Condition that has produced an error on the processing of a message request. Returned if Result is not Success. Possible values:

Aborted

Busy

Cancel

DeviceOut

InProgress

InsertedCard

InvalidCard

LoggedOut

MessageFormat

NotAllowed

NotFound

PaymentRestriction

Refusal

UnavailableDevice

UnavailableService

UnreachableHost

WrongPIN

AdditionalResponsestring
Additional information related to processing status of a message request. If present, the POI logs it for further examination.
POIDataobject
Data related to the POI System. In the Message Response, identification of the POI transaction.
POITransactionIDobject
Identification of a transaction for the Sale System or the POI System.
TransactionIDstring
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstring
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.
POIReconciliationIDinteger
Identification of the reconciliation period between Sale and POI. If Result is Success.
OriginalPOITransactionobject
Identification of a previous POI transaction. In the Payment Request message, it allows using the card of a previous CardAcquisition or Payment request.
SaleIDstring
Identification of a Sale System for the NEXO SaletoPOI protocol.
POIIDstring
Identification of a payment terminal for the NEXO SaletoPOI protocol. If original transaction is coming from another POI.
POITransactionIDobject
Identification of a transaction for the Sale System or the POI System.
TransactionIDstring
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstring
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.
ReuseCardDataFlagboolean
Indicates if the card data has to be retrieved from a previous transaction.
ApprovalCodestring
Code assigned to a transaction approval by the Acquirer. If referral.
AcquirerIDinteger
Identification of the Acquirer. Restrict to the Acquirer if present.
AmountValuenumber
Maximum: 99999999.999999
Value of an amount.
HostTransactionIDobject
Identification of a transaction for the Sale System or the POI System.
TransactionIDstring
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstring
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.
ReversedAmountnumber
Maximum: 99999999.999999
Amount of the payment or loyalty to reverse. Copy.
PaymentReceiptarray[object]
DocumentQualifierstring
Qualification of the document to print to the Cashier or the Customer. SaleReceipt or CashierReceipt. Possible values:

CashierReceipt

CustomerReceipt

Document

Journal

SaleReceipt

Voucher

IntegratedPrintFlagboolean
Type of the print integrated to other prints.
RequiredSignatureFlagboolean
Indicate that the cardholder payment receipt requires a physical signature by the Customer.
OutputContentobject
Content to display or print. This is a sequence of elements if they have different formats.
OutputFormatstring
Format of the content to display or print. Display or print device function. Possible values:

BarCode

MessageRef

Text

XHTML

PredefinedContentobject
Reference of a predefined message to display or print. It conveys information related to the predefined message.
ReferenceIDstring
Identification of a predefined message to display or print.
Languagestring
Identification of a language.
OutputTextarray[object]
Content of text message to display or print. Mandatory, if OutputFormat is Text, not allowed otherwise. One instance of OutputText per shared format.
Textstring
Content of text message to display, print or play.
CharacterSetinteger
Character height of the text string to display or print. Absence of this data element means the characters have normal height.
StartRowinteger
Minimum: 1Maximum: 500
Row where the text string has to be displayed or printed.
StartColumninteger
Minimum: 1Maximum: 500
Column where the text string has to be displayed or printed.
CharacterWidthstring
Character width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:

DoubleWidth

SingleWidth

CharacterHeightstring
Character height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:

DoubleHeight

HalfHeight

SingleHeight

CharacterStylestring
Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:

Bold

Italic

Normal

Underline

Alignmentstring
Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:

Centred

Justified

Left

Right

EndOfLineFlagboolean
Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
OutputXHTMLstring
XHTML document body containing the message to display or print. Mandatory if OutputFormat is XHTML, not allowed otherwise.
OutputBarcodeobject
Barcode content to display or print. Mandatory if OutputFormat is Barcode, not allowed otherwise.
BarcodeValuestring
Value with a Barcode coding. The barcode value to display or print.

Reversal Request

HTTP Responses

200