Skip to main content

Pay Reporting

The Pay Reporting component (pay-reporting) provides financial settlement and payout reporting for merchants. It generates reports covering payout summaries, transaction-level breakdowns, fee analysis, and reconciliation data.

Loaded via: Orchestrator Oc (requires CreditRisk approved + Adyen KYC active)


How It Works​

The Orchestrator Oc authenticates and authorizes the user, then passes a signed JWT and organisation ID to this component. The component's server-side fetches payout and settlement data from the Pay Reporting API, scoped to the merchant's balance accounts and stores.

Orchestrator Oc
|
| Passes authToken + evoOrganisationId
v
Pay Reporting OC (server)
|
| Fetches filter options (balance accounts, stores, report types)
| Fetches payout summaries and details
v
Pay Reporting OC (client)
|
| Renders filter panel + payout summary table
| Payout detail modal on row click
| Export to CSV/XLSX

Parameters​

All parameters are injected by the Orchestrator Oc. The host application does not pass these directly.

ParameterTypeDescription
evoOrganisationIdstringTenant organisation ID, scopes all queries to this merchant
authTokenstringSigned JWT (60-minute expiry) issued by the orchestrator API
langstringUI language code (e.g. en)
cultureCodestringLocale for date/number formatting (e.g. en-GB)
csvSeparatorstringDelimiter for CSV exports (defaults to ,)

Report Types​

The component supports four report types, each providing a different level of detail and filtering:

Report TypeDescriptionFilters Available
FRR Daily SummaryDaily settlement summary aggregated by balance accountDate range, Balance accounts
FRR DetailedTransaction-level settlement detailDate range, Balance accounts, Stores
Consolidated Processing StatementProcessing statement viewDate range, Stores
Merchant Statement ViewMerchant-specific settlement viewDate range, Stores

Filters​

The filter panel adapts based on the selected report type:

FilterTypeAvailabilityDetails
Date RangeDate pickerAll report typesDefaults to last 7 days. Custom range supported.
Balance AccountsMulti-selectFRR Daily Summary, FRR DetailedMerchant's Adyen balance accounts
StoresMulti-selectFRR Detailed, Consolidated, Merchant StatementAuto-filters based on selected balance account
info

When a balance account is selected, the stores dropdown automatically updates to show only stores associated with that balance account.

Filters are debounced (300ms) — the payout summary refreshes automatically as filters change.


Payout Summary Table​

After applying filters, the component displays a paginated summary table:

ColumnDescription
Balance AccountThe Adyen balance account for this settlement
Trading DateThe date the transactions were processed
Opening BalanceBalance at the start of the trading day
Gross PaymentsTotal payment volume
ChargebacksTotal chargeback amount
Chargeback FeesFees charged for chargebacks
FeesProcessing fees
Net AmountNet settlement amount
Funding TotalTotal amount funded to the merchant
Closing BalanceBalance at the end of the trading day
Funding ReferenceClickable link to view transaction-level detail

A totals row at the bottom shows aggregate sums across all visible rows.


Payout Detail Modal​

Clicking a Funding Reference in the summary table opens a detail modal showing the individual transactions that make up that settlement:

ColumnDescription
StoreWhich store processed the transaction
Balance AccountAssociated balance account
Transaction TypePayment, refund, chargeback, etc.
Transaction / Value DateWhen the transaction occurred
Gross PaymentOriginal transaction amount
Card SchemeVisa, Mastercard, etc.
Card TypeCredit, debit, corporate
Service TypeeCommerce, MOTO, POS
RegionDomestic, intra-regional, international
Interchange FeeInterchange cost
Scheme FeeCard scheme cost
Acquiring FeeAcquirer cost
Total FeesSum of all fees
Net PaymentAmount after fees
Pricing ModelWhich pricing model applies

The detail view is paginated (25 records per page) with continuation token-based pagination.


Export​

Reports can be exported in two formats:

FormatEncodingDetails
CSVUTF-8 with BOMDelimiter configurable via csvSeparator parameter
XLSXExcel formatNative Excel file

Filename format: {reportType}_{startDate}_{endDate}.{ext}

The export includes all data matching the current filters, not just the visible page.


Error Handling​

ScenarioBehaviour
User not authorizedDisplays restricted access message
No data for selected date rangeDisplays "no data available" message
Export fails (auth error)Displays authentication error with refresh guidance
Export fails (missing stores)Displays guidance to select stores
Export fails (server error)Displays generic error with retry guidance

Existing data remains visible while new payout summaries are loading.

All API calls are authenticated using the JWT passed by the Orchestrator Oc.