Get detail for an offer visible to this consumer in the program's catalog.

GET

perks

consumers

{consumer_id}

offers

{offer_id}

Get detail for an offer visible to this consumer in the program's catalog.

curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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

{
  "application_channel": "ONLINE",
  "brand": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "logo": {
      "url": "https://static.sandbox.paylead.fr/123455.jpeg"
    },
    "name": "Nike"
  },
  "highlight_level": "NORMAL",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_consumed": false,
  "perks": {
    "cashback": {
      "cashback_rate": "5.00",
      "frequency": false,
      "boosted": false,
      "loyalty_frequency": 3,
      "max_amount": "200.00",
      "max_cashbacks_per_consumer": 3,
      "max_eligible_amount": "500.00",
      "min_amount": "10.00"
    },
    "coupon": {
      "diffusion_type": "CODE",
      "discount_rate": "15.00",
      "discount_value": "5.00",
      "max_per_consumer": 1
    },
    "voucher": {
      "discount_rate": "7.50",
      "amount_step": "5.00",
      "amounts": [
        "10.00",
        "25.00",
        "50.00"
      ],
      "max_amount": "250.00",
      "min_amount": "10.00",
      "validity_months": 12
    }
  },
  "start_date": "2026-07-01T00:00:00Z",
  "description": "Earn 5% cashback on every online order.",
  "end_date": "2026-09-30T23:59:59Z",
  "legal_terms": "Valid from 01/07/2026 to 30/09/2026, excluding sale items.",
  "picture": {
    "url": "https://static.sandbox.paylead.fr/123455.jpeg"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Accept-Language

string | null

BCP 47 language tag(s) for localised fields; the first tag is matched exactly against the tags stored for this offer (e.g. 'fr-FR', 'en-GB'). A tag with no exact match (including a bare language code like 'en') falls back to the program's configured language.

Example:

"fr-FR"

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"

offer_id

string<uuid>

required

Example:

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

Response

Successful Response

application_channel

enum<string>

required

Where the offer applies: in store (OFFLINE), online (ONLINE), or both.

Available options:

BOTH,

ONLINE,

OFFLINE

Example:

"ONLINE"

brand

OfferBrandSchema · object

required

Show child attributes

highlight_level

enum<string>

required

How prominently the program manager wants the offer displayed, for contextual surfaces such as a banner or a carousel. Offers with no prominence set are reported as NORMAL.

Available options:

HIGHEST,

HIGH,

NORMAL

Example:

"NORMAL"

string<uuid>

required

Example:

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

is_consumed

boolean

required

Whether this consumer already used the offer — a claimed coupon, or a cashback earned up to the offer's cap.

Example:

false

perks

OfferDetailPerksSchema · object

required

Show child attributes

start_date

string<date-time>

required

When the offer became available to this consumer: the offer's start date, or the date the consumer was reached when that happened later.

Example:

"2026-07-01T00:00:00Z"

description

string | null

Localised offer description, resolved from the Accept-Language header.

Example:

"Earn 5% cashback on every online order."

end_date

string<date-time> | null

When the offer stops being available, null when open-ended. For a cashback offer running through successive phases, the current phase's end date bounds this window.

Example:

"2026-09-30T23:59:59Z"

legal_terms

string | null

Localised legal terms, with the {{start_date}} / {{end_date}} placeholders already substituted for the current phase's dates.

Example:

"Valid from 01/07/2026 to 30/09/2026, excluding sale items."

picture

LogoSchema · object | null

The offer's own illustration, distinct from brand.logo. Null when the offer carries no picture.

Show child attributes

List the rewards a consumer has received.

⌘I

Get detail for an offer visible to this consumer in the program's catalog.

curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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}/offers/{offer_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

{
  "application_channel": "ONLINE",
  "brand": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "logo": {
      "url": "https://static.sandbox.paylead.fr/123455.jpeg"
    },
    "name": "Nike"
  },
  "highlight_level": "NORMAL",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_consumed": false,
  "perks": {
    "cashback": {
      "cashback_rate": "5.00",
      "frequency": false,
      "boosted": false,
      "loyalty_frequency": 3,
      "max_amount": "200.00",
      "max_cashbacks_per_consumer": 3,
      "max_eligible_amount": "500.00",
      "min_amount": "10.00"
    },
    "coupon": {
      "diffusion_type": "CODE",
      "discount_rate": "15.00",
      "discount_value": "5.00",
      "max_per_consumer": 1
    },
    "voucher": {
      "discount_rate": "7.50",
      "amount_step": "5.00",
      "amounts": [
        "10.00",
        "25.00",
        "50.00"
      ],
      "max_amount": "250.00",
      "min_amount": "10.00",
      "validity_months": 12
    }
  },
  "start_date": "2026-07-01T00:00:00Z",
  "description": "Earn 5% cashback on every online order.",
  "end_date": "2026-09-30T23:59:59Z",
  "legal_terms": "Valid from 01/07/2026 to 30/09/2026, excluding sale items.",
  "picture": {
    "url": "https://static.sandbox.paylead.fr/123455.jpeg"
  }
}

Authentication

Consumers

Perks

Resources

Get detail for an offer visible to this consumer in the program's catalog.

Authorizations

Headers

Path Parameters

Response