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
      • 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.
      • 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

    Authentication

    The Lopay Partner API uses API keys to allow access to the API. All partners will be provided a unique API key.
    Your API key must be included in all API requests to the server in a header that looks like the following:
    x-api-key: your-api-key
    You must also include an x-merchant-id header when acting on behalf of a Lopay account.
    Modified at 2024-08-06 20:09:16
    Previous
    Environments
    Next
    Webhooks
    Built with