Update merchant record
curl --request PATCH \
--url https://staging-vouchers.ventogram.com/api/v1/merchants \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--data '
{
"callbackUrl": "https://www.example.com/webhook/ventogram",
"logo": "https://www.example.com/favicon",
"feeBearer": "client"
}
'import requests
url = "https://staging-vouchers.ventogram.com/api/v1/merchants"
payload = {
"callbackUrl": "https://www.example.com/webhook/ventogram",
"logo": "https://www.example.com/favicon",
"feeBearer": "client"
}
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({
callbackUrl: 'https://www.example.com/webhook/ventogram',
logo: 'https://www.example.com/favicon',
feeBearer: 'client'
})
};
fetch('https://staging-vouchers.ventogram.com/api/v1/merchants', 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/merchants",
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([
'callbackUrl' => 'https://www.example.com/webhook/ventogram',
'logo' => 'https://www.example.com/favicon',
'feeBearer' => 'client'
]),
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/merchants"
payload := strings.NewReader("{\n \"callbackUrl\": \"https://www.example.com/webhook/ventogram\",\n \"logo\": \"https://www.example.com/favicon\",\n \"feeBearer\": \"client\"\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/merchants")
.header("X-Api-User", "<api-key>")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"callbackUrl\": \"https://www.example.com/webhook/ventogram\",\n \"logo\": \"https://www.example.com/favicon\",\n \"feeBearer\": \"client\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-vouchers.ventogram.com/api/v1/merchants")
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 \"callbackUrl\": \"https://www.example.com/webhook/ventogram\",\n \"logo\": \"https://www.example.com/favicon\",\n \"feeBearer\": \"client\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"username": "<string>",
"callbackUrl": "<string>",
"logo": "<string>",
"feeBearer": "<string>"
}
}Collect & Onramp
Update merchant record
Updates merchant record
PATCH
/
v1
/
merchants
Update merchant record
curl --request PATCH \
--url https://staging-vouchers.ventogram.com/api/v1/merchants \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--data '
{
"callbackUrl": "https://www.example.com/webhook/ventogram",
"logo": "https://www.example.com/favicon",
"feeBearer": "client"
}
'import requests
url = "https://staging-vouchers.ventogram.com/api/v1/merchants"
payload = {
"callbackUrl": "https://www.example.com/webhook/ventogram",
"logo": "https://www.example.com/favicon",
"feeBearer": "client"
}
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({
callbackUrl: 'https://www.example.com/webhook/ventogram',
logo: 'https://www.example.com/favicon',
feeBearer: 'client'
})
};
fetch('https://staging-vouchers.ventogram.com/api/v1/merchants', 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/merchants",
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([
'callbackUrl' => 'https://www.example.com/webhook/ventogram',
'logo' => 'https://www.example.com/favicon',
'feeBearer' => 'client'
]),
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/merchants"
payload := strings.NewReader("{\n \"callbackUrl\": \"https://www.example.com/webhook/ventogram\",\n \"logo\": \"https://www.example.com/favicon\",\n \"feeBearer\": \"client\"\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/merchants")
.header("X-Api-User", "<api-key>")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"callbackUrl\": \"https://www.example.com/webhook/ventogram\",\n \"logo\": \"https://www.example.com/favicon\",\n \"feeBearer\": \"client\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-vouchers.ventogram.com/api/v1/merchants")
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 \"callbackUrl\": \"https://www.example.com/webhook/ventogram\",\n \"logo\": \"https://www.example.com/favicon\",\n \"feeBearer\": \"client\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"username": "<string>",
"callbackUrl": "<string>",
"logo": "<string>",
"feeBearer": "<string>"
}
}Body
application/json
Merchant callback URL. Webhook will be sent to this URL.
Example:
"https://www.example.com/webhook/ventogram"
Merchant logo URL
Example:
"https://www.example.com/favicon"
Bearer of the voucher fee
Available options:
client, merchant Example:
"client"
Merchants can set this property to their desired currency. Their balance on Ventogram will be credited with this currency when their users redeem voucher created on Ventogram. Conversion between different currencies will be performed at the rate which is obtainable at the time of redeeming the voucher. If this is not set by the merchant, their balance will be credited with the currency used in creating the voucher.
Available options:
NGN, USD, Was this page helpful?
⌘I