How to use the Rest PayPhone Api?

The PayPhone Rest API is the next level in the integration of our system with the different Web pages, apps and platforms, that need to make payments in a fast and secure way. In this article we will explore all the steps to make the API fully functional in your system.

We recommend that you first know the payment process with PayPhone. In this Article you can review how PayPhone works and that the payment flow be understood

To implement our API you must meet certain requirements that we divide into two categories: Commercial requirements And Development requirements.

Commercial Requirements:

  • The store that will receive the payments must be registered in PayPhone as an active store. To start the registration as a store you can do Click here.
  • With the store active and ready to be transactioned, you must create a user of type «Developer«. In this article we teach you how to create your user.

Development Requirements:

  • PayPhone gives you a whole development environment to implement the API and have control of all your configurations. Before you start you must prepare the platform for your application. Click here to know how to do the preparation.
  • Finally you have to obtain your authentication token, with which you will be able to identify yourself in our services and add the respective security to the process. In This article We teach you how to get the token.

(If you are a public company please contact to certify the process before going into production)

API implementation:

Perfect!, if you already understand how PayPhone works and you have all the requirements ready we can start the implementation. The PayPhone Rest Api consists of 6 methods that will allow you to complete the flow of a transaction. The platform where we have documented the API is called swagger, there are the models of request, response, data type and the option to do tests online from it. Here we teach you how to use it.

Here is the flow of consultation of the methods and their respective articles for you to review, remember that for any query you must provide your authentication token in the header of the call in a field of type "authorization" with Content «Bearer TUTOKEN»:

Regions Method: It allows to consult the countries where PayPhone is available. Read more

Users method: With this you verify if a user is already registered in PayPhone. Read more.

Sale Method: This is the most important, with this we send the payment request to the clients and consult the status of the transaction. Read more.

Cancel Method: With this cancels the request of the sale method. Read more

Anull Method: It is used in the event that customers want to reverse the transaction. Read more.

Reverse method: With this method you can automatically reverse transactions in case your platform does not confirm any value or that for security the payment needs to be reversed. Read more

You can check the API responses in our Catalogue of errors.



    1. PayPhone Editor

      Good morning Henry, it is necessary to verify if the user you are using (Ruc and mail) exists created in your PayPhone Business. You can validate directly with our support channel on our website: or on our facebook 🙂

Leave A Comment?