- 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
- Customers
- Subscription Plans
- Subscriptions
Update existing payment link
Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
PATCH
/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
Body Params application/json
description
string
required
returnUrl
string <uri> | null
optional
Examples
{
"description": "My updated payment link description"
}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
curl --location --request PATCH 'https://api.lopay.com/api/1/partner/payment-link/' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
"description": "My updated payment link description"
}'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": "dd82c9e8-63a2-45a2-9e74-6d82c5b22c65",
"amount": {
"units": 15000,
"currencyCode": "GBP"
},
"link": "https://lopay.app/08adf/b9f0bc31-4209-4bbb-bf1d-2ea124031056",
"reference": null,
"description": "Payment for INV#1000 (Gary Smith)",
"status": "pending",
"dataCollection": [
"name"
],
"taxes": [],
"payments": [],
"returnUrl": null,
"createdAt": "2025-06-04T15:49:48.881Z",
"updatedAt": "2025-06-04T15:49:48.881Z"
}🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-06-04 16:00:16