List all merchants - Lopay Partner API

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

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

No offsetIdWith offsetId

{
    "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-06-04T15:49:48.899Z",
            "updatedAt": "2025-06-04T15:49:48.899Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized