API & Integration

Integration Steps

Please follow these steps in order to successfully integrate Q-lipay into your service:

Get in contact with us to request your API integration package:

  • API documentations
  • API credentials
  • Access to our test environment.
  • Pre-built API clients for different platforms
  • Pre-certification test scenarios
  • You are set to go!

We have invested a lot of time to provide a thorough and easy to understand API documentation. Please read through it thoroughly in order to be able to handle the differences in the setup of each payable service and the different service types.

Try out our API by using one of our prebuild API clients for various platforms. Alternatively, you can send request via command line or tools like cURL and postman. Feel free to integrate our official clients into your solution.

In addition to our API documentation, we also provide the entire API in machine readable format. This should enable you to quickly build prototype and implement the API client.

Master data (merchants, services, products and top-ups) shall not be modified frequently. Therefore, we recommend you to store this data locally. A local cache will also allow you to apply local filters for services and products you want to support.

It is recommended that you update your cache once a day to ensure that you have access to all services.

Integrate Q-lipay into your application and service flows. In particular, note that the service specific requirements are handled appropriately. Q-lipay sends you the payment information in local currency as well as in the system currency of your account.

Our technical team shall immediately certify your integration for productive use once you inform us of the completion of the above steps. Simply contact us to setup a joint work session for your certification process.

Test scenarios provided as part of the API Integration package shall be used during certification.

We shall provide you with API keys for the production environment after successful completion of the certification process.

Planning for Reconciliation
Planning for Reconciliation

Planning for Reconciliation

Our API provides you access to a full list of your transactions performed. Please reconcile your internal transaction journal with the records from the Q-lipay transaction history.

We recommend that the reconciliation is done automatically on a daily basis. You are responsible to address any differences identified.

Certification Process

Please note that, as a Quality Gate before completing the integration phase, a joint working session is required to certify the implementation as ready for connection to the Q-lipay production system. This is important for us in order to adhere to our internal as well as external compliance guidelines.

Planning for Reconciliation

Process Overview

  • Verify that your integration is working, by running through the Pre-Certification Test scenarios
  • Certification shall be done during a joint working session using screen sharing applications with the Q-lipay Quality Assurance (QA) team and your technical team
  • The certification shall be run against the criteria communicated in the API documentation
  • If the certification is positive, you shall be transitioned to the production environment
  • Should there be any critical findings, the findings shall be discussed together and your team requested to resolve them. A new workshop shall be planned and the process repeated.

Technical pre-requisites

During the joint validation workshop, we shall perform the certification tests from the point of view of your customer using your system.

We shall require the following:

  • The availability to knowledgeable personnel to execute the tests in a shared screen environment like a customer in your system – for us to monitor the execution and also to answer any eventual questions
  • A way to be able to receive or view the customer notifications generated by your system as a result of the transactions.
  • A short review session after the completion of the tests. We shall together review the results and agree on the next steps.

If you have any questions or encounter any issues, please contact us and we shall assist you.