Lopay Partner API
    Lopay Partner API
    • Introduction
    • Environments
    • Authentication
    • Webhooks
    • Terminal ordering
    • Reporting
    • Errors
    • Getting started
    • Payments
    • 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

    Payments

    📌
    Fetching and refunding payments is not enabled by default for partners.
    If you are interested in using this feature, please reach out to
    backend@lopay.com
    The Payments endpoints allow Partners to retrieve detailed information about
    a specific payment or issue a refund directly through the API. These endpoints
    are designed to give partners greater control and visibility over transactions
    processed through Lopay, without needing to rely on manual dashboard access.
    Only payments made via a payment link or a subscription are eligible to
    be fetched or refunded.
    Use the following endpoints to:
    GET /api/1/partner/payment/{id} – Retrieve payment details, including amounts,
    taxes, tips, and status.
    POST /api/1/partner/payment/{id}/refund – Refund a previously successful
    payment, either in full or partially (specified in minor units as a negative
    value).
    Each request must include the relevant merchantId in the header if you are
    acting on behalf of a merchant.
    Modified at 2025-10-30 12:10:50
    Previous
    Getting started
    Next
    Payment Links
    Built with