- Introduction
- Environments
- Authentication
- Webhooks
- Terminal ordering
- Reporting
- Errors
- Getting started
- Payment Links
- Webhook subscriptions
- Merchants
- List all merchantsGET
- Register a new merchantPOST
- Get merchant detailsGET
- Update merchant bank details for receiving payouts. PUT
- Get merchant onboarding linkGET
- Create account session with permissions for the specified embedded components.POST
- Get list of available hardware for given merchant to purchaseGET
- Order terminal hardware for the specified merchant.POST
- Marketing Deeplinks
- Reports
Get existing payment link
Production Environment
Production Environment
GET
/api/1/partner/payment-link/{id}
Payment Links
Request
Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************Path Params
id
string <uuid>
required
Header Params
x-merchant-id
string <uuid>
Merchant ID
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lopay.com/api/1/partner/payment-link/' \
--header 'x-merchant-id;'Responses
🟢200OK
application/json
Body
id
string <uuid>
required
merchantId
string <uuid>
required
status
enum<string>
required
Allowed values:
pendingcancelledcompleted
link
string <uri>
required
amount
object
required
units
integer
required
currencyCode
enum<string>
required
Allowed values:
GBPUSDEURDKK
description
string
required
reference
string | null
required
dataCollection
array[string]
required
Allowed values:
namebusinessNamephoneNumberemailaddress
taxes
array [object {3}]
required
name
string
required
inclusive
boolean
required
amount
object
required
payments
array [object {9}]
required
id
string <uuid>
required
type
enum<string>
required
Allowed values:
cardbankTransfer
cardDetails
object
optional
tip
object
required
taxes
array [object {4}]
required
subtotal
object
required
total
object
required
createdAt
string
required
updatedAt
string
required
returnUrl
string <uri> | null
required
createdAt
string
required
updatedAt
string
required
Example
{
"id": "04263b21-ec89-4bab-9b36-b0807b27c9e1",
"merchantId": "c45d1500-2184-4058-94c2-8a48f2efca62",
"status": "completed",
"dataCollection": [
"name",
"phoneNumber"
],
"amount": {
"units": 3000,
"currencyCode": "GBP"
},
"link": "https://lopay.app/08adf/b9f0bc31-4209-4bbb-bf1d-2ea124031056",
"reference": "INV12345",
"description": "Payment for INV#1003 (Peter Jones)",
"payments": [
{
"id": "662a8074-6959-4793-8ac9-a1f03d5f1181",
"type": "card",
"taxes": [
{
"name": "VAT (20%)",
"inclusive": true,
"rate": "20.00",
"amount": {
"units": 500,
"currencyCode": "GBP"
}
}
],
"tip": {
"units": 0,
"currencyCode": "GBP"
},
"subtotal": {
"units": 3000,
"currencyCode": "GBP"
},
"total": {
"units": 3000,
"currencyCode": "GBP"
},
"createdAt": "2023-03-08T23:12:32.686Z",
"updatedAt": "2023-03-08T23:12:32.686Z"
}
],
"returnUrl": null,
"taxes": [
{
"name": "VAT (20%)",
"inclusive": true,
"rate": "20.00",
"amount": {
"units": 500,
"currencyCode": "GBP"
}
}
],
"createdAt": "2023-03-09T06:01:24.752Z",
"updatedAt": "2023-03-09T06:12:32.768Z"
}🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-03-03 16:34:00