Pay by link guide

When the customer receives the payment link and clicks on it, they are redirected to the payment gateway with all the payment solutions active for your merchant on Addon Payments. The customer can choose their preferred payment solution.

The links are valid as long as they have not been paid, cancelled or expired. The customer can use the link as many times as they want to attempt payment.

To use this operation, you have to have the necessary permissions with your Addon Payments BackOffice Portal user. If you don’t, you can request them from the Support team.

To log into the BackOffice Portal, follow the steps in the “Logging into the Addon Payments BackOffice” section of the Operations Search guide.

Set up notification URL

Addon Payments allows you to send a notification with the result of the payment link (authorized, declined) to the URL you have designated for this purpose. This function is optional and not necessary for proper use of the PBL function.

To set up a notification URL, you need:

• A URL on your ecommerce platform that is programmed to receive and handle notifications from Addon Payments.
  • Check the notification management guide for more information on Addon Payments notifications.
• Set up the URL on Addon Payments using the BackOffice Portal.

1. 1. Click on “Payment links” > “PBL/Invoice notification” on the left menu in the BackOffice Portal. Go to the form to set up the notification URL.
   2. Enter the URL on your ecommerce platform that will receive and process notifications. The format must be “https://mybusiness.com/urlNotifications”.

Addon Payments notification IPs

Visit the Managing Notifications guide learn more about notification IPs.

Managing PBL payment links

Creating, sending, changing and cancelling payment links can be done from “Payment links” > “List” > “Pay by Link” on the left menu in the BackOffice Portal.

Note: You will only see this section of the menu if you log in with a user that has the necessary permissions.

In the “Pay by Link” section, you’ll see the list of all the payment links created so far. The information is broken down in the following columns:

• Description: Description of the payment link entered when it was created.
• Code: ID for your merchant and ID you must enter for the transaction when it is created.
• Merchant transaction ID: ID you have to enter for the transaction when it is created.
• Expiry date: Date the link expires. The link will work up to and including the expiry date.
• Link: The payment link generated and button to copy it (icon of one sheet on top of another).
• Status: Shows the status of the payment link. Can be:
  • Paid: The customer has made payment using the link.
  • Cancelled: You have cancelled the payment link.
  • Expired: The payment link has expired before the customer used it.
  • Created: The payment links haven’t been paid, cancelled or expired.

Create a payment link

To create a payment link, follow these steps:

1. On the “Pay by Link” screen, click on “Create new Payment link”, at the bottom right.
2. You will see a form with the data needed to generate the payment link. Some fields are marked with an asterisk (*), which means they are required to generate the link.
3. These are the fields available:

• Payment details:

• • Merchant transaction ID (required): ID for the transaction on your ecommerce platform. It is necessary to differentiate and locate the transaction.
    • Alphanumeric. Maximum 45 characters.
    • Can’t have been used by the merchant previously.
    • Addon Payments will add your merchant ID at the beginning of the ID entered.
    • Example: The final ID for a payment link with ID “abcde” created by merchant 12345 will be: 12345-abcde.
  • Currency (required): Currency used for the transaction. This is a dropdown menu where you can choose a currency accepted by your merchant on Addon Payments.
  • Total (required): Total amount of the transaction.
    • Numerical with decimals. Format NN.nn
    • Decimals are optional.
    • Example: For a €10 transaction you can enter either “10.00” or just “10”.

• Customer details:

• • • Country (required): Dropdown menu to choose the customer’s country.
    • Language: Dropdown menu where you can choose the language for the customer’s payment gateway. If left blank, the default language is Spanish. The card form is in English.
    • Customer ID: ID for the customer on your ecommerce platform.
      • Alphanumeric. Between 2 and 50 characters.
      • Note: You can’t use the same ID for different customers because if a customer saves an account or card that would make it available to the rest of the customers with that ID. If you’re not sure, it is better not to enter anything in this field.

• Link details:

• • Product (required): Dropdown menu where you choose the product from your merchant to generate the payment link.
  • Expiry date: Expiry date for the link, after which the link will show as “expired” and can no longer be used. 
    • The link generated will work up to and including the expiry date. If left blank, the default period is one month.
  • Description: Description of the transaction. Useful for differentiating and locating transactions later.

4. After you fill in the required fields and any optional ones you want, click on “Save Payment Link” at the bottom right.
5. Then you’ll be taken back to the list of payment links generated, where you will see the new link.

Sending payment links to the customer

Follow these steps to send a payment link to a customer:

1. Go to the list of links created on the “Pay by Link” screen.
2. Find the payment link you want to send. You can use the column headings to filter or organize the list.
3. Click on copy (icon of one sheet on top of another).
4. Paste the payment link and send it to the customer however you want (SMS, email, WhatsApp, etc.).
5. When the customer receives the payment link and clicks on it, they are redirected to the payment gateway where they can choose the payment solution they want from those available your merchant.

Change or cancel a payment link

Payment links can’t currently be changed or cancelled.

1. Go to the list of links created on the “Pay by Link” screen.
2. Find the payment link you want to change. You can use the column headings to filter or organize the list.
3. Double click on the payment link you want to change.

• • If you want to change a parameter in the link:
    • Change the parameter you want to correct. The ID is the only parameter that can’t be changed after a link is created.
    • Click on the blue button “Save Payment link” at the bottom right of the form.
  • If you want to cancel the link:
    • Click on the red button “Cancel Payment link” at the bottom left of the form.
    • When they do, a confirmation alert will appear and you have to click “Yes”.