Create a new payment link

Production Environment

https://api.lopay.com

POST

/api/1/partner/payment-link

Request

Authorization

Header Params

Body Params application/json

Examples

Create payment link with VAT 20%Create payment link with specified redirect

{
    "description": "Payment for INV#1001 (Peter Parker)",
    "reference": "INV12345",
    "amount": {
        "units": 20000,
        "currencyCode": "GBP"
    },
    "dataCollection": [
        "name",
        "phoneNumber"
    ],
    "taxes": [
        {
            "name": "VAT (20%)",
            "inclusive": true,
            "rate": "20.0"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Create payment link with VAT 20%Create payment link with specified redirect

curl --location --request POST 'https://api.lopay.com/api/1/partner/payment-link' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Payment for INV#1001 (Peter Parker)",
    "reference": "INV12345",
    "amount": {
        "units": 20000,
        "currencyCode": "GBP"
    },
    "dataCollection": [
        "name",
        "phoneNumber"
    ],
    "taxes": [
        {
            "name": "VAT (20%)",
            "inclusive": true,
            "rate": "20.0"
        }
    ]
}'

Responses

🟢200OK

application/json

OK response

Body

Example

{
    "id": "dd82c9e8-63a2-45a2-9e74-6d82c5b22c65",
    "amount": {
        "units": 15000,
        "currencyCode": "GBP"
    },
    "link": "https://lopay.app/08adf/b9f0bc31-4209-4bbb-bf1d-2ea124031056",
    "reference": "INV12345",
    "description": "Payment for INV#1000 (Gary Smith)",
    "status": "pending",
    "dataCollection": [
        "name",
        "phoneNumber"
    ],
    "taxes": [
        {
            "name": "VAT (20%)",
            "inclusive": true,
            "rate": "20.0",
            "amount": {
                "units": 3000,
                "currencyCode": "GBP"
            }
        }
    ],
    "payments": [],
    "returnUrl": null,
    "createdAt": "2025-07-21T08:33:06.887Z",
    "updatedAt": "2025-07-21T08:33:06.887Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

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

List all payment links

Get existing payment link