REST API for Oracle Retail EFTLink

Void an authorized payment.

post

/reversal

Void an authorized payment that has not been settled with the acquiring bank. It is not possible to perform a void if the payment has been settled. The reason for decline should indicate that the payment has been settled so the consuming application should know then to request a refund instead.

Request

There are no request parameters for this operation.

Response

200 Response

Success

400 Response

Invalid parameters have been passed in

401 Response

Not authorized.

500 Response

Invalid request.

Examples

Example of the Request Body

The following example shows the contents of the Request Body in JSON format:

{
          "links": [{
              "href": "wss://localhost:{port}/reversal",
              "method": "post",
              "rel": "self"
          }], 
            "POSdata": {
                "TransactionNumber": "217",
                "LanguageCode": "eng", 
                "StoreID": "101"
          },
          "TotalAmount": {
                "Currency": "GBP",
                "text": "10.00"
          },
          "OriginalTransaction":
          {
          "TimeStamp":"2020-07-08 12:50:18",
          "STAN":"732164",
          "TerminalId":"1",
          "AcquirerTransactionReference":"732164",
          "ApprovalCode":"154310"
          },
          "PaymentProviderName":"", 
          "RequestType":"",
          "RequestSubType":"",
          "ApplicationSender":"XSTORE",
          "WorkstationID":"1"
          }
}

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
        "Terminal": {
            "TerminalID": "1235678",
				  "MarchantID": "Simulator12345678",
            "STAN": "595504"
         },
         "Tender": {
           "TotalAmount": {
           "Currency": "GBP",
           "text": "10.00"
         },
         "Authorization": {
         "AcquirerID":"UNKNOWN",
         "AcquirerTransactionReference":"732164",
         "TimeStamp":"Fri Jul 10 09:46:04 BST 2020",
         "CardType":"0",
         "EntryMode":"0"
        }
     },
     "CardValue": {
     "Category":"0", 
     "Token":"C342189118228895477",
     "CardType":"0",
     "EntryMode":"0"
     },
     "PaymentProviderName":"oracle.eftlink.opiretail.OPIRetailCore",
     "RequestType":"3",
     "ApplicationSender":"XSTORE",
     "WorkstationID":"1","RequestID":"3",
     "OverallResult":"Success",
     "Success":"true", 
}