API docs by Redocly

External - API (2.0.0)

Download OpenAPI specification:

External - API

Benefits

Operations to manage benefits

Get a list of benefits

Get a paginated list of current and upcoming active benefits.

Authorizations:
api_key
query Parameters
lang
string
Default: "de"
Enum: "de" "en" "fr" "hu"
Example: lang=de

Choose the language in which to get the benefits.

types
Array of strings
Items Enum: "TEAM" "GUEST"
Example: types=TEAM

Get only benefits for the given cardholder types. If not provided, the default card holder type as configured in the backend is used.

offset
integer <int32>
Default: 0
Example: offset=11

First record to return (zero-based). Ordered by id.

limit
integer <int32>
Example: limit=10

Limit the number of returned records

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": [
    ]
}

BenefitRedemptions

Operations to manage redemptions

Redeem a benefit

Redeem a benefit

Authorizations:
api_key
Request Body schema: application/json; charset=utf-8
required
redemptionTime
required
string <dd-MM-yyyy HH:mm:ss>
benefitId
integer <int64>
useFirst
boolean
Default: false
externalRef
string <= 200 characters
required
object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "redemptionTime": "22-08-2024 11:11:01",
  • "benefitId": 1234,
  • "useFirst": false,
  • "externalRef": "Drehkreuz-15",
  • "qrCode": {
    }
}

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

Partners

Get a partner

Get the partner referenced by the given id.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
Example: 1234
query Parameters
lang
string
Default: "de"
Enum: "de" "en" "fr" "hu"
Example: lang=de

Choose the language in which to get the benefits.

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}