Lopay Partner API
  1. Marketing Deeplinks
Lopay Partner API
  • Introduction
  • Environments
  • Authentication
  • Webhooks
  • Terminal ordering
  • Reporting
  • Errors
  • Getting started
  • Payment Links
    • List all payment links
      GET
    • Create a new payment link
      POST
    • Get existing payment link
      GET
    • Update existing payment link
      PATCH
    • Revoke an existing payment link
      DELETE
    • Send a payment link via email and/or SMS
      POST
  • Webhook subscriptions
    • Get login link for Lopay Partner Webhook Portal
      GET
    • List webhook subscriptions
      GET
    • Create webhook subscription
      POST
    • Update existing webhook subscription
      PUT
    • Remove an existing webhook subscription
      DELETE
  • Merchants
    • List all merchants
      GET
    • Register a new merchant
      POST
    • Get merchant details
      GET
    • Update merchant bank details for receiving payouts.
      PUT
    • Get merchant onboarding link
      GET
    • Create account session with permissions for the specified embedded components.
      POST
    • Get list of available hardware for given merchant to purchase
      GET
    • Order terminal hardware for the specified merchant.
      POST
  • Marketing Deeplinks
    • List all affiliate marketing deeplinks.
      GET
    • Create a new affiliate marketing deeplink.
      POST
  • Reports
    • List all statement activity
  1. Marketing Deeplinks

Create a new affiliate marketing deeplink.

Production Environment
Production Environment
POST
/api/1/partner/affiliates/marketing-deeplinks
Marketing Deeplinks

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Body Params application/json
name
string 
required
urlSuffix
string 
required
desktopFallback
string 
optional
marketingTokens
object 
optional
utmSource
string  | null 
optional
utmMedium
string  | null 
optional
utmCampaign
string  | null 
optional
adCreativeId
string  | null 
optional
Example
{
  "name": "Black Friday 2024",
  "urlSuffix": "black-friday-2024",
  "marketingTokens": {
    "utmSource": "fbads",
    "utmMedium": "120213918190230530",
    "utmCampaign": "Black Friday 2024"
  }
}

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/affiliates/marketing-deeplinks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Black Friday 2024",
    "urlSuffix": "black-friday-2024",
    "marketingTokens": {
        "utmSource": "fbads",
        "utmMedium": "120213918190230530",
        "utmCampaign": "Black Friday 2024"
    }
}'

Responses

🟢201Created
application/json
Created response
Body
id
string <uuid>
required
name
string 
required
url
string <uri>
required
desktopFallback
string  | null 
optional
marketingTokens
object 
optional
utmSource
string  | null 
optional
utmMedium
string  | null 
optional
utmCampaign
string  | null 
optional
adCreativeId
string  | null 
optional
createdAt
string 
required
Example
{
  "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-03-03T16:26:28.199Z"
}
🟠400Bad Request
🟠401Unauthorized
🟠409409
Modified at 2025-03-03 16:34:00
Previous
List all affiliate marketing deeplinks.
Next
List all statement activity
Built with