PayStar API Documentation
  1. PRODUCTS & FEATURES | EN
  • PRODUCTS & FEATURES | EN
    • GATEWAY QUALITY INDEX (GQI)
    • DIRECT CONNECT
    • PAYSTAR CORE
    • Deposits section in PayStar
    • Summary Report
    • Payment Analytics
    • Payment Form Analytics
    • Unified audit log
    • Export reports
    • Black list
    • Commissions
    • Team
    • My Account
    • PayStar in 100 Questions
  • PAYSTAR FEATURES | RU
    • ИНДЕКС КАЧЕСТВА ПЛАТЕЖНЫХ ШЛЮЗОВ
    • ПРЯМОЕ ПОДКЛЮЧЕНИЕ
    • PAYSTAR ЯДРО
    • Депозиты
    • Сводный отчёт
    • Аналитика по платежам
    • Аналитика платёжной формы
    • Единый журнал событий
    • Экспорт отчётов
    • Черный список
    • Комиссии
    • Команда
    • Мой аккаунт
    • PayStar в 100 вопросах
  • MERCHANT API DOC | EN
    • Introduction
    • Glossary
    • Authorization key
    • Sandbox
    • Additional fields
    • Currencies
    • Bank names
    • Telecom operators
    • Callbacks
    • Error descriptions
    • Tech FAQ
    • Events
    • Payment history v2
      • Payment history - backward compatibility (legacy `X.Y.Z.W`)
    • Integratins
      • Stripe
      • Inwizo
      • 2Checkout
      • Adyen
      • AffiniPay
      • Alikassa
      • AlliancePay
      • Amazon Pay
      • AnyMoney
      • AstroPay
      • Aureavia
      • AurisMyChanger
      • Authorize.Net
      • Avatarix
    • Balance H2H
    • Deposit H2H - Card & P2P
    • Deposit H2H - Token
    • Deposit H2C - Card
    • Deposit status H2H - PayStar ID
    • Deposit status H2H - Merch ID
    • Payout H2H
    • Payout status H2H - PayStar ID
    • Payout status H2H - Merch ID
  1. PRODUCTS & FEATURES | EN

Summary Report

Quick control of payments, conversion, and unit economics#

The “Summary report” section is an aggregated view of key payment metrics for a selected period. It helps you understand in minutes:
where conversion is “hurting” (by merchant / gateway / cashier),
who delivers turnover and successful payments,
how fees, balances, and settlements change over time,
what’s happening with RR and profit (if the relevant columns are enabled).

1) What exactly the “Summary report” shows#

Depending on the columns you enable, the report can include:
Conversion (success/total)
Payments: total / payments: success
Turnover (success)
Fee % / Fee (amount)
Start balance / End balance
Netting / Settlement (if used)
RR (RR %, RRReserve, RRReturn, RR Total — if enabled)
Profit (if enabled)
The report supports different “views” (dimensions) to quickly localise an issue or assess performance:
By merchant
By gateway
By cashier (if used)

2) Where to start: 3 switches that solve everything#

image.png

2.1 Period#

Select the date range the report should cover.

2.2 Aggregation: Day / Week / Month#

Aggregation defines how the report groups data within the selected period:
Day — operational monitoring and pinpointing exact “drops”
Week — trend management and dynamics
Month — planning and controlling economics at a period level

2.3 View: By merchant / By gateway / By cashier#

The same period can be analysed from different perspectives to identify the source of a drop or growth.

3) How to read the table: two flow directions#

Metrics may be displayed in two flow directions (for example, incoming and outgoing).
Typically, this looks like two lines of values in a single cell:
the top line — one flow,
the bottom line — the other flow,
if there is no data for a flow, you will see --.
image.png

4) A quick “5-minute” diagnostic flow#

Step 1. Find the conversion drop#

1.
Select Day
2.
Switch to By gateway
3.
Sort / visually identify days or rows with low conversion
4.
Switch to By merchant to check whether the issue is “isolated” or “system-wide”
Interpretation:
a drop on one gateway across many merchants → more likely a provider/channel issue;
a drop for one merchant across multiple gateways → more likely a traffic/configuration issue on the merchant side.

5) Filters: how to narrow the report to the right segment#

Use filters to view the report in the required scope (for example, a specific merchant, currency, etc.).
A Clear filters button is typically available as well.
image.png

6) Columns: how to show only the metrics you need#

The report is flexible: you can show/hide metrics via the column menu and click Apply.
Practical presets:
for conversion: Conversion, Payments: total/success
for economics: Turnover (success), Fee %/Fee, Profit
for liquidity: Start/End balance, Netting/Settlement, RR
image.png

7) Export: download the report for your team, partner, or reconciliation#

Export downloads the report with the current settings:
selected period and Day/Week/Month aggregation,
selected view By merchant / By gateway / By cashier,
applied filters,
selected set of columns.
image.png

8) How to calculate the fee as a percentage (important nuance)#

The final Fee % for a period should be interpreted as an effective (turnover-weighted) rate:
Fee % = (Fee / Successful turnover) × 100%
This is especially important when rates change within the period: the final percentage is “averaged” through turnover, not as a simple average of rate values.

9) Balances and timezone#

Start and End balance are calculated at the boundaries of the selected aggregation (Day/Week/Month) in the Organisation timezone.
image.png

10) Why the report is generated with a delay#

The report is typically generated with up to a 1-day delay, so new payments can reach final statuses and the figures are not distorted.
If a payment status changes later, the report metrics may update, but not instantly.

11) Practical use cases#

11.1 Conversion dropped#

By gateway → identify the problematic provider/period
By merchant → determine whether it’s one merchant or widespread
narrow further with filters (currency/scope) and capture conclusions via Export

11.2 I see a negative end balance#

Check:
incoming vs outgoing successful turnover,
fees (%, amount),
RR (if applicable),
netting/settlement (if used),
compare By merchant and By gateway views to localise the driver.

11.3 I need arguments for a partner (merchant/PSP)#

use Week/Month and enable economics columns,
show the dynamics of conversion/turnover/cost,
attach Export as a fact base.
Previous
Deposits section in PayStar
Next
Payment Analytics
Built with