Create a voucher set
curl --request POST \
--url https://api.voucher-staging.allride.io/provider/v1/voucher-sets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({internalName: 'Ride credit EUR 5 - Q4', voucherKind: 'code'})
};
fetch('https://api.voucher-staging.allride.io/provider/v1/voucher-sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
payload = {
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code"
}
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/provider/v1/voucher-sets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"internalName\": \"Ride credit EUR 5 - Q4\",\n \"voucherKind\": \"code\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
payload := strings.NewReader("{\n \"internalName\": \"Ride credit EUR 5 - Q4\",\n \"voucherKind\": \"code\"\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/provider/v1/voucher-sets",
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([
'internalName' => 'Ride credit EUR 5 - Q4',
'voucherKind' => 'code'
]),
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": 2043,
"resource": "voucher-set",
"providerPartnerId": 42,
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code",
"status": "draft",
"availability": null,
"liveRevisionId": null,
"liveRevisionNo": 0,
"live": null,
"draftContent": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "5,00 €"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"pendingChangeRequestId": null,
"activeFrom": null,
"deactivateAt": null,
"activatedAt": null,
"deactivatedAt": null,
"suspendedAt": null,
"archivedAt": null,
"suspensionReason": null,
"stock": {
"remaining": 9950,
"used": 50,
"usagePercent": 0.5,
"availableVoucherCount": 9950,
"expiredVoucherCount": 0,
"revokedVoucherCount": 0,
"stockStatus": "available",
"updatedAt": "2026-10-22T07:58:31.204Z"
},
"createdBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"createdAt": "2026-10-20T09:12:44.501Z",
"updatedAt": "2026-10-22T07:10:02.300Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"vouchers": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/vouchers",
"type": "application/json"
},
"uploads": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/uploads",
"type": "application/json"
},
"changeRequests": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests",
"type": "application/json"
},
"changelog": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/changelog",
"type": "application/json"
},
"revisions": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions",
"type": "application/json"
},
"stockAlertRule": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/stock-alert-rule",
"type": "application/json"
}
}
}
}Voucher sets
Create a voucher set
Creates a voucher set in draft; content becomes its draftContent. In the same transaction a stock alert rule with the thresholds 50, 75, 90 and 100 % is created. Consumers see nothing until a change request is approved and the set is activated. See Voucher sets.
Required permissions: manage-provider-voucher-sets · API keys: allowed
POST
/
provider
/
v1
/
voucher-sets
Create a voucher set
curl --request POST \
--url https://api.voucher-staging.allride.io/provider/v1/voucher-sets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({internalName: 'Ride credit EUR 5 - Q4', voucherKind: 'code'})
};
fetch('https://api.voucher-staging.allride.io/provider/v1/voucher-sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
payload = {
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code"
}
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/provider/v1/voucher-sets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"internalName\": \"Ride credit EUR 5 - Q4\",\n \"voucherKind\": \"code\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
payload := strings.NewReader("{\n \"internalName\": \"Ride credit EUR 5 - Q4\",\n \"voucherKind\": \"code\"\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/provider/v1/voucher-sets",
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([
'internalName' => 'Ride credit EUR 5 - Q4',
'voucherKind' => 'code'
]),
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": 2043,
"resource": "voucher-set",
"providerPartnerId": 42,
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code",
"status": "draft",
"availability": null,
"liveRevisionId": null,
"liveRevisionNo": 0,
"live": null,
"draftContent": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "5,00 €"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"pendingChangeRequestId": null,
"activeFrom": null,
"deactivateAt": null,
"activatedAt": null,
"deactivatedAt": null,
"suspendedAt": null,
"archivedAt": null,
"suspensionReason": null,
"stock": {
"remaining": 9950,
"used": 50,
"usagePercent": 0.5,
"availableVoucherCount": 9950,
"expiredVoucherCount": 0,
"revokedVoucherCount": 0,
"stockStatus": "available",
"updatedAt": "2026-10-22T07:58:31.204Z"
},
"createdBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"createdAt": "2026-10-20T09:12:44.501Z",
"updatedAt": "2026-10-22T07:10:02.300Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"vouchers": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/vouchers",
"type": "application/json"
},
"uploads": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/uploads",
"type": "application/json"
},
"changeRequests": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests",
"type": "application/json"
},
"changelog": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/changelog",
"type": "application/json"
},
"revisions": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions",
"type": "application/json"
},
"stockAlertRule": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/stock-alert-rule",
"type": "application/json"
}
}
}
}Authorizations
Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.
Headers
Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). 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}$Body
application/json
Create a voucher set in draft.
1-120 characters; never shown to consumers.
Required string length:
1 - 120Kind of vouchers. Treat as an open set: new values may be added.
Available options:
code, link Becomes draftContent (partial content allowed).
Show child attributes
Show child attributes
Response
Success.
Single-object envelope around VoucherSet.
A voucher set (provider view).
Show child attributes
Show child attributes