استعلام
وضعیت پرداخت با شناسه یا شناسه سفارش.
برای دریافت آخرین وضعیت یک پرداخت (مثلاً اگر callback به سرور شما نرسید) از استعلام استفاده کنید.
GET/api/v1/payments/{id}
GET/api/v1/payments?merchant_reference=ORDER-1042-1
merchant_reference در هر درگاه و حالت یکتاست و استعلام با آن تطبیق دقیق است (حداکثر یک نتیجه). اگر مشتری پس از پرداخت ناموفق دوباره تلاش کند، برای تلاش جدید شناسهای با پسوند بسازید (ORDER-1042-2) و هر تلاش را جداگانه استعلام کنید.
bash
# با شناسه پرداخت
curl https://api.sheypay.ir/api/v1/payments/PAYMENT_ID \
-H "Authorization: Bearer sk_test_YOUR_KEY"
# با شناسه سفارش خودتان
curl "https://api.sheypay.ir/api/v1/payments?merchant_reference=ORDER-1042-1" \
-H "Authorization: Bearer sk_test_YOUR_KEY"فهرست پرداختها
GET/api/v1/payments?status=verified&from=…&to=…&limit=20&cursor=…
پارامترهای فهرست
| نام | نوع | توضیح |
|---|---|---|
status | string | فیلتر وضعیت. |
from / to | ISO 8601 | بازه زمان ایجاد. |
limit | 1–100 | تعداد در هر صفحه (پیشفرض ۲۰). |
cursor | string | مقدار next_cursor پاسخ قبلی برای صفحه بعد. |
پاسخ: { "data": [ …payments ], "next_cursor": "…" | null }
خط زمانی پرداخت
GET/api/v1/payments/{id}/events
همه رویدادهای یک پرداخت (ایجاد، هدایت به بانک، دریافت callback، تأیید، ثبت در دفتر کل، تسویه و …) را به ترتیب زمان برمیگرداند.