Lopay Partner API
  1. Merchants
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.
    • Create a new affiliate marketing deeplink.
  • 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. Merchants

Get merchant onboarding link

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
GET
/api/1/partner/merchant/{id}/onboarding-link
Merchants

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
id
string <uuid>
required
Merchant ID (UUID)
Query Params
returnUrl
string <uri>
required
URL to redirect to once merchant has completed onboarding

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 GET 'https://api.lopay.com/api/1/partner/merchant//onboarding-link?returnUrl' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
OK response
Body
url
string 
required
expiresAt
string 
required
Example
{
    "url": "https://connect.stripe.com/setup/c/acct_1LmZQr2fwpTOCBRL/1xDBJQzfb4u6",
    "expiresAt": "2025-06-04T15:49:48.900Z"
}
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-06-04 16:00:16
Previous
Update merchant bank details for receiving payouts.
Next
Create account session with permissions for the specified embedded components.
Built with