---
title: وضعیت بازپرداخت — GET /api/v1/orders/{id}/refund | Stard API
url: https://stard-market.ir/docs/reference/orders-refund-status
markdown: https://stard-market.ir/docs/reference/orders-refund-status.md
language: fa
updated: 2026-11-18
description: آیا مبلغ این سفارش برگشت داده شده و چقدر.
---

# وضعیت بازپرداخت

`GET /api/v1/orders/{id}/refund`

> آیا مبلغ این سفارش برگشت داده شده و چقدر.

## درخواست

| نام | محل | نوع |  | توضیح |
|---|---|---|---|---|
| `Authorization` | header | `string` | الزامی | `Bearer sk_live_…` یا `Bearer sk_test_…` |
| `id` | path | `string` | الزامی | کد پیگیری سفارش (ord_… یا کد live) |

## نمونه

```bash
curl "https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/refund" \
  -H "Authorization: Bearer $STARD_API_KEY"
```

```javascript
const res = await fetch("https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/refund", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.STARD_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);
```

```typescript
type StardError = { error: { type: string; code: string; message: string; param: string | null; request_id: string } };

const res = await fetch("https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/refund", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.STARD_API_KEY}`,
  },
});
if (!res.ok) {
  const { error } = (await res.json()) as StardError;
  throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const data: Record<string, unknown> = await res.json();
```

```python
import os
import requests

r = requests.get(
    "https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/refund",
    headers={
    "Authorization": f"Bearer {os.environ['STARD_API_KEY']}",
    },
    timeout=20,
)
data = r.json()
if r.status_code >= 400:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)
```

```php
<?php
$ch = curl_init("https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/refund");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("STARD_API_KEY"),
  ],
  CURLOPT_TIMEOUT => 20,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) {
  throw new RuntimeException($data["error"]["code"] . ": " . $data["error"]["message"]);
}
print_r($data);
```

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/refund", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("STARD_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(b))
}
```

**پاسخ — 200**

```json
{
  "object": "refund",
  "order_id": "ord_test_9pq3kfjbTmRLfMDR",
  "refunded": true,
  "amount": {
    "amount": 2249000,
    "currency": "IRT"
  }
}
```

**هدرهای پاسخ**

```http
content-type: application/json
x-request-id: req_o7BQtSz6FuklFTgGJiQP
x-ratelimit-limit: 1000
x-ratelimit-remaining: 995
```

## کاربرد و نکته‌ها

**کی به کار می‌آید؟** برای نمایش «پول برگشت» در پنل مشتری یا تطبیق حساب: پاسخ می‌گوید مبلغ این سفارش برگشت داده شده یا نه (`refunded`) و چقدر (`amount` به تومان، `currency: "IRT"`).

- این اندپوینت فقط می‌خواند و چیزی را تغییر نمی‌دهد؛ scope آن `orders:read` است و می‌شود با کلید فقط‌خواندنی صدایش زد.
- برگشت‌هایی که خود سیستم انجام می‌دهد (سفارش ناموفق، بخش تحویل‌نشده‌ی بوست) هم اینجا دیده می‌شوند، نه فقط بازپرداخت دستی با [`POST /refund`](https://stard-market.ir/docs/reference/orders-refund).
- به‌جای poll کردن مداوم، وب‌هوک `order.*` را فعال کن و فقط وقتی تغییری آمد این را بخوان ([وب‌هوک‌ها](https://stard-market.ir/docs/webhooks)).

## خطاها

| HTTP | code | کی |
|---|---|---|
| `404` | `order_not_found` | سفارش پیدا نشد |
| `403` | `insufficient_scope` | کلید scope `orders:read` را ندارد |
| `401` | `invalid_api_key / missing_api_key / api_key_revoked / api_key_expired` | کلید نیامده، نامعتبر، باطل یا منقضی است |
| `429` | `rate_limit_exceeded` | سقف درخواست در دقیقه پر شده؛ بعد از `Retry-After` ثانیه دوباره بفرست |

## محدودیت نرخ

پیش‌فرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای `X-RateLimit-*` برمی‌گردد — [جزئیات](https://stard-market.ir/docs/rate-limits).
