HSRCPAY Documentation

Dashboard Operations

Guide to Transactions (payment), Charges, Payment Methods, and operational review in the dashboard.

The dashboard gathers context around a single record for payment operations. The menu shows Transactions; in the API and domain model these records are payments. Charges are provider attempts; multiple charges under one payment are normal (routing fallback, re-confirm).

This page reflects current screens; do not assume alarm or reporting features that are not listed.

Menu groups and items are fixed in the dashboard left menu. The Surface column below is the sidebar label you see in the UI. Detail screens are not separate sidebar items; open them from the relevant list row or global search.

Global search (command palette): navigates to payment, charge, refund, and payment method IDs.

Dashboard group

SurfaceUsed forOperational value
DashboardMain summary screenDaily KPIs and short navigation; not enough for deep incident analysis
CatalogProduct catalog (planned)Under construction
CustomersAccount customer list and recordsMatch with customer_id on payments, customer context
TransactionsPayment list (API: payments)Main operations entry; open payment detail from the list

Payments group

SurfaceUsed forOperational value
ChargesAll charge attempt listScan declines, providers, and transaction references (RRN / provider order id)
Payment MethodsSaved card/token hubAttach/detach, guest context, save preference; same model as method card on payment detail
Checkout SessionsCheckout session listFind hosted-checkout payments by session ID
DisputesChargeback / dispute (planned)Under construction

Billing group

SurfaceUsed forOperational value
SubscriptionsRecurring billing (planned)Under construction
InvoicesInvoice listBilling operations (secondary for payment incidents)

Providers group

SurfaceUsed forOperational value
ProvidersPlatform provider catalogWhich adapters exist
ConfigurationsAccount-scoped provider configCross-read with payment/charge for which config was selected at confirm and routing

Developers group

SurfaceUsed forOperational value
API KeysAPI key create and rotationIntegration and authorization issues
WebhooksEndpoint definitionEvent subscription configuration
Deliveries (Webhook submenu)Webhook delivery logMatch with request_id / payload on payment event sheet

Additional features group

SurfaceUsed forOperational value
Virtual TerminalManual create + confirmSandbox card, secure mode, guest/registered test; validate result on Transactions detail
Events / LogsCentral event list (planned)Under construction; live events appear on payment detail Events card

Outside the sidebar but common in operations: top bar account switcher (production / sandbox), Settings (account members, sandbox accounts).

Detail screens (not in sidebar, opened from lists)

List (sidebar item)Detail screen
TransactionsPayment hub: lifecycle, charges, routing, payment method tabs, events
ChargesCharge detail: attempt details, technical JSON, payment / PM quick link
Payment MethodsMethod detail: fingerprint, save preference, attach/detach
Checkout SessionsSession detail: token, line items, linked payment

Transactions list

The list paginates payments for the selected account. Click a row or the eye icon to open detail.

Columns: payment ID (copyable short display), amount, status, customer (email/name/ID), charge count, relations (charges / routing_plans / events summary with tooltip), created at.

List data: API call requests include_charges, include_routing_plans, include_events, include_customer with payment; charge and event counts are visible before opening detail.

Pagination: 10 / 25 / 50 / 100 rows.

Transaction detail (payment hub)

The header shows payment status and shortened ID. Cards below follow operational review order.

Summary and money

  • Hero: Amount, currency, status badge.
  • Lifecycle: Payment status (map to merchant order state).
  • Money: Authorized / captured / refunded totals from charges; compare with payment amount.

Identity and context

  • Fingerprints: Payment ID, account, checkout session ID, provider and config references (copyable); links to related charge rows.
  • Customer: Linked customer summary.
  • Checkout session: If payment has checkout_session_id, session card loads (status, token context).

Payment method (important)

The Payment Methods card shows methods used on this payment per charge attempt tab (newest attempt on top).

Typical fields per tab:

  • Card type, method ID, network badge, status
  • Resolution: network, brand, country, issuer, IIN, provider name
  • Customer context: customer_id, guest / non-guest, attach status to customer
  • Fingerprint: primary / secondary fingerprint (if present)
  • Save preference: requested, planned, affected, failed (card save plan after confirm)

