Update redemption order status
PUT
/v1/redemption-transactions/status
How to use it: Send a PUT request to
/v1/redemption-transactions/status with the request body, query parameters, or multipart fields shown below. Authorization: Bearer <apiKey>. The key must be active, unexpired, scoped to the correct community, and include the permission required by this endpoint.Required permission:
updateRedemptionTransactionStatus for PUT or createRedemptionStatus for POST.Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under
data with status and message.Common error states:
400 invalid request body, query, ObjectId, pagination, file format, or missing required field.401 missing, invalid, expired, or insufficient API key/token.403 key is valid but cannot access this community/channel/user/resource, where supported by the service.404 target resource, route, or community-scoped record was not found.409 duplicate or conflicting state for create/update operations, where applicable.500 unexpected Returning.AI service error.Redemption endpoints support fulfillment workflows. Treat status changes as operational state transitions and confirm refund/coin behavior before automating production updates. Internal integration notes confirm
statusId is the camelCase field used for redemption status updates.Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.returning.ai/v1/redemption-transactions/status' \
--header 'Content-Type: application/json' \
--data '{
"transactionId": "ORD202507013831",
"statusID": "695dcc370ab8622381f27918",
"refundCoins": false
}'Response Response Example
200 - Success Example
{
"status": "success",
"message": "Transaction status updated successfully",
"data": {
"transactionId": "ORD20260102ffc6",
"statusId": "695e2f8b3358520a2ecf86e4",
"status": {
"_id": "695e2f8b3358520a2ecf86e4",
"name": "Shipping",
"category": "incomplete",
"color": "#3EA1FD"
}
}
}Modified at 2026-05-18 17:03:37