Paylink API

Prev Next

Overview

Using the Blink API, you can now auto-generate and track Blink payment links from your own platform and services. Embed the paylinks into your checkout flows or attach them to your invoices.

Features

The Paylink API offers all the features available on making links in the portal, which include:

Tracking

This can be done via the portal on the request payments page  or via API requests.

Customisation

Change the background colour and add your own logo. This can only be done through the portal.

Payment Options

Payment options include card payments, open banking, and Direct Debit. The platform is fully integrated with Apple Pay and Google Pay, allowing customers to conveniently make payments using these methods.

Card Verification

Blink provides various card verifications for payments. A pre-auth card transaction option is available to first verify the customer's available funds before either taking the funds or setting them aside. A verify transaction option is offered as well, to confirm the authenticity of the card, acting as an effective anti-fraud measure. The card can be charged at a future date.

Delayed Capture

Payments can be processed immediately, or with delayed capture. Delayed capture allows you to send a payment link with a specific number of days to delay the payment, up to a maximum of 30 days. Payments can be manually captured before the scheduled time if needed.

Resending

Paylinks can be resent via email and SMS. This can be done through the portal and via API requests.

Reminders

Blink also offers the ability to set up reminders for unpaid payment requests. The frequency of payment reminders can be customised. If a customer has not paid by the set date, a reminder will automatically be sent.

Charitable Organisations

Paylinks offer the flexibility for customers to select the desired donation amount, making it convenient for charitable organisations, as individuals can contribute an amount of their choice. There is also an option to add gift aid.

Additional features for the API

Redirect URL

There is an option to redirect the customer to another site after they have completed the transaction. This is ideal for using the Paylinks as a hosted payment service on your website, so they can be redirected back to your site.

Notification URL

This will send a notification to the set site once the paylink has been paid. The notification will contain information such as : the customer name, payment method used, paylink reference, as well as the paylink id that you can use to retrieve more information. This helps you for tracking and updating your own systems.

See here on what information you can retrieve via notification and redirect.


Endpoints Overview