Skip to content
Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.pers.ninja/_mock/swagger/

https://api.pers.ninja/v2/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Get all available redemption types for client reference. Requires valid project API key.

Security
projectKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/redemption-types \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption types retrieved

Bodyapplication/jsonArray [
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

]
Response
application/json
[ { "name": "string", "description": "string", "imageUrl": "string", "id": 0 } ]

Request

Create a new redemption type for system configuration. Replaces POST /redemption/admin/type

Security
tenantAdminJWT
Bodyapplication/jsonrequired
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/redemption-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "imageUrl": "string"
  }'

Responses

Redemption type created successfully

Bodyapplication/json
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

Response
application/json
{ "name": "string", "description": "string", "imageUrl": "string", "id": 0 }
Operations