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

Reporting

📌

Viewing merchant reports is not enabled by default for partners. If you are interesting in this feature, please reach out to backend@lopay.com.

The reporting endpoints allow Partners to view their merchants' activity reports, showing the same data as they would see within their mobile app.

Overview of report types#

Statement activity#

This report shows an overview of all merchant statement activity. This activity can be broken down into five main type: income, refunds, payouts, card spend and cash advance repayments.
Currently the endpoint allows filtering by type, team member, and by a string query search term. This query search term can be used to look for transaction amounts, payment descriptions, customer emails etc.
The data is displayed in createdAt descending order.
Modified at 2025-02-21 11:28:14
Previous
Terminal ordering
Next
Errors
Built with