List all merchants - Lopay Partner API

Request

Authorization

or

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

OK response

Body

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-07-21T08:33:06.939Z",
            "updatedAt": "2025-07-21T08:33:06.939Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized