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

    Introduction

    Context#

    The Lopay Partner API enables partners to seamlessly send payment links and collect payments through their applications. This API also provides webhooks to notify partners of various payment-related events, ensuring real-time updates and streamlined operations.

    Primary Features#

    Payment links: Generate and send payment links to customers.
    Webhooks: Receive real-time notifications on payment events.

    Private and Preview Features#

    Subscription Plans: Generate a new subscription plan against the specified merchant.
    Payments: View information about customer payments and create refunds.
    Connect to existing merchants: Allow existing Lopay merchants to establish a link to your partner entity, even if they haven't registered via your platform.
    Please reach out to your Lopay representative to enquire about enabling preview or preview functionality.

    Beginner Documentation#

    Authentication
    Getting started
    Modified at 2026-03-04 13:07:09
    Next
    Environments
    Built with