Dashboard API Reference

Complete reference for the Dashboard API endpoint. Use this to display a summary of the merchant's payment links, intents, transactions, and balances.

Base URL

https://api.orcarail.com/api/v1

Get Dashboard Summary

Get a summary of the authenticated user's dashboard: totals (links, intents, transactions, earned/withdrawn/remaining USDC), volume series, and recent transactions.

GET /dashboard/summary

Authentication

• Bearer Token (JWT) - Required

Response

{
  "totals": {
    "links": 12,
    "intents": 8,
    "transactions": 42,
    "totalEarnedUsdc": "1250.50",
    "withdrawnUsdc": "500.0",
    "remainingUsdc": "750.5"
  },
  "volumeSeries": [
    {
      "month": "2026-01",
      "transactionCount": "42"
    },
    {
      "month": "2025-12",
      "transactionCount": "38"
    }
  ],
  "recentTransactions": [
    {
      "id": 101,
      "status": "confirmed",
      "amount": "0.25",
      "amountReceived": "0.25",
      "createdAt": "2026-01-22T10:45:12.123Z",
      "paymentLinkTitle": "Subscription January",
      "paymentLinkSlug": "550e8400e29b41d4a716446655440000",
      "tokenSymbol": "USDC",
      "networkName": "Ethereum",
      "payerTokenSymbol": "ETH",
      "payerAmount": "0.0012"
    }
  ]
}

Response Fields

Field	Type	Description
totals.links	number	Number of payment links
totals.intents	number	Number of payment intents
totals.transactions	number	Number of transactions
totals.totalEarnedUsdc	string	Total earned volume in USDC
totals.withdrawnUsdc	string	Total withdrawn in USDC
totals.remainingUsdc	string	Remaining balance in USDC
volumeSeries	array	Monthly transaction counts (month in YYYY-MM)
recentTransactions	array	Recent transactions with payment link and token/network info

Status Codes

Status Code	Description
200	Success
401	Unauthorized
500	Internal Server Error

See Also

• Payments - Payment links and transactions
• Withdrawals - Withdrawal settings and requests