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

    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. The API key should be provided in the x-api-key header of the request. Omission of the header will result in the requests being rejected.

    Provisioning an API Key#

    The provisioning of API keys is not currently self-served. If you are interested in getting access to the API, please reach out to sales@lopay.com.

    Regions#

    Lopay operates in two regions, the US and UK.
    Each Lopay API key is region locked to one of the regions. This means that a US API key will not work within the UK region, and vice versa. If you require access to multiple regions, please request additional API keys to be provisioned.

    Merchant Actions#

    Some endpoints perform action against a target merchant. For those endpoints you must include an x-merchant-id header. The header value must be the target merchant ID.
    Only merchants that are linked to your partner entity are accessible via your API key.
    Modified at 2026-03-04 13:07:09
    Previous
    Environments
    Next
    Webhooks
    Built with