Current Balance and Transaction History
curl --request POST \
--url https://{brand}.extole.io/api/v6/zones/bankable_rewards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://{brand}.extole.io/api/v6/zones/bankable_rewards"
payload = {}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://{brand}.extole.io/api/v6/zones/bankable_rewards', 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://{brand}.extole.io/api/v6/zones/bankable_rewards",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{brand}.extole.io/api/v6/zones/bankable_rewards"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://{brand}.extole.io/api/v6/zones/bankable_rewards")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{brand}.extole.io/api/v6/zones/bankable_rewards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"data": {
"eligible_rewards": [
{
"data": {},
"name": "<string>",
"state": "<string>",
"reward_id": "<string>",
"face_value": "<string>",
"campaign_id": "<string>",
"earned_date": "<string>",
"expiry_date": "<string>",
"program_label": "<string>",
"face_value_type": "<string>",
"partner_reward_id": "<string>",
"reward_supplier_id": "<string>",
"redeemed_reward_ids": [
"<string>"
]
}
],
"reward_parameters": {
"max_amount": 123,
"min_amount": 123,
"face_value_type": [
"<string>"
],
"ratio_of_value_to_dollars": 123
},
"redemption_history": [
{
"data": {},
"name": "<string>",
"state": "<string>",
"reward_id": "<string>",
"face_value": "<string>",
"campaign_id": "<string>",
"earned_date": "<string>",
"expiry_date": "<string>",
"program_label": "<string>",
"face_value_type": "<string>",
"partner_reward_id": "<string>",
"reward_supplier_id": "<string>",
"redeemed_reward_ids": [
"<string>"
]
}
],
"redemption_suppliers": [
{
"name": "<string>",
"type": "<string>",
"face_value_type": "<string>",
"reward_supplier_id": "<string>"
}
]
}
}Reward Bank
Current Balance and Transaction History
Returns what this person can redeem and what they have redeemed already: the rewards their balance currently reaches, the suppliers those can be redeemed with, the redemption history, and the parameters the bank is configured with. Rendered for the person the access token identifies, so a person only ever sees their own bank.
POST
https://{brand}.extole.io
/
api
/
v6
/
zones
/
bankable_rewards
Current Balance and Transaction History
curl --request POST \
--url https://{brand}.extole.io/api/v6/zones/bankable_rewards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://{brand}.extole.io/api/v6/zones/bankable_rewards"
payload = {}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://{brand}.extole.io/api/v6/zones/bankable_rewards', 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://{brand}.extole.io/api/v6/zones/bankable_rewards",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{brand}.extole.io/api/v6/zones/bankable_rewards"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://{brand}.extole.io/api/v6/zones/bankable_rewards")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{brand}.extole.io/api/v6/zones/bankable_rewards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"data": {
"eligible_rewards": [
{
"data": {},
"name": "<string>",
"state": "<string>",
"reward_id": "<string>",
"face_value": "<string>",
"campaign_id": "<string>",
"earned_date": "<string>",
"expiry_date": "<string>",
"program_label": "<string>",
"face_value_type": "<string>",
"partner_reward_id": "<string>",
"reward_supplier_id": "<string>",
"redeemed_reward_ids": [
"<string>"
]
}
],
"reward_parameters": {
"max_amount": 123,
"min_amount": 123,
"face_value_type": [
"<string>"
],
"ratio_of_value_to_dollars": 123
},
"redemption_history": [
{
"data": {},
"name": "<string>",
"state": "<string>",
"reward_id": "<string>",
"face_value": "<string>",
"campaign_id": "<string>",
"earned_date": "<string>",
"expiry_date": "<string>",
"program_label": "<string>",
"face_value_type": "<string>",
"partner_reward_id": "<string>",
"reward_supplier_id": "<string>",
"redeemed_reward_ids": [
"<string>"
]
}
],
"redemption_suppliers": [
{
"name": "<string>",
"type": "<string>",
"face_value_type": "<string>",
"reward_supplier_id": "<string>"
}
]
}
}Authorizations
HEADERQUERY_PARAMCOOKIE
A consumer access token, issued to a single person in the browser or app. Not a client access token - never send a client token from a consumer device.
Body
application/jsonapplication/x-www-form-urlencoded
Optional data merged into the zone's rendering context. Send an empty object when there is nothing to add.
Response
Success
A zone render, so the bank is inside the zone's data envelope rather than at the root.
The person's reward bank as the redemption center reads it.
Show child attributes
Show child attributes
Was this page helpful?