Payment Links

How does the payment link work?

The payment link is a solution from the Payphone ecosystem that allows you to receive payments without the need for a website, just by sending a link to your customers. If you want to sell via Facebook, Instagram, WhatsApp or email, the payment link is your solution.

It is also ideal for email wallet collections and asynchronous payments. The payment link can be generated from your website. PayPhone Business or by doing a technological integration with our Api. Below we will show you how to generate a payment link from our Payphone Business page, and then with our Api if you need to integrate with your system.

Payment Link Flow

The payment link works as follows:

Generate payment link with a specific receivable value.
Send payment link to customer.
The customer makes the payment

Generate Payment Link from Payphone Business Portal

Log in to your portal PayPhone Business with your Ruc, email and password, and go to the section "Generate Payment Link".

Next enter the amount to be collected and press "Generate payment link".

It will automatically generate a link that you can share through your preferred media, and additionally you will have a QR code (the person who scans it will open the payment link).

When your customer opens the link they can pay using their credit or debit card, or use their Payphone app to pay with gift cards or Payphone balance. The link looks like this:

Generate payment links via Api

The integration with the Api allows a more direct control over the transactions giving the facility to set maximum dates of use or limit its consumption to a single time. With the use of the API you can generate personalised links, for example, a school can generate a link for each student and have direct control over the payment of tuition or pensions and better portfolio collection.

Follow the steps below to generate a link from our Api:

Business Requirements:

The establishment that is to receive the payments must be registered with Payphone Business. To start the registration you can do click here.
With the shop active and ready to transact, you must create a user of type "developer"which we will explain below.

Development Requirements:

You must configure on our developer website "Payphone Developer". your development environment where you can obtain all your authentication tokens with which you identify yourself to Payphone services.

Create developer user

Log in to your page Payphone Businessand log in with your ruc, email and password, (if you don't have access, the company administrator can log in and create your user) and go to the "Users". then select "Create User":

Enter all the developer's details in the form, don't forget that in the "Roles". you must enter "Developer". (The administrator must provide the e-mail address and password entered.)

With this process in place, the user developer can start the implementation.

Payphone Developer Page

Setting up the development environment allows you to have full control over the transactions made through Payphone. Please follow the steps below:

1. Log in as a developer

Log in to the page https://appdeveloper.payphonetodoesposible.com/ and log in with your developer user credentials (Ruc, email and password).

2. Create Payphone Application:

Payphone development applications allow you to configure your test environment, connection parameters or test users, and help you obtain your authentication credentials such as the token.

To create your application click on the "+"from the top:

A form will open where you have to enter the fields of your application the type of application must be API

Press Save

Get Authentication Token

With the application configured you must click on the top menu on the credentials tab, and you will have the button to copy your token...

Call for service

With the requirements ready, you must make a POST call indicating in the header your token of type "Authorization" with content "Bearer TUTOKEN". The call must be to the url: https://pay.payphonetodoesposible.com/api/Links with an object of type Json with the following parameters:

Name	Description	Data type	Optional
amount	Total value of the invoice to be collected, is the sum of amountWithTax, amountWithoutTax, Tax, service and tip.	Int
amountWithoutTax	Value not taxed.	Int	X - only in case VAT is charged, mandatory if no VAT is charged
amountWithTax	Taxable value, excluding tax.	Int	X - only in case values are charged without VAT, mandatory if values are charged with VAT.
tax	Value of the tax.	Int	X - only in case values are charged without VAT, mandatory if values are charged with VAT.
service	Value of the service.	Int	X
tip	Value of the tip.	Int	X
currency	Currency to be collected /e.g. USD	String	X
clientTransactionId	Transaction identifier, you must generate it, it is a unique identifier.	String
storeId	Identifier of the branch that performs the collection, this parameter can be obtained in the "Company request" section of the PayPhone Developer page, in the list button.	String	X
reference	Payment reference you can send.	String	X
oneTime	Field to control if the link works only once: True if the link is used only once, false if it is used several times.	Boolean	X
expireIn	Number of hours the payment link will be available.	Integer	X

Examples of Json method links:

Generate payment link of $1.12, where $1 dollar is the subtotal and $0.12 is the tax:

				
					{
"amount": 112,
"tax": 12,
"amountWithTax": 100,
"clientTransactionId": "idlink001",
"currency": "USD"
}

Generate $1 payment link without tax.

				
					{
"amount": 100,
"amountWithoutTax": 100,
"clientTransactionId": "idlink001",
"currency": "USD"
}

These are the base objects but we recommend that you send as much data as possible so that you have better control.

The response of the POST request of the LINKS method is the url containing the payment link.

That's it, those are all the steps to generate paid links. Remember that with the Api you can only consume up to 20 times per minute.

Did you know that...