Lopay Partner API
    Lopay Partner API
    • Introduction
    • Environments
    • Authentication
    • Webhooks
    • Terminal ordering
    • Reporting
    • Errors
    • Getting started
    • Payments
    • Connecting with existing merchants
    • 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 balance
        GET
      • 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
    • Payments
      • Get existing payment
      • Refunds a payment
    • Schemas
      • Schemas
      • PartnerPayment
      • PartnerMerchant
      • WebhookSubscription
      • Subscription
      • Invoice
      • CreateSubscriptionPlan
      • SubscriptionPlan
      • WebhookSubscriptionListItem
      • PartnerApiError
      • RegisterMerchant
      • WebhookSubscriptionNoSecret
      • WebhookPortalLink
      • CreateWebhookSubscription
      • UpdatePaymentLink
      • SendPartnerPaymentLink
      • CreatePaymentLink
      • PaymentLink
      • PartnerMerchantBalanceBreakdown
      • RefundPartnerPayment

    Connecting with existing merchants

    Context#

    Private Functionality
    This functionality is not available to all partners. If you wish to have this enabled, please reach out to your Lopay representative.
    Lopay's Partner API provides functionality to establish a connection between an existing Lopay merchant and your partner entity, even if the merchant had not registered via your integration.
    This document outlines how you can enable merchants to connect to your platform, and what you can expect.

    Pre-requisites#

    1.
    Your partner entity is enabled for merchant connections.

    Steps#

    1. Request the Merchant to Generate a Pairing Code#

    Merchants are required to give explicit consent to Lopay in order for a connection to be established to your partner entity. They can do so via the Lopay merchant portal (https://portal.lopay.com).
    Please direct them to the Partners tab in the portal sidebar. From there they will be able to generate a pairing code by following the instructions shown on screen after selecting your partner integration.

    2. Connect to the Merchant using Pairing Code#

    Once the merchant has generated a pairing code, you can finish the process by sending a request with the pairing code to the Partner API. Please see Connect to a merchant API documentation for more details.
    If the pairing code is valid, the linked merchant account will be accessible via your Partner API integration.

    Revoking of Consent#

    Merchants are able to revoke their connection to your partner integration at any point via the Lopay portal. If this happens, you will not be able to access the merchant via your Partner API integration unless the merchant goes through the pairing process again.
    If this should happen, a webhook is sent to notify you of the severed connection. See Webhooks documentation for more details.
    Modified at 2026-03-04 11:55:10
    Previous
    Payments
    Next
    Payment Links
    Built with