Void a redemption
curl --request POST \
--url https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"voidReason": "Customer cancelled the order"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({voidReason: 'Customer cancelled the order'})
};
fetch('https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void', 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/{redemptionId}:void"
payload = { "voidReason": "Customer cancelled the order" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"voidReason\": \"Customer cancelled the order\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void"
payload := strings.NewReader("{\n \"voidReason\": \"Customer cancelled the order\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/{redemptionId}:void",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'voidReason' => 'Customer cancelled the order'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 6017,
"resource": "redemption",
"status": "voided",
"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": "2026-10-23T09:00:00Z",
"voidedBy": {
"type": "api-key",
"id": 12017,
"label": "Production integration"
},
"voidReason": "Customer cancelled the order",
"_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"
}
}
}
}Redemptions
Void a redemption
Voids a completed redemption within 30 days of redeemedAt. The voucher is never restocked; entity and link per-entity counters are decremented; an invoice already issued is not changed by the void. Sends the redemption-voided webhook and is always audited. See Voiding redemptions.
Required permissions: void-consumer-redemptions · API keys: allowed
POST
/
consumer
/
v1
/
redemptions
/
{redemptionId}
:void
Void a redemption
curl --request POST \
--url https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"voidReason": "Customer cancelled the order"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({voidReason: 'Customer cancelled the order'})
};
fetch('https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void', 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/{redemptionId}:void"
payload = { "voidReason": "Customer cancelled the order" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"voidReason\": \"Customer cancelled the order\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/consumer/v1/redemptions/{redemptionId}:void"
payload := strings.NewReader("{\n \"voidReason\": \"Customer cancelled the order\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/{redemptionId}:void",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'voidReason' => 'Customer cancelled the order'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 6017,
"resource": "redemption",
"status": "voided",
"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": "2026-10-23T09:00:00Z",
"voidedBy": {
"type": "api-key",
"id": 12017,
"label": "Production integration"
},
"voidReason": "Customer cancelled the order",
"_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"
}
}
}
}Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Path Parameters
Id of the redemption. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.
Required range:
0 <= x <= 18446744073709552000Body
application/json
Why you void the redemption (1-500 characters, trimmed).
Required string length:
1 - 500Response
OK
Single-object envelope around a Redemption.
A redemption (consumer view). Append-only. Also the payload of the redemption-created and redemption-voided webhooks.
Show child attributes
Show child attributes