POST /reversal

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

Servers

https://device-api-test.adyen.com/v1/merchants/{merchantAccount}/devices/{deviceId}/sync
https://device-api-test.adyen.com/v1/merchants/{merchantAccount}/devices/{deviceId}/async
<local-terminal-IP-address>

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`OriginalPOITransaction`	Object	Yes	Identification of a previous POI transaction.
`OriginalPOITransaction.AcquirerID`	Integer	No	Identification of the Acquirer. Restrict to the Acquirer if present.
`OriginalPOITransaction.ReuseCardDataFlag`	Boolean	No	Indicates if the card data has to be retrieved from a previous transaction. Default value: true
`OriginalPOITransaction.POITransactionID`	Object	No	Unique identification of a POI transaction for a POI. Absent if SaleReferenceID is sufficient to identify the transaction.
`OriginalPOITransaction.POITransactionID.TimeStamp`	String	Yes	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.
`OriginalPOITransaction.POITransactionID.TransactionID`	String	Yes	Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
`OriginalPOITransaction.POIID`	String	No	Identification of a payment terminal for the NEXO SaletoPOI protocol. If original transaction is coming from another POI.
`OriginalPOITransaction.HostTransactionID`	Object	No	Identification of the transaction by the host in charge of the stored value transaction. If POITransactionID not present.
`OriginalPOITransaction.HostTransactionID.TimeStamp`	String	Yes	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.
`OriginalPOITransaction.HostTransactionID.TransactionID`	String	Yes	Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
`OriginalPOITransaction.ApprovalCode`	String	No	Code assigned to a transaction approval by the Acquirer. If referral.
`OriginalPOITransaction.AmountValue`	Number	No	Value of an amount.
`OriginalPOITransaction.SaleID`	String	No	Identification of a Sale System for the NEXO SaletoPOI protocol.
`SaleData`	Object	No	Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.
`SaleData.OperatorID`	String	No	Identification of the Cashier or Operator.
`SaleData.SaleToAcquirerData`	String	No	Sale information intended for the Acquirer. Send to the Acquirer if present.
`SaleData.ShiftNumber`	String	No	Shift number. If different from the Login, see Login SaleData.
`SaleData.SaleTransactionID`	Object	Yes	Identification of a Sale transaction.
`SaleData.SaleTransactionID.TimeStamp`	String	Yes	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.
`SaleData.SaleTransactionID.TransactionID`	String	Yes	Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
`SaleData.SaleReferenceID`	String	No	Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
`SaleData.CustomerOrderReq[]`	Array	No	List of customer order open, closed or both to be sent in the response messages. Possible values: Both Closed Open
`SaleData.SaleToPOIData`	String	No	Sale information intended for the POI. Stored with the transaction.
`SaleData.OperatorLanguage`	String	No	Language of the Cashier or Operator. If different from the Login.
`SaleData.SaleTerminalData`	Object	No	Information related to the software and hardware features of the Sale Terminal. If content is not empty.
`SaleData.SaleTerminalData.TotalsGroupID`	String	No	Identification of a group of transactions on a POI Terminal, having the same Sale features. Could be used to group POI for reconciliation or other purpose defined by the Sale System. The default value is assigned by the Login Request.
`SaleData.TokenRequestedType`	String	No	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 Valid values: `"Customer"` `"Transaction"`
`SaleData.CustomerOrderID`	String	No	Additional and optional identification of a customer order.
`SaleData.SaleToIssuerData`	Object	No	Sale information intended for the Issuer. Send to the Acquirer if present.
`SaleData.SaleToIssuerData.StatementReference`	String	No	Label to print on the bank statement.
`ReversedAmount`	Number	No	Amount of the payment or loyalty to reverse. ReversedAmount is implicitly equal to the AuthorizedAmount if absent.
`ReversalReason`	String	Yes	Reason of the payment or loyalty reversal. Possible values: CustCancel Malfunction MerchantCancel Unable2Compl Valid values: `"Unable2Compl"` `"MerchantCancel"` `"Malfunction"` `"CustCancel"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.