List redemption orders by custom-field identifier

Resolves a configured custom-field identifier inside the authenticated community and returns the canonical user's paginated redemption orders from the current Store purchase-history source. Use this endpoint when the integration knows a community-specific identifier such as client_id but does not have the user's email address.

Authentication:

Requires Authorization: Bearer <apiKey> with a Community API key that has the customerSuccess permission.

Community identity comes exclusively from the authenticated key. Missing or invalid credentials return 401; missing permission returns 403.

Side effects:

None. The endpoint performs identifier and Store purchase-history reads only.

Rate limits:

Standard Integration API rate limits apply.

Constraints:

identifier.key must name a configured custom field of type single-line-text or numerical; reserved id and email keys are rejected.

identifier.value must be a non-empty string or finite number. Active-identifier projection readiness and duplicate detection are enforced.

page defaults to 1. limit defaults to 10 and must be between 1 and 100.

Resolution is restricted to active users who qualify as members of the API key's community. Identifier values are not included in application logs or error details.

Related endpoints:

List redemption orders by user email — retrieves the same purchase-history shape using email.

Get redemption transaction detail — reads one redemption transaction by public order identifier.

curl --location 'https://uat-integration.returning.ai/apis/v1/redemption-transactions/by-identifier' \ --header 'Authorization: Bearer XXXXXX' \ --header 'Content-Type: application/json' \ --data '{"identifier":{"key":"client_id","value":"synthetic-client-id"},"page":1,"limit":5}'

{"status":"success","code":"REDEMPTION_TRANSACTIONS_RETRIEVED","message":"Redemption transactions fetched successfully","data":{"transactions":[{"_id":"66c000000000000000000101","redemptionId":"ORD-SYNTHETIC-20260917-001","serverId":"507f1f77bcf86cd799439011","userId":"64f000000000000000000042","rewardId":"66b000000000000000000101","voucherId":"66a000000000000000000101","price":250,"quantity":1,"status":"New Purchase","statusID":"669000000000000000000101","type":"voucher","userInfo":{"displayName":"Synthetic Customer"},"redemptionOptionType":"digital","redemptionMethodID":"method-synthetic-001","redemptionMethodName":"Email delivery","customFieldValues":{"client_id":"synthetic-client-id"},"purchasedDate":"2026-09-17T02:15:00.000Z","createdAt":"2026-09-17T02:15:00.000Z","updatedAt":"2026-09-17T02:20:00.000Z","productName":"Synthetic Reward Voucher"}],"pagination":{"total":1,"page":1,"limit":5,"totalPages":1}}}

List redemption orders by custom-field identifier

Request

Responses