menu
Return to solutions

What's on this page

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.

Welcome

Hi fellow code warrior, we hope you enjoy our local payment REST API and to keep evolving we want to collect as much feedback as possible.
So if you have any remarks/improvements please share it with us here.

How does the local REST API work?

  • It is an Android background-service which automatically starts-up/restarts
  • The api is reachable on the next endpoint: http://127.0.0.1:8080
  • The api-reference can be found here

Before starting the integration you should know about next points concerning the API:

  • As we await all terminal communication in the service we use extended timeout requests. It is important that you add an read-timeout of at least 7 minutes in your http-client (For okhttp this can be done using this feature), this timeout of 7 minutes is essential for the correct functioning of the terminal.

The following steps will guide you through your journey as a ccv integrator:

  1. Start the terminal and connect it to the internet
  2. Verify if the CCV PayProxy is installed
  3. Follow the flow steps described above and start your integration journey

The demo-project contains all possible methods and can be found here

To configure the demo app to use the REST api, follow the next actions:

  1. Open the ‘mAPI Demo’ app
  2. Go to ‘UNATTENDED TERMINAL’
  3. Go to the settings (option menu top right)
  4. Enable the ‘REST API’ switch
  5. Save

Now the mAPI demo application is configured to use the REST API to communicate with the payment application.