Get specific redemption redeem

Request

Get current status of a specific redemption redeem with automatic access control based on authentication context. Optionally include related entities (redemption, user, business, transactions).

Security

projectKey or authJWT

Path

redeemIdstringrequired

Query

includeArray of strings

Include related entities: redemption, user, business, transactions (comma-separated)

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/redemptions/redeems/{redeemId}?include=string' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption redeem retrieved successfully

Bodyapplication/json

idstringrequired

The id of the redemption user redeem

userIdstringrequired

The user id that is claiming the redemption

redemptionIdstringrequired

The redemption that the user is redeeming

userCountryCodestring or nullrequired

The country code of the user redeeming the redemption

statusstringrequired

The status of the redemption redeem

Default:"PENDING"

Enum:"PENDING""PROCESSING""COMPLETED""FAILED"

createdAtstring or null, (date-time)required

The date and time when processing of the redemption redeem started

updatedAtstring or null, (date-time)required

The date and time when processing of the redemption redeem was last updated

messagestring or nullrequired

Message regarding the redemption status (failure reason, success info, etc.)

dataSourceobject or null

Analytics tracking: source/channel of this redeem action

Example:

{
  "channel": "mobile",
  "medium": "referral",
  "campaign": "summer_promo"
}

includedobject or null

Included related entities. Only populated when include parameter is specified. Contains redemption, user, business, and/or transactions entities based on requested relations.

Response

{
  "id": "string",
  "userId": "string",
  "redemptionId": "string",
  "userCountryCode": "string",
  "status": "PENDING",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "message": "string",
  "dataSource": {
    "channel": "mobile",
    "medium": "referral",
    "campaign": "summer_promo"
  },
  "included": {
    "redemption": { … },
    "user": { … },
    "business": { … },
    "transactions": [ … ]
  }
}