PayByLink

Pay By Link Integration Guide

Pay by Link is a product where merchants can generate a payment link for their customers to pay using the link. The payment link takes the shoppers to a secure hosted payment page where shoppers can pay with their preferred payment method. The page works across different devices and can be customized with brand name and logo.

How it works

There are just three simple steps required to integrate:

1

Generate the payment link

Send the request parameters server-to-server to generate the payment link.

2

Distribute the link to the customer

Send the link to the customer via different modes - SMS, QRCode etc.

3

Get the payment status

Find out if the payment was successful.

Optional integration steps

The status of the payment link session and the link distribution can be checked at any time:

4

Get the payment link status

Find out the status of the payment link.

5

Get the status of the SMS

Find out if the SMS distribution was successful.

6

Deactivate the payment link

Deactivate the created payment link.

Basic workflow

1. Prepare the checkout and generate the payment link

First, perform a server-to-server POST request to prepare the checkout with the required data, including the order type, amount and currency. Additionally you can send brand information and logo through the layout parameter to customize the payment page.
The response to a successful request is a JSON string with an link parameter, which needs to be sent to the shopper. Using this link, the shopper will be able to perform the payment.

Please note that for a HTTP POST request all the parameters are expected to go into the message body and not into the URL.
For a full list of parameters that can be sent in Step 1, please see the API Reference. Additional customization options can be enabled by using the Pay By Link API Reference.

2. Distribute the link to the customer

The payment link generated in Step 1 needs to be shared with the shopper. This can be done in different ways.

Direct via Email, Chat, etc.

The link url can always be collected from the response and sent to the shopper in your preffered way. For example, the url collected from the link paremeter can be included in an email or sent via chat directly.

QR code

If the createQRCode=true is sent in the request, the system will create a QR code and return it in the response in the qrCode field. For example This can be used instore, to show the QR Code directly to the shopper that can scan it with any device and complete the payment.

Send via SMS

The platform provides an API that can be used to send the link via SMS. This feature is optional.

Please note that the SMS distribution is an optional feature subject to additional costs. Additionally, the SMS distribution service does not provide a test environment. For this reason it is disabled by default in the sandbox. To know more and enable the SMS distribution service, reach out to your account manager.

To send the SMS where the payment link is included, send an API call following these instructions.

3. Get the payment status

Once the payment has been processed, the customer is redirected to your shopperResultUrl along with parameters id, the identifier of the payment page and chekoutId, the identifier of the checkout session being used.


Then, to get the status of the payment, you should make a GET request to the baseUrl + resourcePath, including your authentication parameters.

Example of a resourcePath:

resourcePath=paybylink/v1/{id}/checkouts/{checkoutId}/payment

Optional integration steps

4. Get the payment link status

To get the status of the payment link, you should make a GET request to the baseUrl + resourcePath, including the id of the payment link and your authentication parameters. The id of the payment link can be obtained from the response of the create checkout call done in Step 1.

Example of a resourcePath:

resourcePath=/paybylink/v1/{id}

5. Get the status of the SMS

To get the status of the SMS distribution, you should make a GET request to the baseUrl + resourcePath, including the id of the payment link and your authentication parameters. The id of the payment link can be obtained from the response of the create checkout call done in Step 1.

resourcePath=/paybylink/v1/{id}/sms/status
Example:

Once created, a payment link may be deleted using HTTP DELETE method using id of the payment link The id of the payment link can be obtained from the response of the create checkout call done in Step 1.

resourcePath=/paybylink/v1/{id}
Example: