StardDevelopersداشبورد

شبیه‌سازی نتیجه‌ی سفارش (test)

POST/api/v1/test/orders/{id}/simulate
scope: orders:writeاحراز هویت: Bearerlive و test

فقط با کلید sk_test_: نتیجه‌ی یک سفارش آزمایشی را تعیین کن تا کد و وب‌هوک‌هایت را برای همه‌ی حالت‌ها تست کنی. failed و refunded موجودی آزمایشی را برمی‌گردانند. بدون شبیه‌سازی، سفارش test بعد از ۱۵ ثانیه خودکار completed می‌شود.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…
idpathstringالزامیکد پیگیری سفارش (ord_… یا کد live)

بدنه (JSON)

فیلدنوعتوضیح
outcomestringالزامیprocessing، completed، failed یا refunded

نمونه

curl -X POST "https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate" \
  -H "Authorization: Bearer $STARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"outcome": "failed"}'
پاسخ — 200
{
  "object": "order",
  "id": "ord_test_etbvDNYC7E4k8vEP",
  "order_id": null,
  "environment": "test",
  "status": "failed",
  "raw_status": "failed",
  "title": "⭐ 50 استارز برای @username (test)",
  "product_id": null,
  "product_tag": null,
  "type": "stars",
  "quantity": 50,
  "recipient": "@username",
  "amount": {
    "amount": 224900,
    "currency": "IRT"
  },
  "paid": {
    "amount": 224900,
    "currency": "IRT"
  },
  "failure_reason": "simulated",
  "metadata": {},
  "created_at": "2026-10-02T17:43:25Z",
  "updated_at": "2026-10-02T17:43:25Z"
}
هدرهای پاسخ
content-type: application/json
x-request-id: req_FkPUX928OypWAvZNCRFd
x-ratelimit-limit: 1000
x-ratelimit-remaining: 975

خطاها

HTTPcodeکی
403test_onlyبا کلید live
409order_finalسفارش در وضعیت نهایی است
403insufficient_scopeکلید scope orders:write را ندارد
401invalid_api_key / missing_api_key / api_key_revoked / api_key_expiredکلید نیامده، نامعتبر، باطل یا منقضی است
429rate_limit_exceededسقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست

محدودیت نرخ

پیش‌فرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمی‌گردد — جزئیات.