Get redemption status by ID
POST
/v1/redemption-transactions/status/detail
What this endpoint does
INFO
Quick start
Authentication and permission
| Send | Permission | Community scope |
|---|---|---|
Authorization: Bearer <apiKey> | readRedemptionStatuses | The legacy body currently includes communityId. It must match the API-key community; a mismatch returns 403 without data. |
Complete examples
{
"id": "sts_refunded",
"communityId": "65f000000000000000000001"
}Success and readback
code = REDEMPTION_STATUS_RETRIEVED{
"status": "success",
"code": "REDEMPTION_STATUS_RETRIEVED",
"message": "Get redemption status by ID successfully",
"data": {
"_id": "sts_refunded",
"name": "Refunded",
"category": "refunded",
"color": "#EB5757",
"order": 0,
"isDefault": true
}
}CHECK
Errors and recovery
code, never message text.| HTTP | Machine code | What the caller should do | Retry? |
|---|---|---|---|
| 400 | VALIDATION_FAILED | Repair id. | No, fix first |
| 401 | AUTHENTICATION_REQUIRED | Add the Authorization header. | No, fix first |
| 401 | AUTHENTICATION_FAILED | Authentication could not be completed. | Retry once |
| 403 | API_KEY_COMMUNITY_MISMATCH | Use the community assigned to the API key. | No, fix first |
| 404 | REDEMPTION_STATUS_NOT_FOUND | Refresh the status list. | After refreshing the ID |
| 500 | INTERNAL_ERROR | Retry with exponential backoff and the same request context, then escalate. | Yes, with backoff |
Retry safety
TIP
Gotchas
Next steps
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v1/redemption-transactions/status/detail' \
--header 'Content-Type: application/json' \
--data '{
"id": "665a1b2c3d4e5f6a7b8c9d0e",
"communityId": "665a1b2c3d4e5f6a7b8c9d0f"
}'Response Response Example
200 - Success Example
{
"status": "success",
"message": "Redemption status fetched successfully",
"data": {
"_id": "665a1b2c3d4e5f6a7b8c9d0e",
"name": "Pending Review",
"category": "new_purchase",
"color": "#808080",
"order": 0,
"isDefault": true
}
}Modified at 2026-08-08 01:52:08