API Reference

کیف پول

موجودی قابل استفاده برای سفارش‌های API و تاریخچه تراکنش‌های حساب را دریافت کنید.

GET/api/v1/wallet/balance

دریافت موجودی

موجودی فعلی کیف پول متصل به API Key و واحد اعلام‌شده توسط سرویس را برمی‌گرداند.

نیازمند API Key

نمونه داده

پاسخ موفق

Responsejson

{
  "status": "success",
  "code": 200,
  "data": {
    "balance": 850000,
    "currency": "IRR"
  }
}

GET/api/v1/wallet/transactions

دریافت تراکنش‌ها

تراکنش‌های کیف پول را از جدیدترین مورد، با فیلتر نوع و بازه تاریخ برمی‌گرداند.

نیازمند API Key

پارامترها

5 مورد

نام	نوع	الزام	توضیحات
`page`	number	اختیاری	شماره صفحه؛ مقدار پیش‌فرض ۱ است.
`pageSize`	number	اختیاری	تعداد تراکنش در هر صفحه؛ مقدار پیش‌فرض ۱۰ است.
`type`	string	اختیاری	یکی از PAYMENT، RECHARGE یا REFUND.
`dateFrom`	string	اختیاری	تاریخ شروع با فرمت YYYY-MM-DD.
`dateTo`	string	اختیاری	تاریخ پایان با فرمت YYYY-MM-DD؛ شامل کل روز.

page: numberاختیاری; شماره صفحه؛ مقدار پیش‌فرض ۱ است.
pageSize: numberاختیاری; تعداد تراکنش در هر صفحه؛ مقدار پیش‌فرض ۱۰ است.
type: stringاختیاری; یکی از PAYMENT، RECHARGE یا REFUND.
dateFrom: stringاختیاری; تاریخ شروع با فرمت YYYY-MM-DD.
dateTo: stringاختیاری; تاریخ پایان با فرمت YYYY-MM-DD؛ شامل کل روز.

نمونه داده

پاسخ موفق

Responsejson

{
  "status": "success",
  "code": 200,
  "data": [
    {
      "id": 12345,
      "amount": 490000,
      "type": "PAYMENT",
      "method": "WALLET",
      "status": "SUCCESS",
      "metadata": {
        "orderId": "A1234567",
        "paymentDate": "2026-07-24T08:30:00.000Z",
        "api": true
      },
      "createdAt": "2026-07-24T08:30:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "page": 1,
      "pageSize": 10,
      "totalPages": 1
    }
  }
}

GET/api/v1/wallet/transactions/:id

دریافت جزئیات تراکنش

جزئیات یک تراکنش متعلق به همان حساب API را با شناسه عددی برمی‌گرداند.

نیازمند API Key

پارامترها

1 مورد

نام	نوع	الزام	توضیحات
`id`	number	الزامی	شناسه عددی تراکنش.

id: numberالزامی; شناسه عددی تراکنش.

نمونه داده

پاسخ موفق

Responsejson

{
  "status": "success",
  "code": 200,
  "data": {
    "id": 12345,
    "amount": 490000,
    "type": "PAYMENT",
    "method": "WALLET",
    "status": "SUCCESS",
    "transactionHash": null,
    "trans_id": "API_PAY_A7654321",
    "metadata": {
      "orderId": "A1234567",
      "paymentDate": "2026-07-24T08:30:00.000Z",
      "api": true
    },
    "createdAt": "2026-07-24T08:30:00.000Z",
    "updatedAt": "2026-07-24T08:30:00.000Z"
  }
}