Lopay Partner API
  1. Payment Links
Lopay Partner API
  • Introduction
  • Environments
  • Authentication
  • Webhooks
  • Terminal ordering
  • Reporting
  • Errors
  • Getting started
  • Payment Links
    • List all payment links
      GET
    • Create a new payment link
      POST
    • Get existing payment link
      GET
    • Update existing payment link
      PATCH
    • Revoke an existing payment link
      DELETE
    • Send a payment link via email and/or SMS
      POST
  • Webhook subscriptions
    • Get login link for Lopay Partner Webhook Portal
      GET
    • List webhook subscriptions
      GET
    • Remove an existing webhook subscription
      DELETE
    • Create webhook subscription
      POST
    • Update existing webhook subscription
      PUT
  • Merchants
    • List all merchants
      GET
    • Register a new merchant
      POST
    • Connect to a merchant
      POST
    • Get merchant details
      GET
    • Update merchant bank details for receiving payouts.
      PUT
    • Get merchant onboarding link
      GET
    • Create account session with permissions for the specified embedded components.
      POST
    • Get list of available hardware for given merchant to purchase
      GET
    • Order terminal hardware for the specified merchant.
      POST
  • Marketing Deeplinks
    • List all affiliate marketing deeplinks.
    • Create a new affiliate marketing deeplink.
  • Reports
    • List all statement activity
  • Customers
    • Temporarily store customer details
  • Subscription Plans
    • Create a new subscription plan
    • List all subscription plans
    • Get existing subscription plan
  • Subscriptions
    • Get existing subscription
  1. Payment Links

List all payment links

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
GET
/api/1/partner/payment-link

Request

Authorization
or
Query Params

Header Params

Request Code 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'

Responses

🟢200OK
application/json
OK response
Body

Examples
{
    "pageSize": 1,
    "count": 2,
    "data": [
        {
            "id": "dd82c9e8-63a2-45a2-9e74-6d82c5b22c65",
            "merchantId": "8e272ef4-4fba-4ec7-a414-9e8907a71faf",
            "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": "2024-08-05T15:23:08.194Z",
            "updatedAt": "2024-08-05T15:23:08.194Z"
        }
    ]
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-07-22 09:23:17
Previous
Payment Links
Next
Create a new payment link
Built with