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
    • Remove an existing webhook subscription
      DELETE
    • Create webhook subscription
      POST
    • Update existing webhook subscription
      PUT
  • Merchants
    • List all merchants
      GET
    • Register a new merchant
      POST
    • Connect to a 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
  • Customers
    • Temporarily store customer details
  • Subscription Plans
    • Create a new subscription plan
    • List all subscription plans
    • Get existing subscription plan
  • Subscriptions
    • Get existing subscription
  1. Marketing Deeplinks

Create a new affiliate marketing deeplink.

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
POST
/api/1/partner/affiliates/marketing-deeplinks

Request

Authorization
or
Body Params application/json

Examples
{
    "name": "Black Friday 2024",
    "urlSuffix": "black-friday-2024",
    "marketingTokens": {
        "utmSource": "fbads",
        "utmMedium": "120213918190230530",
        "utmCampaign": "Black Friday 2024"
    }
}

Request Code 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
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

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-07-21T08:33:07.004Z"
}
🟠400Bad Request
🟠401Unauthorized
🟠409409
Modified at 2025-07-22 09:23:17
Previous
List all affiliate marketing deeplinks.
Next
List all statement activity
Built with