menu
Return to solutions

What's on this page

Terminal Features / Terminal - Status

Warning

The Android REST API (CCV PayProxy application) is now in maintenance mode. This means that new integrations with the REST API are no longer possible. Existing users can continue using the API as usual. For any questions or issues regarding the REST API, please contact pi-support@ccvlab.eu.

Terminal status

Get the status of your terminal

The api-method to achieve this is the HTTP.POST with url /terminal/status

Request

Parameter Description
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 

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

Response

Parameter Description
status the status of your request
terminalAction  the ongoing action of the terminal. If this value is ‘OK’, your terminal is ready to use.
terminalId the identifier of the terminal
terminalState the state of the terminal. Possible values: IDLE, REPRINT_TICKET, LOGGED_OUT, BUSY, INOPERABLE, READY, LOCKED, UNKNOWN
journalReceipt  a receipt with textlines for the merchant

Example request 

{
    "status": "SUCCESS",
    "terminalAction": "OK",
    "terminalId": "11140023",
    "terminalState": "IDLE",
    "journalReceipt": "[ \"Kopie Merchant\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]"
}