curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"{ \"pin\": \"IAALKPM4AMED6HWX\" }"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards"
payload = "{ \"pin\": \"IAALKPM4AMED6HWX\" }"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('{ "pin": "IAALKPM4AMED6HWX" }')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards', 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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards",
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('{ "pin": "IAALKPM4AMED6HWX" }'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards"
payload := strings.NewReader("\"{ \\\"pin\\\": \\\"IAALKPM4AMED6HWX\\\" }\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"{ \\\"pin\\\": \\\"IAALKPM4AMED6HWX\\\" }\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"{ \\\"pin\\\": \\\"IAALKPM4AMED6HWX\\\" }\""
response = http.request(request)
puts response.read_body"{ \"object\": \"GiftCard\", \"vid\": \"8d1ece91e44441c3d424717c561dc8df74c4b5e4\", \"last_digits\": \"6HWX\", \"pin_length\": 16, \"hash_type\": \"sha1\", \"pin_hash\": \"b535aae49e30398c710989a79d56306e9ec0f309\", \"payment_provider\": \"Topps\", \"status\": \"Active\", \"amount\": 500, \"currency\": \"MXN\", \"product_number\": \"91422282643651081111\" }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Create a Gift Card
Creates a new Gift Card object in Subscribe. The gift card itself is created in the system but the Gift card’s value is not redeemed and therefore is not available for consumption.
Tip:- Vindicia recommends using the Gift Card Redemptions object as the first call in order to redeem the gift card and create the gift card object, in a single call.
curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"{ \"pin\": \"IAALKPM4AMED6HWX\" }"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards"
payload = "{ \"pin\": \"IAALKPM4AMED6HWX\" }"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('{ "pin": "IAALKPM4AMED6HWX" }')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards', 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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards",
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('{ "pin": "IAALKPM4AMED6HWX" }'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards"
payload := strings.NewReader("\"{ \\\"pin\\\": \\\"IAALKPM4AMED6HWX\\\" }\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"{ \\\"pin\\\": \\\"IAALKPM4AMED6HWX\\\" }\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/gift_cards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"{ \\\"pin\\\": \\\"IAALKPM4AMED6HWX\\\" }\""
response = http.request(request)
puts response.read_body"{ \"object\": \"GiftCard\", \"vid\": \"8d1ece91e44441c3d424717c561dc8df74c4b5e4\", \"last_digits\": \"6HWX\", \"pin_length\": 16, \"hash_type\": \"sha1\", \"pin_hash\": \"b535aae49e30398c710989a79d56306e9ec0f309\", \"payment_provider\": \"Topps\", \"status\": \"Active\", \"amount\": 500, \"currency\": \"MXN\", \"product_number\": \"91422282643651081111\" }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
JSON - Gift Cards Gift card pin is required.The gift card's pin number is hidden number on the card itself that must be revealed for redemption. It is used to uniquely identify the gift card with the payment provider.
pin for gift card
Value is "GiftCard"
GiftCard A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
128sku for gift card
last digits of gift card number
sku for gift card
sku for gift card
a, b sku for gift card
sku for gift card
Show child attributes
Show child attributes
The Product object represents a unique CSP product, with its own pricing, description and entitlement assignments. The API allows you to create, fetch, and update products. You can retrieve individual Product objects, as well as a list of all.
Show child attributes
Show child attributes
Response
JSON A full GiftCard object.
pin for gift card
Value is "GiftCard"
GiftCard A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
128sku for gift card
last digits of gift card number
sku for gift card
sku for gift card
a, b sku for gift card
sku for gift card
Show child attributes
Show child attributes
The Product object represents a unique CSP product, with its own pricing, description and entitlement assignments. The API allows you to create, fetch, and update products. You can retrieve individual Product objects, as well as a list of all.
Show child attributes
Show child attributes

