Get redemption transaction detail
Developing
GET
/v2/redemption-transactions/{redemptionID}
What this endpoint does
INFO
Quick start
Authentication and permission
| Send | Permission | Community scope |
|---|---|---|
Authorization: Bearer <apiKey> | customerSuccess | Community scope is derived from the key; do not send a community identifier. |
Complete examples
{pathParameter} and use the query parameters documented below.Success and readback
meta.code = REDEMPTION_TRANSACTION_RETRIEVED{
"meta": {
"status": "success",
"statusCode": 200,
"code": "REDEMPTION_TRANSACTION_RETRIEVED"
},
"message": "Get redemption transaction detail successfully",
"data": {
"_id": "hist_agent_01",
"redemptionId": "ORD202607220001",
"productName": "Agent Test Voucher",
"price": 100,
"quantity": 1,
"status": "New Purchase",
"statusID": "sts_new",
"type": "voucher",
"userId": "usr_agent_01",
"purchasedDate": "2026-07-22T02:00:00.000Z",
"userData": {
"email": "agent-test@example.invalid",
"userName": "agent-test",
"roles": [
"@all"
]
}
}
}CHECK
Errors and recovery
meta.code, never message text.| HTTP | Machine code | What the caller should do | Retry? |
|---|---|---|---|
| 400 | VALIDATION_FAILED | Use the public ORD identifier. | No, fix first |
| 401 | AUTH_API_KEY_REQUIRED | Add the Authorization header. | No, fix first |
| 401 | AUTH_API_KEY_INVALID | Replace or rotate the key. | No, fix first |
| 401 | AUTH_API_KEY_VALIDATION_FAILED | Authentication could not be completed. | Yes, with backoff |
| 403 | AUTH_PERMISSION_REQUIRED | Request the customerSuccess permission; no resource data is returned. | No, fix first |
| 404 | REDEMPTION_TRANSACTION_NOT_FOUND | Refresh the scoped order list. | After refreshing the ID |
| 500 | INTERNAL_ERROR | Retry with exponential backoff and the same request context, then escalate. | Yes, with backoff |
| 502 | REDEMPTION_DEPENDENCY_UNAVAILABLE | Retry with exponential backoff. | Yes, with backoff |
Retry safety
TIP
Gotchas
Next steps
Request
Path Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v2/redemption-transactions/ORD2026123478212' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Redemption transaction fetched successfully",
"data": {
"_id": "6a55e5cfdd7c2d5c10d2fjie912",
"redemptionId": "ORD202671473127864411",
"serverId": "69c69106d017b793c8ieijfxx",
"userId": "6a55d64cac3a8ba04ufujx8",
"rewardId": "6a2b82644b9c398129201234",
"voucherId": "6a2b82ff11c9e386b9394i2v",
"price": 500,
"quantity": 1,
"status": "Completed",
"statusID": "6a2b762d11c9e386b19223fd",
"type": "voucher",
"userInfo": {
"profile": "https://genesiv.com/img/user-avatar.png",
"username": "egname",
"name": "Example User",
"firstName": "First",
"lastName": "Last",
"email": "example@gmail.com"
},
"redemptionMethodName": "Custom Instructions",
"customFieldValues": {
"Account Number": "B123456",
"Acknowledgement": "Knowledge"
},
"purchasedDate": "2026-07-14T07:31:27.765Z",
"createdAt": "2026-07-14T07:31:27.765Z",
"updatedAt": "2026-07-14T08:07:03.381Z",
"productName": "$25 Trading Credit",
"userData": {
"email": "example@gmail.com",
"userName": "exampleuser",
"roles": [
"@all",
"@all"
]
}
}
}Modified at 2026-08-08 01:53:01