Order terminal hardware for the specified merchant.

Production Environment

https://api.lopay.com

POST

/api/1/partner/merchant/{id}/order-hardware

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Example

Terminal order details

{
    "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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.lopay.com/api/1/partner/merchant//order-hardware' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--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

OK response

Body

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-07-21 15:14:02

Get list of available hardware for given merchant to purchase

List all affiliate marketing deeplinks.