Redeem existing unused voucher
curl --request PATCH \
--url https://staging-vouchers.ventogram.com/api/v1/vouchers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--data '
{
"email": "<string>",
"voucherCode": "<string>"
}
'import requests
url = "https://staging-vouchers.ventogram.com/api/v1/vouchers"
payload = {
"email": "<string>",
"voucherCode": "<string>"
}
headers = {
"X-Api-User": "<api-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Api-User': '<api-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({email: '<string>', voucherCode: '<string>'})
};
fetch('https://staging-vouchers.ventogram.com/api/v1/vouchers', 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://staging-vouchers.ventogram.com/api/v1/vouchers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'voucherCode' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>",
"X-Api-User: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging-vouchers.ventogram.com/api/v1/vouchers"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"voucherCode\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-User", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.patch("https://staging-vouchers.ventogram.com/api/v1/vouchers")
.header("X-Api-User", "<api-key>")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"voucherCode\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-vouchers.ventogram.com/api/v1/vouchers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-User"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"voucherCode\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"email": "<string>",
"voucherCode": "<string>",
"amount": 123,
"fee": 123,
"wavedFee": 123,
"merchant": "<string>",
"feeBearer": "client",
"toAmount": 123,
"fromAmount": 123,
"fromCurrency": "<string>",
"toCurrency": "<string>",
"rate": 123,
"previousBalance": 123,
"currentBalance": 123
}
}{
"success": false,
"message": "<string>",
"errors": [
"voucherCode is required"
]
}{
"success": false,
"message": "<string>",
"errors": []
}Collect & Onramp
Redeem existing unused voucher
Redeems an existing unused voucher
PATCH
/
v1
/
vouchers
Redeem existing unused voucher
curl --request PATCH \
--url https://staging-vouchers.ventogram.com/api/v1/vouchers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--data '
{
"email": "<string>",
"voucherCode": "<string>"
}
'import requests
url = "https://staging-vouchers.ventogram.com/api/v1/vouchers"
payload = {
"email": "<string>",
"voucherCode": "<string>"
}
headers = {
"X-Api-User": "<api-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Api-User': '<api-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({email: '<string>', voucherCode: '<string>'})
};
fetch('https://staging-vouchers.ventogram.com/api/v1/vouchers', 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://staging-vouchers.ventogram.com/api/v1/vouchers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'voucherCode' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>",
"X-Api-User: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging-vouchers.ventogram.com/api/v1/vouchers"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"voucherCode\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-User", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.patch("https://staging-vouchers.ventogram.com/api/v1/vouchers")
.header("X-Api-User", "<api-key>")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"voucherCode\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-vouchers.ventogram.com/api/v1/vouchers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-User"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"voucherCode\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"email": "<string>",
"voucherCode": "<string>",
"amount": 123,
"fee": 123,
"wavedFee": 123,
"merchant": "<string>",
"feeBearer": "client",
"toAmount": 123,
"fromAmount": 123,
"fromCurrency": "<string>",
"toCurrency": "<string>",
"rate": 123,
"previousBalance": 123,
"currentBalance": 123
}
}{
"success": false,
"message": "<string>",
"errors": [
"voucherCode is required"
]
}{
"success": false,
"message": "<string>",
"errors": []
}Body
application/json
Was this page helpful?
⌘I