Skip to main content

Reporting

This page provides insights into the various reporting features available in PlanPay, serving as a resource for the merchants' finance team to aid in reconciliation and for operational staff to conduct reviews.

Viewing existing plans in the Merchant Dashboard

The first option is to log in to the Merchant Dashboard and view the existing plans.

This will firstly give a summary of all the plans for the specific merchant or sub-merchant. Then more details can be found by clicking into each plan.

Please see a brief video below on how you can view and manage existing plans in the merchant dashboard.

info

TIP: This is the preferred option if you wanted to do a quick check on a plan or number of plans.

Reporting via the Merchant Dashboard

In addition to viewing all the plans your Customers have made with you there are also two reports available to export for Merchants.

  • Transaction Report: This report lists all of the payments a Customer has made and is useful for analytics, reconciliation, or financial reporting.
  • Plans Report: This report provides a list of all plans including information such as balance paid and balance still due and is useful for reconciliation and business reporting.
info

TIP: This is the preferred option if you wish to look in detail at multiple transactions or plans.

caution

These reports are currently being enabled in the merchant portal, please contact your account manager to provide these reports.

Reporting via the PlanPay API

PlanPay offers access to a merchant initiated API so merchants can directly access two different plan queries:

  • getPlans - This query will give a list of plans in a summary format, containing details such as lastModified date, Merchant Booking IDs, Plan IDs and Merchant/Sub-Merchant IDs.
  • getPlanDetails - This query will give all the information for a specific plan or group of plans, containing details such as installment frequency and amounts, remaining balance and Status.

Please refer to the API reference documentation for more information on how to integrate with this API.