Connect to a merchant

Production Environment

https://api.lopay.com

POST

/api/1/partner/merchant/connect

Establishes a connection between a partner and merchant using a pairing code. The merchant must have generated the pairing code beforehand, and the code must be valid and not expired. Upon successful connection, returns the merchant details including business information, capabilities, payout schedule, and bank details.

Request

Authorization

Body Params application/json

Example

Use a pairing code to link to a merchant

{
    "code": "ABCD-EFGH-IJKL"
}

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/connect' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "ABCD-EFGH-IJKL"
}'

Responses

🟢200OK

application/json

OK response

Body

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-07-21T08:33:07.061Z",
    "updatedAt": "2025-07-21T08:33:07.061Z"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-07-22 09:23:17

Get merchant details