Payment Links
5min
A payment link is the simplest way to request payment from a customer. Here's how it works:
- Create a payment link by supplying a transaction amount (the amount you wish to request).
- Provide your submerchant ID. For operators, you can supply the submerchant ID of the account who should receive the transaction, for example a driver who has been allocated to a booking.
- Choose for us to send the payment link directly to your customer by SMS, or if you prefer you can send the URL to your customer via another channel.
- The customer can open the link using any web browser, on any device, and make payment by entering their payment details.
- You can view the status of a payment link by polling the API, or alternatively use our Webhooks feature to be notified programatically when a payment link is completed.
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).
POST
Request
Body Parameters
saleAmount
Integer
required
Requested transaction amount in currency minor units (i.e. pence)
submerchantId
String
required
Submerchant ID for the payment link
currency
String
optional
Payment currency in ISO 4217 Alpha-3 format. Currently only GBP is supported.
customerName
String
optional
Name of your customer
customerPhoneNumber
String
optional
Mobile phone number ofcustomer (E.164)
description
String
optional
Describe what the payment request is for
reference
String
optional
A reference code or number, useful for reconciliation purposes
sendCustomerSms
Boolean
optional
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.
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).
Use the clientAccessUrl property for this. Alternatively, you can use the convenient clientAccessQrCode property, which is a QR code representation of the clientAccessUrl.
Get a payment link by its ID
GET
Request
Path Params
id
String
required
ID of the payment link to retrieve
List all payment links, optionally filtering the list
GET
Request
Query Parameters
limit
Number
optional
Limit the number of responses to be returned
offset
Number
optional
Offset the list start position. Use this to paginate results
submerchantId
String
optional
Filter list by submerchant ID
status
String
optional
Filter list by payment link status
amount
Number
optional
Filter list by transaction amount (specify minor currency units)
reference
String
optional
Filter list by payment link reference
This operation can only be carried out while the payment link is in allowed statuses, usually the 'created'
PATCH
Request
Path Params
id
String
required
ID of the payment link to update
Body Parameters
saleAmount
Integer
optional
Payment amount in currency minor units e.g. pence
customerName
String
optional
Customer name
description
String
optional
Payment link description
reference
String
optional
Payment link reference
currency
String
optional
Payment currency in ISO 4217 Alpha-3 format. Currently only GBP is supported.
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.
PUT
Request
Path Params
id
String
required
Payment link ID
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.
PUT
Request
Path Params
id
String
required
Payment link ID
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.
DELETE
Request
Path Params
id
String
required
Payment link ID