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

    Payment Links

    Custom redirect on payment completion#

    Through the Partner API, it is possible to specify a redirect URL (returnUrl) for a given payment link. This redirect will be triggered upon payment completion, allowing for Lopay payment links to directly integrate with your own flows.
    When redirecting the payee to the specified URL, Lopay will attach additional query data to that URL. The possible attached query parameters can be seen in the table below.
    Query paramValuesDescription
    statussuccessfulIndication of payment link payment status. Currently redirects will only happen after successful payment completion.
    paymentRequestIdstringThe ID of the payment link from which the redirect has been triggered.
    A null value will mean that no redirect will be triggered, and is the default value if no returnUrl value specified.
    Modified at 2025-03-03 16:50:15
    Previous
    Getting started
    Next
    List all payment links
    Built with