# Get redemption status by ID

Read one active redemption order status in your community by its ID, with its name, category and colour.

- Endpoint: `POST https://api.returning.ai/v1/redemption-transactions/status/detail`
- Section: Store and rewards / Rewards and redemptions
- Authentication: `Authorization: Bearer <API_KEY>` (Community API key)
- Permission: `getRedemptionStatusById` (Shown in the dashboard as "Get Redemption Status By ID")
- Retries: Read-only; exact retries are safe
- Guide: hand-written
- Verified: live, 2026-09-27
- Last updated: 26 Sep 2026
- Web page: https://docs.returning.ai/api-reference/rewards-and-redemptions/get-redemption-status-by-id

## When to use this

- An order shows a `statusID` you don't recognise, and you want its name and category.
- Check that a status is still switched on before you move orders to it.
- Confirm whether a status is in the refunded category before you send a coin refund.

**Instead:** Use [List redemption statuses](https://docs.returning.ai/api-reference/rewards-and-redemptions/list-redemption-statuses.md) instead to get every active status in one call, grouped by category.

**Community ID:** The body must carry your own community ID. Any other ID returns `403 API_KEY_COMMUNITY_MISMATCH`.

## Authentication

- Header: `Authorization: Bearer <API_KEY>`
- Permission: `getRedemptionStatusById`

Use a Community API key with `getRedemptionStatusById`, and keep it on your server. This permission is separate from `getRedemptionStatuses`, which List redemption statuses needs. The key decides the community. The body must still name that same community in `communityId`; any other ID is rejected with `403`.

## Behaviour

Only active statuses are returned. A status your team has switched off in the dashboard returns `404`, the same as an ID that doesn't exist, and orders can't be moved to it.

## Request

### Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Authorization` | `string` | Yes | Community API key with `getRedemptionStatusById`. (`Bearer <API_KEY>`) |
| `Content-Type` | `string` | Yes | Request body format. (`application/json`) |

### Body

Send both `id` and `communityId` as JSON strings. If you don't have your community ID yet, read `serverId` from any order in the order lists. Other fields are ignored.

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The status ID, from List redemption statuses or the `statusID` on an order. (24-character hex ID) |
| `communityId` | `string` | Yes | The ID of the community your API key belongs to. It is the `serverId` on every order. (24-character community ID; must match your key) |

### Example request

```bash
curl --request POST \
  --url https://api.returning.ai/v1/redemption-transactions/status/detail \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "66f000000000000000000402",
    "communityId": "66f000000000000000000010"
  }'
```

## Response

A `200` returns the status in `data`, with the same fields as each entry in List redemption statuses.

### Response fields

| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| `status` | `string` | always | Result of the request. (`success`) |
| `code` | `string` | always | Machine-readable result code. (`REDEMPTION_STATUS_RETRIEVED`) |
| `message` | `string` | always | Human-readable summary. Do not branch on it. |
| `data` | `object` | always | The status. |
| `data._id` | `string` | always | Status ID. Send it as `statusID` to Update redemption order status. |
| `data.name` | `string` | always | Status name, such as `Refunded`. Orders show it as their `status`. |
| `data.category` | `string` | always | The status category. (`new_purchase`, `in_progress`, `completed` or `refunded`) |
| `data.color` | `string` | always | Display colour, a hex code such as `#EB5757`. |
| `data.order` | `number` | always | Sort position within its category. Lower numbers come first. |
| `data.isDefault` | `boolean` | always | `true` for the category's default status. |

### Example response (200)

```json
{
  "status": "success",
  "code": "REDEMPTION_STATUS_RETRIEVED",
  "message": "Redemption status fetched successfully",
  "data": {
    "_id": "66f000000000000000000402",
    "name": "Refunded",
    "category": "refunded",
    "color": "#EB5757",
    "order": 0,
    "isDefault": true
  }
}
```

## Errors

401 and 403 responses, and the authentication errors `404 COMMUNITY_NOT_FOUND` and `500 AUTHENTICATION_FAILED`, carry the code in `meta.code`; every other error carries it in `code`. Branch on the HTTP status and `code`, never on `message`.

### Fix the request

| Status | Code | What to do |
| --- | --- | --- |
| 400 | `VALIDATION_FAILED` | `id` or `communityId` is missing, isn't a string, or isn't a 24-character ID. A missing or non-string value has `detail` naming the field; a bad format has `message: Invalid status ID format` or `Invalid community ID format`. |
| 401 | `AUTHENTICATION_REQUIRED` | The key is missing, invalid or expired. Send `Authorization: Bearer <API_KEY>` with a current Community API key. |
| 403 | `API_KEY_PERMISSION_DENIED` | The key lacks `getRedemptionStatusById`, or it is a personal key. Use a Community API key and add the permission in Settings > Integration > API Keys. |
| 403 | `API_KEY_COMMUNITY_MISMATCH` | `communityId` isn't the community your key belongs to, so nothing was read. Send your own community ID. |

### Fix the data

| Status | Code | What to do |
| --- | --- | --- |
| 404 | `REDEMPTION_STATUS_NOT_FOUND` | No active status with this ID in your community. It may be switched off, deleted, or belong to another community. Get current IDs from List redemption statuses. |
| 404 | `COMMUNITY_NOT_FOUND` | The community this key belongs to no longer exists. Contact Returning.AI support. |

### Retry with backoff

| Status | Code | What to do |
| --- | --- | --- |
| 500 | `INTERNAL_ERROR` | The status could not be read. Retry the same request with exponential backoff. |
| 500 | `AUTHENTICATION_FAILED` | The key could not be checked. Retry with backoff; nothing was read. |

**Retries:** This endpoint is read-only, so retrying the exact same request is safe after a network error or a 5xx. Use bounded exponential backoff. Over the [rate limit](https://docs.returning.ai/how-it-works.md#rate-limits), requests return `429`; wait for the window to reset, then retry.

## Next step

- [Update redemption order status](https://docs.returning.ai/api-reference/rewards-and-redemptions/update-redemption-order-status.md): `PUT /v1/redemption-transactions/status`. Move an order to this status, sending its `_id` as `statusID`.
- [See every status with List redemption statuses](https://docs.returning.ai/api-reference/rewards-and-redemptions/list-redemption-statuses.md): `POST /v1/redemption-transactions/statuses`.