StardDevelopersداشبورد

ارسال گیفت به یوزرنیم

POST/api/v1/gifts/send
scope: orders:writeاحراز هویت: Bearerlive و test

یک گیفت استارزی را مستقیم به یوزرنیم تلگرام بفرست، با پیام اختیاری روی گیفت. تفاوتش با POST /orders: فقط گیفت می‌پذیرد، گیرنده اجباری است و پیام گیفت فیلد مستقیم دارد. سفارش ساخته‌شده همان سفارش استاندارد است.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…
Idempotency-Keyheaderstringاختیاریکلید یکتا

بدنه (JSON)

فیلدنوعتوضیح
product_idintegerالزامیاز GET /gifts
recipientstringالزامی@username گیرنده
messagestringاختیاریپیام روی گیفت، حداکثر ۲۰۰ کاراکتر
message_entitiesarrayاختیاریentities تلگرام برای پیام (bold، custom_emoji و…)
hide_senderbooleanاختیاریفرستنده‌ی مخفی (+۲٬۰۰۰ تومان)
scheduled_atstringاختیاریزمان ارسال برنامه‌ریزی‌شده (ISO 8601)
pay_currencystringاختیاریTON یا IRT
quote_idstringاختیاریاز POST /orders/quote با type=product
metadataobjectاختیاریداده‌ی دلخواه

نمونه

curl -X POST "https://stard-market.ir/api/v1/gifts/send" \
  -H "Authorization: Bearer $STARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_id": 12, "recipient": "@username", "message": "تولدت مبارک 🎉"}'
پاسخ — 201
{
  "object": "order",
  "id": "ord_test_znAt8QplAwwQImWM",
  "order_id": null,
  "environment": "test",
  "status": "pending",
  "raw_status": "pending",
  "title": "کادو (test)",
  "product_id": 12577,
  "product_tag": null,
  "type": "gift",
  "quantity": 1,
  "recipient": "@username",
  "amount": {
    "amount": 112275,
    "currency": "IRT"
  },
  "paid": {
    "amount": 112275,
    "currency": "IRT"
  },
  "failure_reason": null,
  "metadata": {},
  "created_at": "2026-10-02T17:43:23Z",
  "updated_at": "2026-10-02T17:43:23Z"
}
هدرهای پاسخ
content-type: application/json
x-request-id: req_XhAAu3bzRaDHeDIToYdd
x-ratelimit-limit: 1000
x-ratelimit-remaining: 989

خطاها

HTTPcodeکی
400not_a_giftاین product_id گیفت استارزی نیست
400recipient_invalidیوزرنیم گیرنده نامعتبر
402insufficient_fundsموجودی کیف پول API (یا موجودی آزمایشی) کافی نیست
400quote_invalid / quote_mismatchquote_id نامعتبر یا مال سفارش دیگری است
409quote_expiredمهلت پیش‌قیمت (۲ دقیقه) تمام شده
409price_changedقیمت از مبلغ پیش‌قیمت بالاتر رفته؛ پولی کسر نشده
403insufficient_scopeکلید scope orders:write را ندارد
401invalid_api_key / missing_api_key / api_key_revoked / api_key_expiredکلید نیامده، نامعتبر، باطل یا منقضی است
429rate_limit_exceededسقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست

محدودیت نرخ

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