Get detail for a brand in this program's catalog. - Paylead

GET

/

perks

/

consumers

/

{consumer_id}

/

brands

/

{brand_id}

Get detail for a brand in this program's catalog.

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "logo": {
    "url": "https://static.sandbox.paylead.fr/123455.jpeg"
  },
  "name": "Nike",
  "description": "Sportswear, footwear and equipment for every athlete.",
  "legal_terms": "Offer valid on the brand's online store only, excluding sale items."
}

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 brand (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"

brand_id

string<uuid>

required

Example:

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

Response

Successful Response

id

string<uuid>

required

Example:

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

logo

LogoSchema · object

required

Show child attributes

name

string

required

Example:

"Nike"

description

string | null

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

Example:

"Sportswear, footwear and equipment for every athlete."

legal_terms

string | null

Localised legal terms attached to the brand.

Example:

"Offer valid on the brand's online store only, excluding sale items."

Create or update a consumer's KYC (Mangopay natural user).

⌘I

Get detail for a brand in this program's catalog.

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "logo": {
    "url": "https://static.sandbox.paylead.fr/123455.jpeg"
  },
  "name": "Nike",
  "description": "Sportswear, footwear and equipment for every athlete.",
  "legal_terms": "Offer valid on the brand's online store only, excluding sale items."
}