Redeem voucher
curl --request POST \
--url https://api.example.com/api/v1/developer/vouchers/{code}/redeemimport requests
url = "https://api.example.com/api/v1/developer/vouchers/{code}/redeem"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/developer/vouchers/{code}/redeem', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/developer/vouchers/{code}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/developer/vouchers/{code}/redeem"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/developer/vouchers/{code}/redeem")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/developer/vouchers/{code}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyVouchers
Redeem voucher
Deduct an amount from a voucher’s balance. Supports idempotency.
POST
/
api
/
v1
/
developer
/
vouchers
/
{code}
/
redeem
Redeem voucher
curl --request POST \
--url https://api.example.com/api/v1/developer/vouchers/{code}/redeemimport requests
url = "https://api.example.com/api/v1/developer/vouchers/{code}/redeem"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/developer/vouchers/{code}/redeem', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/developer/vouchers/{code}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/developer/vouchers/{code}/redeem"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/developer/vouchers/{code}/redeem")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/developer/vouchers/{code}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyRequired scope:
vouchers:redeem
Rate limit: 60 requests/minute
Idempotency: supported via Idempotency-Key header (24h TTL, scoped per
API key). See Idempotency.
A redemption deducts from the voucher’s balance. If the new balance reaches
zero the voucher status moves to redeemed; otherwise it stays completed
with the reduced balance.
Path parameters
| Parameter | Type | Notes |
|---|---|---|
code | string | Voucher code, max 50 characters |
Headers
| Header | Required | Notes |
|---|---|---|
Idempotency-Key | no | Up to 256 characters. Cached response replays for 24 hours. |
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
amount | decimal (string) | yes | Greater than 0 |
notes | string | no | Optional internal note |
Response
{
"id": "8d82f0d2-7f94-4a3b-8b55-1e2e3a4f5b6c",
"code": "VG-EXAMPLE1",
"amount": "100.00",
"balance": "75.00",
"status": "completed",
"recipient_name": "Sam Recipient",
"recipient_email": "sam@example.com",
"expiry_date": "2029-04-26T00:00:00Z",
"created_at": "2026-04-26T01:23:45Z",
"updated_at": "2026-04-26T02:34:56Z",
"location_id": null
}
Errors
400 "Voucher is pending and not redeemable"– voucher status ispending.400 "Voucher is not redeemable"– voucher status is anything other thanpendingorcompleted(e.g. alreadyredeemed,voided,refunded).400 "Cannot redeem an expired voucher"–expiry_datehas passed.400 "Redemption amount exceeds available balance"–amountis greater than the voucher’s currentbalance.404– Voucher not found in your tenant (or location).409 "A duplicate request is already being processed. Please wait a moment and try again."– a request with the sameIdempotency-Keyis still in flight. Retry shortly.409 "Idempotency-Key was reused with a different request body. Use a fresh Idempotency-Key for a different operation."–Idempotency-Keyreused with a different request body within the 24h replay window. See Idempotency.409 "Voucher balance changed concurrently – please retry"– the voucher balance changed underneath the operation (e.g. concurrent redemption). Retry.
Examples
curl -X POST \
-H "X-API-Key: vg_live_EXAMPLEdoNotUseThis123456" \
-H "Idempotency-Key: redeem-2026-04-26-VG-EXAMPLE1-001" \
-H "Content-Type: application/json" \
-d '{"amount": "25.00"}' \
https://api.vouchergrid.com/api/v1/developer/vouchers/VG-EXAMPLE1/redeem
const res = await fetch(
"https://api.vouchergrid.com/api/v1/developer/vouchers/VG-EXAMPLE1/redeem",
{
method: "POST",
headers: {
"X-API-Key": process.env.VOUCHERGRID_API_KEY!,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({ amount: "25.00" }),
},
);
const voucher = await res.json();