Basic Operations / Recover A Payment

Recover a payment

Having a stable connection with the terminal is important. A terminal can go into a state where the transaction isn’t completed when something goes wrong during a payment flow.

You have to perform a payment recovery if you receive an error response with one of the following error types:

• TERMINAL_CONNECTION_LOST
• RESPONSE_TIMEOUT

Example error response

{
  "type": "TERMINAL_CONNECTION_LOST"
}

You start a payment recovery by sending a POST request to /terminal/recoverPayment

Request parameters

Parameter	Description
paymentRequestId	a payemntRequestId is a unique Id that is generated by the POS and passed through to the terminal when a payment is initiated.
terminalOperatingEnvironment	the configuration of the terminal that you would like to use for this transaction
terminalAccessProtocol	the protocol to communicate with the terminal

Example request

{
  "paymentRequestId": "123456789"
  "terminalOperatingEnvironment": "UNATTENDED",
  "terminalAccessProtocol": "OPI_NL"
}

The response that you will receive is the same like the payment response. The most important parameter to check is the status. If the payment is processed successfully, this value will be set to SUCCESS. If the status is FAILED, the last transaction that was initiated on the terminal is stopped to soon

Parameter	Description
status	the status of your request
customerReceipt	a receipt with textlines for the customer
merchantReceipt	a receipt with textlines for the merchant
journalReceipt	a receipt with textlines for the merchant
eJournal	a object containing all the information of a terminal transaction

Example authorisation response

{
  "status": "SUCCESS",
  "amount": "50.00",
  "currency": "EUR",
  "card": "ECMC",
  "requestId": "1601951231",
  "stan": "00000593",
  "status": "SUCCESS",
  "timestamp": "2021-11-22T13:49:32.000+01:00",
  "customerReceipt": "[ \"Kopie Customer\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
  "merchantReceipt": "[ \"Kopie Merchant\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
  "journalReceipt": "[ \"Kopie Merchant\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
  "eJournal": "<?xml version=\"1.0\"?>\n<E-Journal>\n...</E-Journal>"
}