مستندات وبسرویس
(v1.0)اندپوینتهای کیف پول
از اندپوینتهای کیف پول برای مدیریت موجودی و مشاهده تراکنشهای کیف پول خود استفاده کنید. توجه داشته باشید که تمام سفارشها به طور خودکار از موجودی کیف پول شما پرداخت میشوند.
دریافت موجودی کیف پول/api/v1/wallet/balance
GET
/api/v1/wallet/balance
GETبا استفاده از این اندپوینت، میتوانید موجودی فعلی کیف پول خود را مشاهده کنید.
مثال پاسخ
{
"status": "success",
"code": 200,
"data": {
"balance": 850000,
"currency": "IRR"
}
}
دریافت تاریخچه تراکنشها/api/v1/wallet/transactions
GET
/api/v1/wallet/transactions
GETاین اندپوینت لیست تمام تراکنشهای کیف پول شما را با امکان فیلترکردن و صفحهبندی ارائه میدهد.
پارامترها
نام | نوع | ضروری | توضیحات |
---|---|---|---|
page | number | خیر | شماره صفحه (پیشفرض: 1) |
pageSize | number | خیر | تعداد تراکنشها در هر صفحه (پیشفرض: 10) |
type | string | خیر | فیلتر براساس نوع تراکنش (PAYMENT، RECHARGE) |
dateFrom | string | خیر | فیلتر بر اساس تاریخ شروع (فرمت: YYYY-MM-DD) |
dateTo | string | خیر | فیلتر بر اساس تاریخ پایان (فرمت: YYYY-MM-DD) |
مثال پاسخ
{
"status": "success",
"code": 200,
"data": [
{
"id": 12345,
"amount": 490000,
"type": "PAYMENT",
"method": "WALLET",
"status": "SUCCESS",
"metadata": {
"orderId": "1234567",
"paymentDate": "2023-05-15T10:30:45Z",
"api": true
},
"createdAt": "2023-05-15T10:30:45Z"
},
{
"id": 12344,
"amount": 1000000,
"type": "RECHARGE",
"method": "GATEWAY",
"status": "SUCCESS",
"metadata": {
"gatewayName": "ZibalPay",
"trackId": "789456123"
},
"createdAt": "2023-05-10T14:22:30Z"
}
],
"meta": {
"pagination": {
"total": 8,
"page": 1,
"pageSize": 10,
"totalPages": 1
}
}
}
دریافت جزئیات تراکنش/api/v1/wallet/transactions/:id
GET
/api/v1/wallet/transactions/:id
GETاین اندپوینت جزئیات کامل یک تراکنش خاص را بر اساس شناسه آن ارائه میدهد.
پارامترها
نام | نوع | ضروری | توضیحات |
---|---|---|---|
id | number | بله | شناسه تراکنش |
مثال پاسخ
{
"status": "success",
"code": 200,
"data": {
"id": 12345,
"amount": 490000,
"type": "PAYMENT",
"method": "WALLET",
"status": "SUCCESS",
"transactionHash": null,
"trans_id": "API_PAY_1234567",
"metadata": {
"orderId": "1234567",
"paymentDate": "2023-05-15T10:30:45Z",
"api": true
},
"createdAt": "2023-05-15T10:30:45Z",
"updatedAt": "2023-05-15T10:30:45Z"
}
}
نکات مهم
- برای شارژ کیف پول، باید از طریق پنل کاربری در وبسایت اقدام کنید.
- تمام مبالغ به تومان هستند.
- تراکنشهای با نوع
PAYMENT
نشاندهنده خرید و تراکنشهای با نوعRECHARGE
نشاندهنده شارژ کیف پول هستند. - برای پیشگیری از کمبود موجودی، میتوانید اعلانهای کمبود موجودی را در پنل کاربری خود فعال کنید.