Get one of the rewards a consumer has received.

GET

perks

consumers

{consumer_id}

rewards

{reward_id}

Get one of the rewards a consumer has received.

curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/rewards/{reward_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'

import requests

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

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/perks/consumers/{consumer_id}/rewards/{reward_id}', 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/perks/consumers/{consumer_id}/rewards/{reward_id}",
  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/perks/consumers/{consumer_id}/rewards/{reward_id}"

	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/perks/consumers/{consumer_id}/rewards/{reward_id}")
  .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/perks/consumers/{consumer_id}/rewards/{reward_id}")

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

{
  "amount": "12.34",
  "brand": {
    "name": "Nike",
    "logo": "https://static.sandbox.paylead.fr/123455.jpeg"
  },
  "consumer_status": "PAID",
  "created_at": "2026-07-15T10:30:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PAID_IN",
  "transaction": {
    "executed_at": "2026-07-14T09:12:00Z",
    "external_id": "txn-abc-123"
  },
  "type": "CASHBACK"
}

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

required

Path Parameters

consumer_id

string

required

Required string length: 2 - 100

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"consumer-12345"

reward_id

string<uuid>

required

Identifier of the reward.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Successful Response

amount

string

required

Amount of the reward.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example:

"12.34"

brand

RewardBrandSchema · object

required

Brand display information for the reward.

Show child attributes

consumer_status

string

required

Consumer-facing status of the reward, derived from its moderation status: VALIDATION (will probably be paid, visible to the consumer), POOLED (the consumer can ask to be paid), PAID (the amount has been paid to the consumer).

Example:

"PAID"

created_at

string<date-time>

required

When the reward was created.

Example:

"2026-07-15T10:30:00Z"

string<uuid>

required

Identifier of the reward.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

status

string

required

Status of the reward in its moderation workflow (e.g. VALIDATED, PAID_IN, PAID_OUT).

Example:

"PAID_IN"

transaction

RewardTransactionSchema · object | null

required

Originating transaction; null for rewards without one (e.g. gifts).

Show child attributes

type

string

required

Type of the reward (e.g. CASHBACK, GIFT).

Example:

"CASHBACK"

⌘I

Get one of the rewards a consumer has received.

curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/rewards/{reward_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'

import requests

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

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/perks/consumers/{consumer_id}/rewards/{reward_id}', 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/perks/consumers/{consumer_id}/rewards/{reward_id}",
  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/perks/consumers/{consumer_id}/rewards/{reward_id}"

	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/perks/consumers/{consumer_id}/rewards/{reward_id}")
  .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/perks/consumers/{consumer_id}/rewards/{reward_id}")

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

{
  "amount": "12.34",
  "brand": {
    "name": "Nike",
    "logo": "https://static.sandbox.paylead.fr/123455.jpeg"
  },
  "consumer_status": "PAID",
  "created_at": "2026-07-15T10:30:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PAID_IN",
  "transaction": {
    "executed_at": "2026-07-14T09:12:00Z",
    "external_id": "txn-abc-123"
  },
  "type": "CASHBACK"
}

Authentication

Consumers

Perks

Resources

Get one of the rewards a consumer has received.

Authorizations

Headers

Path Parameters

Response