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

Get list of available hardware for given merchant to purchase

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
GET
/api/1/partner/merchant/{id}/hardware
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//hardware' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
OK response
Body
data
array [object {6}] 
required
id
string <uuid>
required
name
string 
required
imageUrl
string  | null 
required
isDefaultCardReader
boolean 
required
pricing
array [object {7}] 
required
accessories
array [object {4}] 
required
Example
{
    "data": [
        {
            "id": "202da132-38f3-4d87-8f98-4d4691316ea5",
            "name": "wisepad_three",
            "imageUrl": null,
            "isDefaultCardReader": true,
            "pricing": [
                {
                    "id": null,
                    "primary": true,
                    "baseCost": {
                        "units": 2400,
                        "currencyCode": "GBP"
                    },
                    "totalCost": {
                        "units": 3095,
                        "currencyCode": "GBP"
                    },
                    "postageCost": {
                        "units": 695,
                        "currencyCode": "GBP"
                    },
                    "taxCost": {
                        "units": 0,
                        "currencyCode": "GBP"
                    },
                    "billingCycle": null
                }
            ],
            "accessories": [
                {
                    "id": "4b33d9a3-9552-47de-862e-8030a43c0364",
                    "name": "wisepad_three_purple_bumper",
                    "imageUrl": null,
                    "pricing": [
                        {
                            "id": null,
                            "primary": true,
                            "baseCost": {
                                "units": 2400,
                                "currencyCode": "GBP"
                            },
                            "totalCost": {
                                "units": 3095,
                                "currencyCode": "GBP"
                            },
                            "postageCost": {
                                "units": 695,
                                "currencyCode": "GBP"
                            },
                            "taxCost": {
                                "units": 0,
                                "currencyCode": "GBP"
                            },
                            "billingCycle": null
                        }
                    ]
                }
            ]
        },
        {
            "id": "e5df11d6-adba-4b5c-a7f8-23cc34caa9bf",
            "name": "s700",
            "imageUrl": null,
            "isDefaultCardReader": false,
            "pricing": [
                {
                    "id": "495d4f7e-ca63-460c-bc5e-13ac1d2b946b",
                    "primary": true,
                    "baseCost": {
                        "units": 1500,
                        "currencyCode": "GBP"
                    },
                    "totalCost": {
                        "units": 2395,
                        "currencyCode": "GBP"
                    },
                    "postageCost": {
                        "units": 895,
                        "currencyCode": "GBP"
                    },
                    "taxCost": {
                        "units": 0,
                        "currencyCode": "GBP"
                    },
                    "billingCycle": {
                        "interval": "month",
                        "intervalCount": 1,
                        "totalIntervals": 12
                    }
                }
            ],
            "accessories": []
        }
    ]
}
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-06-04 16:00:16
Previous
Create account session with permissions for the specified embedded components.
Next
Order terminal hardware for the specified merchant.
Built with