Aggregates reward information for consumer consumer_id by querying the different backends concurrently. Each backend contributes its own field (e.g. perks) and is only included when it responds: a backend that fails, times out or has no data for the consumer is omitted from the payload.
curl --request GET \
--url https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info \
--header 'Authorization: Bearer <token>' \
--header 'x-api-version: <x-api-version>'import requests
url = "https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info"
headers = {
"x-api-version": "<x-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-version': '<x-api-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info', 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://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-api-version: <x-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info")
.header("x-api-version", "<x-api-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"perks": {
"can_trigger_pooled": true,
"paid": {
"amount": "42.50",
"count": 12
},
"pooled": {
"amount": "42.50",
"count": 12
},
"validation": {
"amount": "42.50",
"count": 12
},
"voucher": {
"count": 3,
"total_discount": "15.00"
}
}
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Path Parameters
Unique ID of the consumer that you have registered when the user was onboarded.
2 - 100Response
Successful Response
Aggregated reward information for a consumer.
Each field maps to a distinct backend and is only present when that backend responded. Backends are queried concurrently; a backend that fails, times out or has no data for the consumer is simply omitted from the payload.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info \
--header 'Authorization: Bearer <token>' \
--header 'x-api-version: <x-api-version>'import requests
url = "https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info"
headers = {
"x-api-version": "<x-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-version': '<x-api-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info', 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://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-api-version: <x-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info")
.header("x-api-version", "<x-api-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"perks": {
"can_trigger_pooled": true,
"paid": {
"amount": "42.50",
"count": 12
},
"pooled": {
"amount": "42.50",
"count": 12
},
"validation": {
"amount": "42.50",
"count": 12
},
"voucher": {
"count": 3,
"total_discount": "15.00"
}
}
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}