menu

Payment API

What's on this page

API Reference / SoftPOS

SoftPos terminal

Terminal object

Name Description
terminalId The terminal id as assigned by CCV
installationStatus The status of the installation. Possible values are: installed and not_installed
installationPayload Installation Payload to be used to complete a softpos terminal installation through the mobile application

Example

{
  "terminalId" : "SP001",
  "installationStatus": "installed",
  "installationPayload" : "IfhGLwDjRrr4mgeFOVr6tkA"
}

SoftPos terminal read request

Read the terminal information for a specific SoftPos terminal. An error response is returned when a call is performed towards this endpoint prior to the installation call.

  • Resource: /api/v1/softpos/terminal/{terminalId}
  • Method: GET
  • Authentication: basic auth
  • Parameters: PathParam terminalId for which to fetch the terminal information

Example

curl https://api.psp.ccv.eu/api/v1/softpos/terminal/123456 -u apikey:

SoftPos terminal read response

SoftPos terminal install request

Start the installation procedure for a specific SoftPos terminal.

  • Resource: /api/v1/softpos/terminal/{terminalId}/install
  • Method: POST
  • Authentication: basic auth
  • Parameters: PathParam terminalId for which to start the installation procedure
  • Body: Empty

Example

curl https://api.psp.ccv.eu/api/v1/softpos/terminal/123456/install -u apikey:

SoftPos terminal install response

SoftPos terminal install-completed request

Complete the installation procedure for a specific SoftPos terminal. An error response is returned when a call is performed towards this endpoint prior to the installation call.

  • Resource: /api/v1/softpos/terminal/{terminalId}/install-completed
  • Method: POST
  • Authentication: basic auth
  • Parameters: PathParam terminalId for which to complete the installation procedure
  • Body: Empty

Example

curl https://api.psp.ccv.eu/api/v1/softpos/terminal/123456/install-completed -u apikey:

SoftPos terminal install-completed response

SoftPos terminal uninstall request

Uninstall a specific SoftPos terminal. An error response is returned when a call is performed towards this endpoint prior to the installation completed call.

  • Resource: /api/v1/softpos/terminal/{terminalId}/uninstall
  • Method: POST
  • Authentication: basic auth
  • Parameters: PathParam terminalId for which to undo the installation procedure
  • Body: Empty

Example

curl https://api.psp.ccv.eu/api/v1/softpos/terminal/123456/uninstall -u apikey:

SoftPos terminal uninstall response