Redeem Gift Card
curl --request POST \
--url https://ipos.dev.nowbookit.com/GiftCards/redeem \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"cardNumber": "<string>",
"amount": 123,
"issuedToEmail": "<string>",
"notes": "<string>"
}
'import requests
url = "https://ipos.dev.nowbookit.com/GiftCards/redeem"
payload = {
"cardNumber": "<string>",
"amount": 123,
"issuedToEmail": "<string>",
"notes": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cardNumber: '<string>',
amount: 123,
issuedToEmail: '<string>',
notes: '<string>'
})
};
fetch('https://ipos.dev.nowbookit.com/GiftCards/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://ipos.dev.nowbookit.com/GiftCards/redeem",
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([
'cardNumber' => '<string>',
'amount' => 123,
'issuedToEmail' => '<string>',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://ipos.dev.nowbookit.com/GiftCards/redeem"
payload := strings.NewReader("{\n \"cardNumber\": \"<string>\",\n \"amount\": 123,\n \"issuedToEmail\": \"<string>\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://ipos.dev.nowbookit.com/GiftCards/redeem")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cardNumber\": \"<string>\",\n \"amount\": 123,\n \"issuedToEmail\": \"<string>\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ipos.dev.nowbookit.com/GiftCards/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardNumber\": \"<string>\",\n \"amount\": 123,\n \"issuedToEmail\": \"<string>\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"cardNumber": "<string>",
"amountRedeemed": 123,
"status": "<string>",
"errorMessage": "<string>",
"isSuccess": true
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Gift Cards
POST /GiftCards/redeem
Redeem a gift card in full or partially.
POST
/
GiftCards
/
redeem
Redeem Gift Card
curl --request POST \
--url https://ipos.dev.nowbookit.com/GiftCards/redeem \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"cardNumber": "<string>",
"amount": 123,
"issuedToEmail": "<string>",
"notes": "<string>"
}
'import requests
url = "https://ipos.dev.nowbookit.com/GiftCards/redeem"
payload = {
"cardNumber": "<string>",
"amount": 123,
"issuedToEmail": "<string>",
"notes": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cardNumber: '<string>',
amount: 123,
issuedToEmail: '<string>',
notes: '<string>'
})
};
fetch('https://ipos.dev.nowbookit.com/GiftCards/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://ipos.dev.nowbookit.com/GiftCards/redeem",
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([
'cardNumber' => '<string>',
'amount' => 123,
'issuedToEmail' => '<string>',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://ipos.dev.nowbookit.com/GiftCards/redeem"
payload := strings.NewReader("{\n \"cardNumber\": \"<string>\",\n \"amount\": 123,\n \"issuedToEmail\": \"<string>\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://ipos.dev.nowbookit.com/GiftCards/redeem")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cardNumber\": \"<string>\",\n \"amount\": 123,\n \"issuedToEmail\": \"<string>\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ipos.dev.nowbookit.com/GiftCards/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardNumber\": \"<string>\",\n \"amount\": 123,\n \"issuedToEmail\": \"<string>\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"cardNumber": "<string>",
"amountRedeemed": 123,
"status": "<string>",
"errorMessage": "<string>",
"isSuccess": true
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Redeem a gift card in full or partially. Pass an amount less than the remaining balance for a partial redemption.
Response fields
Example 200 — Success
Example 200 — Failure
string
required
Your API key
string
required
Must be
application/jsonstring
required
Gift card number. Format:
XXXXX-XXXXXXXX-XXXXnumber
required
Amount to redeem. Pass less than the remaining balance for partial redemption.
string
Email address for verification
string
Notes for this redemption
curl --location '[BASE_URL]/GiftCards/redeem' \
--header 'X-API-KEY: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{ "cardNumber": "ABCDE-12345678-WXYZ", "amount": 25.00 }'
200 OK is returned even for business-level failures. Always check isSuccess in the response body.| Field | Type | Description |
|---|---|---|
cardNumber | string | The redeemed card number |
amountRedeemed | number | Amount that was redeemed |
status | string | Active, Redeemed, or Error |
isSuccess | boolean | Whether the redemption succeeded |
errorMessage | string | Error detail if isSuccess is false |
{ "cardNumber": "ABCDE-12345678-WXYZ", "amountRedeemed": 25.00, "status": "Active", "isSuccess": true, "errorMessage": null }
{ "cardNumber": "ABCDE-12345678-WXYZ", "amountRedeemed": 0.00, "status": "Error", "isSuccess": false, "errorMessage": "Card already redeemed." }
| Status | Description |
|---|---|
200 | See isSuccess in response body |
400 | Card: {cardNumber} invalid redeem amount. — amount is 0 or negative |
400 | No Venue Subscribed to your App. |
401 | X-API-KEY missing or invalid |
404 | CardNumber — Card not found |
500 | Failed to retrieve card details. |
Authorizations
Headers
API Key authentication header
Body
application/json
⌘I