A payment link is the simplest way to request payment from a customer. Here's how it works:

Use this endpoint to create a payment link. You can optionally send it to your customer.

The only required parameters are: saleAmount and submerchantId. Note that transaction amounts should always be specified in currency minor units (for example pence).


Create a Payment Link

Requested transaction amount in currency minor units (i.e. pence)

saleAmount

submerchantId

Payment currency in ISO 4217 Alpha-3 format. Currently only GBP is supported.

currency

customerName

customerPhoneNumber

description

A reference code or number, useful for reconciliation purposes

reference

Indicate whether you wish to sent the payment link to the customer via SMS. If you intend to provide the customer with the link directly, set this to false. 

sendCustomerSms

Once created, you may wish to send the payment link directly to your customer (for example by embedding it within a message, email or invoice). 

 property for this. Alternatively, you can use the convenient 

 property, which is a QR code representation of the 

Retrieve a payment link

List all payment links, optionally filtering the list

List Payment Links

Limit the number of responses to be returned

limit

Offset the list start position. Use this to paginate results

offset

status

Filter list by transaction amount (specify minor currency units)

amount

This operation can only be carried out while the payment link is in allowed statuses, usually the 'created'

Update a payment link

Payment amount in currency minor units e.g. pence

Sometimes, a customer may get stuck when attempting a payment, for example due to 3DS problems. This function resets the authorization state of the payment link, allowing the customer to try agin.

Reset a payment link

If you need to cancel a payment link (for example, if the price of a booking has changed and you wish to invalidate the payment request), use this operation. The customer will not be able to carry out a payment. This operation is only available if the payment link status is not final.

Cancel a payment link

If you need to delete a previously cancelled payment link, use this operation. This operation is only available if the payment link status is cancelled.