List redemptions

curl --request GET \
  --url https://api.voucher-staging.allride.io/consumer/v1/redemptions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.voucher-staging.allride.io/consumer/v1/redemptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.voucher-staging.allride.io/consumer/v1/redemptions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/consumer/v1/redemptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voucher-staging.allride.io/consumer/v1/redemptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "data": [
      {
        "id": 6017,
        "resource": "redemption",
        "status": "completed",
        "channel": "api",
        "providerPartnerId": 1030,
        "voucherSetId": 2030,
        "voucherSetRevisionNo": 2,
        "voucherId": 5017,
        "voucherSet": {
          "id": 2030,
          "name": {
            "de": "5 € Fahrguthaben",
            "en": "€5 ride credit"
          },
          "providerDisplayName": {
            "de": "Acme Scooters",
            "en": "Acme Scooters"
          }
        },
        "issued": {
          "kind": "code",
          "code": "ACME5-7KQ2-M9XA",
          "link": "https://acme-scooters.example.com/r?c=ACME5-7KQ2-M9XA"
        },
        "validFrom": null,
        "validUntil": "2026-12-31T22:59:59Z",
        "redemptionEntity": {
          "id": 9017,
          "resource": "redemption-entity",
          "refId": "customer:48213",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
              "type": "application/json"
            }
          }
        },
        "redemptionLink": null,
        "batchId": null,
        "metadata": {
          "redemptionReason": "standard",
          "forMonth": "2026-10"
        },
        "actor": {
          "type": "api-key",
          "id": 12017,
          "label": "Production integration"
        },
        "idempotencyKey": "order-8812:line-1",
        "legacyRef": null,
        "redeemedAt": "2026-10-21T17:42:10.120Z",
        "voidedAt": null,
        "voidedBy": null,
        "voidReason": null,
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemptions/6017",
            "type": "application/json"
          },
          "voucherSet": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
            "type": "application/json"
          },
          "redemptionEntity": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
            "type": "application/json"
          }
        }
      }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "total": 1
  }
}

GET

consumer

redemptions

List redemptions

curl --request GET \
  --url https://api.voucher-staging.allride.io/consumer/v1/redemptions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.voucher-staging.allride.io/consumer/v1/redemptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.voucher-staging.allride.io/consumer/v1/redemptions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/consumer/v1/redemptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voucher-staging.allride.io/consumer/v1/redemptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "data": [
      {
        "id": 6017,
        "resource": "redemption",
        "status": "completed",
        "channel": "api",
        "providerPartnerId": 1030,
        "voucherSetId": 2030,
        "voucherSetRevisionNo": 2,
        "voucherId": 5017,
        "voucherSet": {
          "id": 2030,
          "name": {
            "de": "5 € Fahrguthaben",
            "en": "€5 ride credit"
          },
          "providerDisplayName": {
            "de": "Acme Scooters",
            "en": "Acme Scooters"
          }
        },
        "issued": {
          "kind": "code",
          "code": "ACME5-7KQ2-M9XA",
          "link": "https://acme-scooters.example.com/r?c=ACME5-7KQ2-M9XA"
        },
        "validFrom": null,
        "validUntil": "2026-12-31T22:59:59Z",
        "redemptionEntity": {
          "id": 9017,
          "resource": "redemption-entity",
          "refId": "customer:48213",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
              "type": "application/json"
            }
          }
        },
        "redemptionLink": null,
        "batchId": null,
        "metadata": {
          "redemptionReason": "standard",
          "forMonth": "2026-10"
        },
        "actor": {
          "type": "api-key",
          "id": 12017,
          "label": "Production integration"
        },
        "idempotencyKey": "order-8812:line-1",
        "legacyRef": null,
        "redeemedAt": "2026-10-21T17:42:10.120Z",
        "voidedAt": null,
        "voidedBy": null,
        "voidReason": null,
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemptions/6017",
            "type": "application/json"
          },
          "voucherSet": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
            "type": "application/json"
          },
          "redemptionEntity": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
            "type": "application/json"
          }
        }
      }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "total": 1
  }
}

Authorizations

Authorization

string

header

required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

page

integer

default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000

perPage

integer

default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100

sort

string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: redeemedAt, voucherSetId, status. Default -redeemedAt. The server appends id as a tie-breaker.

Example:

"-redeemedAt"

string

Case-insensitive search (at most 255 characters) over redemptionEntity.refId, idempotencyKey.

Maximum string length: 255

filter[status]

enum<string>

Status (equals).

Available options:

completed,

voided

filter[status][ne]

enum<string>

Status (not equal).

Available options:

completed,

voided

filter[status][in]

string

Status (one of (comma-separated)). Comma-separated values.

filter[channel]

enum<string>

Channel (equals).

Available options:

api,

dashboard,

redemption-link,

import

filter[channel][in]

string

Channel (one of (comma-separated)). Comma-separated values.

filter[providerPartnerId]

integer

Provider id (equals).

Required range: x >= 0

filter[providerPartnerId][in]

string

Provider id (one of (comma-separated)). Comma-separated values.

filter[voucherSetId]

integer

Voucher set id (equals).

Required range: x >= 0

filter[voucherSetId][in]

string

Voucher set id (one of (comma-separated)). Comma-separated values.

filter[redemptionEntityId]

integer

Redemption entity id (equals).

Required range: x >= 0

filter[redemptionEntityId][in]

string

Redemption entity id (one of (comma-separated)). Comma-separated values.

filter[redemptionEntityId][isNull]

boolean

Redemption entity id (is null (true/false)).

filter[redemptionEntity.refId]

string

refId of the entity (equals).

filter[redemptionEntity.refId][in]

string

refId of the entity (one of (comma-separated)). Comma-separated values.

filter[redemptionEntity.refId][startsWith]

string

refId of the entity (starts with).

filter[redemptionLinkId]

integer

Redemption Link id (equals).

Required range: x >= 0

filter[redemptionLinkId][in]

string

Redemption Link id (one of (comma-separated)). Comma-separated values.

filter[redemptionLinkId][isNull]

boolean

Redemption Link id (is null (true/false)).

filter[batchId]

integer

Batch id (equals).

Required range: x >= 0

filter[idempotencyKey]

string

Idempotency key of the request (equals).

filter[redeemedAt][gte]

string<date-time>

Redemption time (greater than or equal).

filter[redeemedAt][gt]

string<date-time>

Redemption time (greater than).

filter[redeemedAt][lt]

string<date-time>

Redemption time (less than).

filter[redeemedAt][lte]

string<date-time>

Redemption time (less than or equal).

filter[voidedAt][gte]

string<date-time>

Void time (greater than or equal).

filter[voidedAt][gt]

string<date-time>

Void time (greater than).

filter[voidedAt][lt]

string<date-time>

Void time (less than).

filter[voidedAt][lte]

string<date-time>

Void time (less than or equal).

Response

Page envelope of Redemption items.

data

object

required

The page.

Show child attributes

Consumer API

Workspace API

List redemptions

Authorizations

Query Parameters

Response