Lopay Partner API
  1. Merchants
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
    • Create webhook subscription
      POST
    • Update existing webhook subscription
      PUT
    • Remove an existing webhook subscription
      DELETE
  • Merchants
    • List all merchants
      GET
    • Register a new 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
  1. Merchants

List all merchants

Production Environment
Production Environment
GET
/api/1/partner/merchant
Merchants

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params
offsetId
string <uuid>
optional
Optional. ID of last payment link in current response.
Example:
c689b77a-d47d-4d02-b037-6f49509f759b
pageSize
number 
optional
Optional - default 20. Number of payment links to return.
<= 100> 0
Example:
20

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/merchant'

Responses

🟢200OK
application/json
OK response
Body
offsetId
string <uuid> | null 
optional
pageSize
number 
required
count
number 
required
data
array [object {10}] 
required
id
string <uuid>
required
Lopay unique identifier for merchant.
legalBusinessName
string 
required
The legal business name for the entity. This is the name that appears within Companies House.
tradingName
string 
required
The name used by a business to operate. This can differ from the legal business name.
country
enum<string> 
required
Allowed values:
ATBEBGCACYCZDEDKEEESFIJEKWGRHRHUIEIMITLTLULVMTNLPOPTROSESISKGBUSGGGGY
owner
object 
required
capabilities
object 
required
payoutSchedule
object  | null 
optional
bankDetails
object  | null 
optional
createdAt
string 
required
updatedAt
string 
required
Examples
{
  "pageSize": 1,
  "count": 2,
  "data": [
    {
      "id": "0d05445e-5283-4d63-b33d-185df8259415",
      "legalBusinessName": "Sweet Shop Consortium Ltd",
      "tradingName": "Pam's Sweet Shop",
      "country": "GB",
      "owner": {
        "firstName": "Pam",
        "lastName": "Sweeney",
        "email": "pam@sweetshopconsortium.co.uk",
        "phoneNumber": "+447927987641"
      },
      "capabilities": {
        "paymentLinksEnabled": true,
        "foreignCardsEnabled": false
      },
      "payoutSchedule": {
        "accountType": "essential",
        "config": {
          "type": "monthly",
          "monthlyAnchor": 1
        },
        "paused": false
      },
      "bankDetails": {
        "sortCode": "****00",
        "accountNumber": "****2345",
        "accountHolderDetails": {
          "name": "Sweet Shop Consortium Ltd",
          "type": "company"
        }
      },
      "createdAt": "2025-03-03T16:26:28.191Z",
      "updatedAt": "2025-03-03T16:26:28.191Z"
    }
  ]
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-03-03 16:34:00
Previous
Remove an existing webhook subscription
Next
Register a new merchant
Built with