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
    • 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. Merchants

Register a new merchant

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
POST
/api/1/partner/merchant

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Body Params application/json

Examples
{
    "legalBusinessName": "Sweet Shop Consortium Ltd",
    "tradingName": "Pam's Sweet Shop",
    "country": "GB",
    "owner": {
        "firstName": "Pam",
        "lastName": "Sweeney",
        "email": "pam@sweetshopconsortium.co.uk",
        "phoneNumber": "+447927987641"
    },
    "bankDetails": {
        "sortCode": "108800",
        "accountNumber": "00012345",
        "accountHolderDetails": {
            "name": "Sweet Shop Consortium Ltd",
            "type": "company"
        }
    },
    "payoutSchedule": {
        "accountType": "essential"
    },
    "marketingOptIn": true,
    "acceptTermsOfUse": true
}

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
curl --location --request POST 'https://api.lopay.com/api/1/partner/merchant' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "legalBusinessName": "Sweet Shop Consortium Ltd",
    "tradingName": "Pam'\''s Sweet Shop",
    "country": "GB",
    "owner": {
        "firstName": "Pam",
        "lastName": "Sweeney",
        "email": "pam@sweetshopconsortium.co.uk",
        "phoneNumber": "+447927987641"
    },
    "bankDetails": {
        "sortCode": "108800",
        "accountNumber": "00012345",
        "accountHolderDetails": {
            "name": "Sweet Shop Consortium Ltd",
            "type": "company"
        }
    },
    "payoutSchedule": {
        "accountType": "essential"
    },
    "marketingOptIn": true,
    "acceptTermsOfUse": true
}'

Responses

🟢201Created
application/json
Created response
Body

Example
{
    "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
Modified at 2025-07-21 15:14:02
Previous
List all merchants
Next
Connect to a merchant
Built with