If there are no charges, only payment method records; if charges exist, tabs follow charge order priority.

Provider and attempts

  • Providers / Provider configs: Summaries of providers and configs seen on charges.
  • KPI: Short metrics such as number of providers tried.
  • Charges: Per attempt: status, attempt_no, amount, error summary (if declined), provider/method name; JSON preview (side sheet) and Go to charge detail (/charges/{id}).

Routing and events

  • Routing plans: Plan ID, current_index; mini flow preview on hover; full plan in side sheet (React flow).
  • Events: Timeline; row click opens event sheet: trace_id, request_id, payment_id, charge_id, routing_plan_id, checkout_session_id, payload JSON.
  • Routing flow (full width): Tabbed interactive routing diagram when multiple plans exist (candidates, outcome nodes, charge mapping).

Other

  • Metadata: Merchant metadata JSON.

Side panels (sheet)

Panels opened from detail without leaving the page:

PanelContent
EventEvent name, tracing fields, raw payload
Routing planPlan summary + mini flow
ChargeShort charge summary; button to full page

Charges list

All charge attempts in account scope.

Columns: charge ID, amount, status, payment ID (shortened), transaction reference (provider_order_id or rrn from transaction; no flat transaction_id field), provider name, created at.

Row click opens charge detail.

Charge detail

API: rich detail with include_attempt_details=true.

Cards:

CardPurpose
HeroStatus, amount, ID
AmountsAuthorized / captured / refunded breakdown
Routingrouting_plan_id, routing_origin, attempt_no
Quick linksRelated payment (/transactions/{payment_id}) and payment method (/payment-methods/{id})
Provider IDsProvider and method identifiers
SnapshotSummary attempt snapshot
Networktransaction subset (RRN, provider order id, etc.)
SecurityMasked security subset
OutcomeDecline / error summary
Attempt detailsAdapter attempt details (if present)
Technicaldetails, exchanges, metadata, performance JSON blocks

For decline or REQUIRES_ACTION analysis, this screen goes deeper than the charge list on payment detail.

Payment Methods list

Saved payment methods on the account (card tokens, guest checkout methods, etc.).

List columns: ID, type, network, customer ID, guest/non-guest badge, status, save preference summary (planned / affected), created at.

Row actions (conditional):

  • Attach: When ACTIVE, not guest, and no customer: dialog to attach to customer
  • Detach: When linked to customer: detach confirmation
  • Attach/detach disabled for guest or inactive methods

Detail screen:

  • Basics: type, category, network, status, issuer, country
  • Customer context + attach/detach buttons (same rules as list)
  • Fingerprint primary / secondary
  • Save preference flags
  • Raw metadata JSON

Same data model as method tabs on payment detail; hub screen manages all account methods.

  1. Open detail by payment ID from sidebar Transactions.
  2. Check merchant state expectation with Lifecycle and Money.
  3. On Charges card: how many attempts, which status (especially DECLINED).
  4. On Payment Methods tabs: which card/network/issuer was tried.
  5. Use Routing + Routing flow to see if fallback happened.
  6. Take request_id / trace_id from Events; match with webhook log.
  7. If needed, drill into Charges detail (charge row or sidebar).
  8. If checkout-sourced, verify Checkout session card.

Redirect or Virtual Terminal result alone is not proof; close with status on these screens and webhook.

Sandbox account selection

The top bar account picker switches between production and linked sandbox accounts. Transactions, Charges, and Payment Methods lists show data for the selected account; sandbox outcome is not a live financial guarantee.

Team focus areas

TeamLook here first
SupportTransaction detail: lifecycle + customer + metadata
OperationsTransaction detail charges + routing flow; Charge detail decline
EngineeringEvent sheet (trace/request) + charge technical JSON
Risk / fraudPayment Methods + transaction detail PM tabs (guest, fingerprint)

On this page