GiftCard Hub API

vtex · Company

Company No Auth Free & Open API

>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The Gift Card Hub API allows interactions with all Gift Card providers registered to a store from a single point. Gift Card providers are systems capable of providing card

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET List All GiftCard Providers

Returns a collection of giftcard providers from a store.

https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json
X-VTEX-API-AppKey	{{X-VTEX-API-AppKey}}
X-VTEX-API-AppToken	{{X-VTEX-API-AppToken}}

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}" \
  -H "X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "X-VTEX-API-AppKey": "{{X-VTEX-API-AppKey}}",
    "X-VTEX-API-AppToken": "{{X-VTEX-API-AppToken}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-VTEX-API-AppKey': '{{X-VTEX-API-AppKey}}',
    'X-VTEX-API-AppToken': '{{X-VTEX-API-AppToken}}'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-VTEX-API-AppKey", "{{X-VTEX-API-AppKey}}")
	req.Header.Set("X-VTEX-API-AppToken", "{{X-VTEX-API-AppToken}}")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"
req["X-VTEX-API-AppKey"] = "{{X-VTEX-API-AppKey}}"
req["X-VTEX-API-AppToken"] = "{{X-VTEX-API-AppToken}}"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json",
        "X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}",
        "X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get GiftCard Provider by ID

Returns a giftcard provider from a store.

https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json
X-VTEX-API-AppKey	{{X-VTEX-API-AppKey}}
X-VTEX-API-AppToken	{{X-VTEX-API-AppToken}}

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}" \
  -H "X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "X-VTEX-API-AppKey": "{{X-VTEX-API-AppKey}}",
    "X-VTEX-API-AppToken": "{{X-VTEX-API-AppToken}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-VTEX-API-AppKey': '{{X-VTEX-API-AppKey}}',
    'X-VTEX-API-AppToken': '{{X-VTEX-API-AppToken}}'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-VTEX-API-AppKey", "{{X-VTEX-API-AppKey}}")
	req.Header.Set("X-VTEX-API-AppToken", "{{X-VTEX-API-AppToken}}")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"
req["X-VTEX-API-AppKey"] = "{{X-VTEX-API-AppKey}}"
req["X-VTEX-API-AppToken"] = "{{X-VTEX-API-AppToken}}"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderId}";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json",
        "X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}",
        "X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get GiftCard from GiftCard Provider by ID

Returns a specific giftcard from a giftcard provider.

https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json
X-VTEX-API-AppKey	{{X-VTEX-API-AppKey}}
X-VTEX-API-AppToken	{{X-VTEX-API-AppToken}}

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}" \
  -H "X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "X-VTEX-API-AppKey": "{{X-VTEX-API-AppKey}}",
    "X-VTEX-API-AppToken": "{{X-VTEX-API-AppToken}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-VTEX-API-AppKey': '{{X-VTEX-API-AppKey}}',
    'X-VTEX-API-AppToken': '{{X-VTEX-API-AppToken}}'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-VTEX-API-AppKey", "{{X-VTEX-API-AppKey}}")
	req.Header.Set("X-VTEX-API-AppToken", "{{X-VTEX-API-AppToken}}")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"
req["X-VTEX-API-AppKey"] = "{{X-VTEX-API-AppKey}}"
req["X-VTEX-API-AppToken"] = "{{X-VTEX-API-AppToken}}"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json",
        "X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}",
        "X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with GiftCard Hub API?

GiftCard Hub API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. GiftCard Hub API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