پرش به مطلب اصلی

مرجع API داشبورد

مرجع کامل اندپوینت API داشبورد. از آن برای نمایش خلاصه لینک‌های پرداخت، intentها، تراکنش‌ها و موجودی‌های فروشنده استفاده کنید.

آدرس پایه​

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

دریافت خلاصه داشبورد​

خلاصه داشبورد کاربر احراز هویت‌شده را بگیرید: مجموع‌ها (لینک‌ها، intentها، تراکنش‌ها، USDC کسب‌شده/برداشت‌شده/باقی‌مانده)، سری حجم و تراکنش‌های اخیر.

GET /dashboard/summary

احراز هویت​

  • توکن Bearer (JWT) — الزامی

پاسخ​

{
  "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"
    }
  ]
}

فیلدهای پاسخ​

فیلدنوعتوضیح
totals.linksnumberتعداد لینک‌های پرداخت
totals.intentsnumberتعداد payment intentها
totals.transactionsnumberتعداد تراکنش‌ها
totals.totalEarnedUsdcstringکل حجم کسب‌شده به USDC
totals.withdrawnUsdcstringکل مبلغ برداشت‌شده به USDC
totals.remainingUsdcstringموجودی باقی‌مانده به USDC
volumeSeriesarrayتعداد تراکنش‌های ماهانه (ماه به قالب YYYY-MM)
recentTransactionsarrayتراکنش‌های اخیر با لینک پرداخت و اطلاعات توکن/شبکه

کدهای وضعیت​

کد وضعیتتوضیح
200موفق
401احراز هویت نشده
500خطای داخلی سرور

همچنین ببینید​