List all affiliate marketing deeplinks.

Production Environment

https://api.lopay.com

GET

/api/1/partner/affiliates/marketing-deeplinks

Marketing Deeplinks

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Query Params

offsetId

string <uuid>

optional

Optional. ID of last marketing deeplink in current response.

Example:

c689b77a-d47d-4d02-b037-6f49509f759b

pageSize

number

optional

Optional - default 20. Number of payment links to return.

<= 100> 0

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.lopay.com/api/1/partner/affiliates/marketing-deeplinks' \
--header 'x-api-key;'

Responses

🟢200OK

application/json

OK response

Body

offsetId

string <uuid> | null

optional

pageSize

number

required

count

number

required

data

array [object {6}]

required

string <uuid>

required

name

string

required

url

string <uri>

required

desktopFallback

string | null

optional

marketingTokens

object

optional

createdAt

string

required

Examples

No offsetIdWith offsetId

{
    "pageSize": 1,
    "count": 2,
    "data": [
        {
            "id": "0d05445e-5283-4d63-b33d-185df8259415",
            "name": "Black Friday 2024",
            "url": "https://merchant.lopay.app/get/6ce82a99-f145-4e88-9f46-0bbc2e3af14c/black-friday-2024",
            "marketingTokens": {
                "utmSource": "fbads",
                "utmMedium": "120213918190230530",
                "utmCampaign": "Black Friday 2024"
            },
            "createdAt": "2025-06-04T15:49:48.904Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-04 16:00:16

Order terminal hardware for the specified merchant.

Create a new affiliate marketing deeplink.