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
    • Customers
      • Temporarily store customer details
    • Subscription Plans
      • Create a new subscription plan
      • List all subscription plans
      • Get existing subscription plan
    • Subscriptions
      • Get existing subscription

    Errors

    The Lopay Partner API can return the following error codes:
    Error CodeDescription
    400Bad request / Your request is invalid.
    401Unauthorized / Your API key is missing or incorrect.
    404Not found / Resource not found.
    422Unprocessable entity / Your request is valid, but we are unable to process it.
    429Too many requests / Try again in a bit.
    500Internal server error / We had a problem with our server. Try again later.
    All error responses will be in the following format:
    {
      "status": 400,
      "instance": "/api/1/partner/payment-links",
      "traceId": "bbcad049-58c2-4b56-ab77-f6c9eed81d66",
      "title": "Validation error",
      "details": "One or more parameters are invalid. See errors property for more detail",
      // Optional property
      "errors": [
        {
          "title": "Invalid parameter",
          "message": "description is missing"
        }
      ]
    }
    Modified at 2024-08-06 23:21:29
    Previous
    Reporting
    Next
    Getting started
    Built with