Generate payment links with the PayPhone Api

The payment link is a very useful tool to increase the sales of your business and to encourage the customers to pay in a simple and fast way. The integration with the API take control over the transactions giving with maximum use dates or limiting at one time. With the use of the Api you can generate personalized link, for example, for a school can create a link for each student and keep a direct control on the payments.

Like our other technological solutions to implement the service 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 dp transactions, you must create a user of type "Developer". In this article we teach you how to create your user.

Development Requirements:

  • To create links with the API you have to set our platform so that your website is connected in a correct way to PayPhone. Before you start you must prepare the platform for your application. Get Click here To know how to do the preparation. (Remember that the application type is WEB).
  • 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 You find the way to get the token.

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

With the requirements ready, you must make a POST call indicating in the header your "authorization" type token with content "Bearer TUTOKEN". The call must be to the URL: Https://

In the body of the call you must send a Json object with the following parameters:

«Amount»: Integer,//Total amount receivable to Customer
"tax": integer, // Total taxes receivable, Only used when the type of billing is with Iva or Mixed.
"amountWithTax": integer, // Total amount that saves taxes, without taxes. Only used with 0% or Mixed rate
"amountWithoutTax": integer, // Total amount that does not record taxes, only used when the type of billing is with Iva or Mixed.
«Service»: Integer,//service amount
«Tip»: Integer,//Tip
«Currency»: «String»,//Currency type, example "USD"
«Reference»: «String»,//payment reference, maximum 10 characters
«clientTransactionId»: «String»,//identifier that you give to the transaction, maximum 16 characters
«storeId»: «String»,//Store identifier, delivered by PayPhone
«additionalData»: «String»,//Additional parameter for transaction control
«oneTime»: Boolean,//True If the link is used only once, false if it is used several times.
«expireIn»: Integer//number of hours for the link to expire

Enter the swagger And you can see their model of consultation and response. Note: Here you can see how to use the swagger.  

The amount, Amountwithouttax, amountwithtax, service, Tip and tax fields must be multiplied by 100, i.e. 1 dollar = 100.

Get Click here to see our catalogue of errors You can check the API responses.

Optional parameters that you do not use can be omitted. Remember that the Api can only be used up to 20 times per minute.

Leave A Comment?