Skip to main content

​
Dashboard Guides

Dashboard documentation should be written for operators first. Each guide should explain what the operator does, what PayChain does next, and what success looks like.
Operator-first rule: Dashboard docs should avoid starting with API details. Explain the user action, expected result, and what to check if something looks wrong. For step-by-step operating flows, see Dashboard walkthroughs.

​
Pages to document

  • Home dashboard.
  • Invoices.
  • Customers.
  • Transactions.
  • Balances.
  • Withdrawals.
  • Payout routes.
  • Webhooks.
  • Billing and usage.
  • Settings and API keys.

​
Suggested pattern

Reusable page pattern: “Before you begin” + “Steps” + “Expected result” + “Common mistakes” + “Related developer reference” keeps operator docs easy to scan.
  1. Before you begin.
  2. Step-by-step action.
  3. Expected result.
  4. Common mistakes.
  5. Related API or SDK section for developers.

​
Operator notes to include

  • Creating an invoice from the dashboard is the safest path for small exact payments.
  • Payout routes are approved templates for repeat split patterns.
  • Dynamic payout recipients are for one-time receivers, such as on/off-ramp or marketplace orders.
  • Gas credit exhaustion does not stop receiving payments.
  • Webhook test events are not real payments.
  • Standard API keys cannot create withdrawals.
Support note: If a dashboard action can move funds, change billing, rotate secrets, or affect live payment collection, label it clearly and explain whether it is reversible.