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

Get merchant details

Production Environment
Production Environment
GET
/api/1/partner/merchant/{id}
Merchants

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
id
string <uuid>
required
Merchant ID (UUID)

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
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
firstName
string 
required
lastName
string 
required
email
string <email> | null 
optional
phoneNumber
string  | null 
optional
capabilities
object 
required
paymentLinksEnabled
boolean 
required
Once the merchant has completed the KYB process
and no other restrictions have been placed on their account, this value
will be set to true and then the merchant can start taking payments.
foreignCardsEnabled
boolean 
required
By default, only cards from the same geography as the merchant
can be accepted. For example, a UK merchant can only accept UK cards. This is a
fraud protection mechanism. If the merchant needs to accept foreign cards, please
reach out to Lopay (support@lopay.com) to enable this feature.
payoutSchedule
object  | null 
optional
accountType
enum<string> 
required
Please see https://lopay.com/pricing for differences in account types.
Allowed values:
essentialstandardinstantToBank
config
optional
paused
boolean 
required
bankDetails
object  | null 
optional
sortCode
string 
required
accountNumber
string 
required
accountHolderDetails
object 
required
createdAt
string 
required
updatedAt
string 
required
Example
{
  "id": "bab44203-030d-4f08-9bec-8df642fa4443",
  "legalBusinessName": "Jim's Jammy Jam Ltd",
  "tradingName": "Jim's Jammy Jam Ltd",
  "country": "GB",
  "owner": {
    "firstName": "Jim",
    "lastName": "Jammy",
    "email": "contact@jammyjam.com",
    "phoneNumber": "+447927987645"
  },
  "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
🟠404Record Not Found
Modified at 2025-03-03 16:34:00
Previous
Register a new merchant
Next
Update merchant bank details for receiving payouts.
Built with