- Introduction
- Environments
- Authentication
- Webhooks
- Terminal ordering
- Reporting
- Errors
- Getting started
- Payment Links
- Webhook subscriptions
- Merchants
- List all merchantsGET
- Register a new merchantPOST
- Get merchant detailsGET
- Update merchant bank details for receiving payouts. PUT
- Get merchant onboarding linkGET
- Create account session with permissions for the specified embedded components.POST
- Get list of available hardware for given merchant to purchaseGET
- Order terminal hardware for the specified merchant.POST
- Marketing Deeplinks
- Reports
Order terminal hardware for the specified merchant.
Production Environment
Production Environment
POST
/api/1/partner/merchant/{id}/order-hardware
Merchants
Request
Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************Path Params
id
string <uuid>
required
Body Params application/json
hardware
array [object {5}]
required
id
string
required
quantity
number
required
> 0
pricingId
string | null
optional
signatureAssetId
string | null
optional
interestedInLoyalty
boolean | null
optional
deliveryAddress
object
required
nameOrNumber
string | null
optional
street
string
required
line2
string | null
optional
town
string
required
state
string | null
optional
postcode
string
required
phone
string | null
optional
deliveryNotes
string | null
optional
stripePaymentMethodId
string
required
stripeSubscriptionId
string | null
optional
Example
{
"hardware": [
{
"id": "202da132-38f3-4d87-8f98-4d4691316ea5",
"quantity": 1
}
],
"deliveryAddress": {
"nameOrNumber": "John Smith",
"street": "Flat 1",
"line2": "101 Lopay Road",
"town": "London",
"state": "London",
"postcode": "WC1X 8HN",
"phone": "07123456789",
"deliveryNotes": "Leave round the back"
},
"stripePaymentMethodId": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6"
}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 POST 'https://api.lopay.com/api/1/partner/merchant//order-hardware' \
--header 'Content-Type: application/json' \
--data-raw '{
"hardware": [
{
"id": "202da132-38f3-4d87-8f98-4d4691316ea5",
"quantity": 1
}
],
"deliveryAddress": {
"nameOrNumber": "John Smith",
"street": "Flat 1",
"line2": "101 Lopay Road",
"town": "London",
"state": "London",
"postcode": "WC1X 8HN",
"phone": "07123456789",
"deliveryNotes": "Leave round the back"
},
"stripePaymentMethodId": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6"
}'Responses
🟢200OK
application/json
Body
clientSecret
string
required
ephemeralKey
object
required
id
string
required
object
enum<string>
required
Allowed value:
ephemeral_key
created
number
required
expires
number
required
livemode
boolean
required
secret
string | null
optional
stripeCustomerId
string
required
stripeSubscriptionId
string | null
optional
totalAmount
object
required
units
integer
required
currencyCode
enum<string>
required
Allowed values:
GBPUSDEURDKK
Example
{
"clientSecret": "client_secret",
"ephemeralKey": {
"id": "ephemeral_key_id",
"object": "ephemeral_key",
"created": 1737546937,
"expires": 1737548393,
"livemode": true,
"secret": "ephemeral_key_secret"
},
"stripeCustomerId": "cus_xxx"
}🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-03-03 16:34:00