REST API for Oracle Retail EFTLink

Payment by credit, debit or other EFT card.

post

/payment

Issues an authorization or capture against a credit or debit card. If the card is authorized then it can be voided. If the card is captured then it can only be refunded. It depends on the payment provider on what follow on actions are permitted.

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}/payment",
                 "method": "post",
                 "rel": "self"
          }], 
                   "POSdata":
                   {
                           "TransactionNumber":"217",
                           "StoreID":"731",
                           "LanguageCode":"eng"
                   },
                   "TotalAmount":
                   {
                          "Currency":"GBP",
                          "text":"5.00"
                   },
                   "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": 12345678,
    "MarchantID": "Simulator12345678",
    "STAN": 595504
  },
  "Tender": {
    "TotalAmount": {
      "Currency": "GBP",
      "text": "5.00"
    },
    "Authorization": {
      "AcquirerID": "UNKNOWN",
      "AcquirerTransactionReference": "595504",
      "TimeStamp":"Fri Jun 26 15:37:12 BST 2020",4
      "ApprovalCode":"830842",
      "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",
   },
   "PaymentProviderName":"oracle.eftlink.opiretail.OPIRetailCore",
   "RequestType":"1",
   "ApplicationSender":"XSTORE",
   "WorkstationID":"1",
   "RequestID":"2",
   "OverallResult": "success"
}