Lopay Partner API
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

Getting started

Welcome to the Lopay Partner API Getting Started Guide! This guide will walk you through the basic steps to start integrating with the Lopay Partner API, whether you're acting as a platform facilitating payments for your customers or taking payments for your own business.

Important notes#

Always send the header x-region: region_eu in all requests you make to the Partner API to ensure your requests get routed correctly to the EU servers.

Prerequisites#

Before you begin, ensure you have the following:
Your Lopay Partner API key. You’ll need this key to authenticate your requests to the Lopay API.

Getting Started Steps#

1. Subscribe to Webhooks#

To receive notifications about payment events, you'll need to subscribe to webhooks. You can do this by either:
Using the available Lopay Partner API endpoints to configure your webhooks programmatically.
Using the Lopay Webhook Portal for a more user-friendly interface.
For more details, please refer to the Configuring Webhooks section of the documentation.

2. Register Lopay Merchant Account#

Depending on your business model, you’ll need to register a Lopay merchant account:
As a Platform: Create a Lopay merchant account for each of your customers. This ensures that any payments processed via a payment link are paid directly to your customer. Refer to the "Register a New Merchant Endpoint" section for details on how to accomplish this.
For Your Own Business: If you're only accepting payments for your business, create a single Lopay merchant account for yourself. You’ll use the merchant ID associated with this account in the x-merchant-id header when creating payment links.
Merchants must complete Stripe's onboarding before being able to take any form of payment. This can be done via the Lopay app, or through the merchant onboarding link (retrieved via the /merchant/{id}/onboarding-link endpoint).

3. Create a Payment Link#

Once your merchant account is registered, you can create a payment link by calling the POST /api/1/partner/payment-link.

4. Send the Payment Link#

After creating the payment link, you can send it to your customers:
Using the Lopay Partner API: Use the "Send Payment Link" endpoint to send the payment link directly to your customer via email and/or SMS.
Manual Sending: Alternatively, you can retrieve the link property from the API response and send it manually via your preferred communication channel.
You're now ready to start accepting payments with the Lopay Partner API! For more advanced features and details, please refer to the full Lopay Partner API documentation.
Modified at 2025-03-25 09:31:47
Previous
Errors
Next
Payment Links
Built with