REST API for Oracle Retail EFTLink

Refund a captured payment.

post

/refund

Issues a refund to a credit or debit card. A Refund is performed against a previously captured payment that has been settled with the acquiring bank. Different payment providers may support different types of refunds. There are two possible types of refund. - Verified refunds (refund against an original capture transaction). - Blind refunds (refund to a credit/debit card using either the card token, or newly captured card details from a secure form).

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}/refund",
            "method": "post",
            "rel": "self"
        }],
         {
         "POSdata": {
              "TransactionNumber": "217",
              "LanguageCode": "eng",
              "StoreID": "1012"
         },
         "TotalAmount": {
              "Currency": "GBP",
              "text": "10.00"
         },
         "PaymentProviderName": "",
         "ApplicationSender": "XSTORE",
         "WorkstationID": "1"
         }
}

Example of the Response Body

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

{
         "Terminal": {
             "TerminalID": "12345678",
             "MarchantID": "Simulator12345678"
         },
         "Tender": {
            "TotalAmount": {
            "Currency": "GBP",
            "text": "10.00"
         },
         "Authorization": {
         "AcquirerID": "UNKNOWN",
         "AcquirerTransactionReference": "595504",
         "ApprovalCode":"637671",
         "CardType":"80",
         "EntryMode":"3",
         "CardPAN":"XXXXXX******0002",
         "ExpiryDate":"1299"
         }
   },
   "CardValue": {
        "CardPAN":"XXXXXX******0002",
        "EndDate":"1299",
        "CardCircuit":"VISA", 
        "Category":"0", 
        "Token":"C411673288324019380",
        "TransactionReference":"1299",
        "CardType":"80",
        "EntryMode":"2"
  },
  "PaymentProviderName":"oracle.eftlink.opiretail.OPIRetailCore",
  "RequestType":"2",
  "ApplicationSender":"XSTORE",
  "WorkstationID":"1",
  "RequestID":"6",
  "OverallResult":"Success", 
  "Success":"true"

}