Skip to main content
GET
/
consumers
/
{consumer_id}
/
rewards
/
info
Get a consumer's aggregated reward information
curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api-{programRef}.sandbox.paylead.tech/consumers/{consumer_id}/rewards/info"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {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>"
  ],
]);

$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("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("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["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "perks": {
    "can_trigger_pooled": true,
    "paid": {
      "amount": "<string>",
      "count": 123
    },
    "pooled": {
      "amount": "<string>",
      "count": 123
    },
    "validation": {
      "amount": "<string>",
      "count": 123
    },
    "voucher": {
      "count": 123,
      "total_discount": "<string>"
    }
  }
}
{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>"
}
{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>"
}
{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>"
}
{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>"
}
{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-api-version
string
default:2.0.0

Path Parameters

​
consumer_id
string
required

Unique ID of the consumer that you have registered when the user was onboarded.

Required string length: 2 - 100

Response

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.

​
perks
PerksRewardInfoOut · object | null