Get Store Detail

GET

stores

{store_id}

Get Store Detail

curl --request GET \
  --url https://api.sandbox.paylead.tech/stores/{store_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/stores/{store_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.sandbox.paylead.tech/stores/{store_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>"
  ],
]);

$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.sandbox.paylead.tech/stores/{store_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/stores/{store_id}")

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

{
  "name": "MY LITTLE BRAND PARIS",
  "address": "55 rue des moulins",
  "brand": {
    "name": "<string>",
    "created_at": "2019-01-31T15:16:15.523309+00:00",
    "id": "e2c32b4b-de61-459b-accf-a75f76247946",
    "logo": {
      "content_type": "<string>",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "updated_at": "2020-01-23T12:00:00+00:00"
  },
  "business_name": "MY BRAND SARL",
  "city": "Paris",
  "country": "France",
  "created_at": "2019-01-31T15:16:15.523309+00:00",
  "id": "e2c32b4b-de61-459b-accf-a75f76247946",
  "is_online": true,
  "latitude": 50.51534475,
  "longitude": 6.0646992,
  "merchant": {
    "id": "e2c32b4b-de61-459b-accf-a75f76247946",
    "name": "<string>",
    "created_at": "2019-01-31T15:16:15.523309+00:00",
    "has_delegation": true,
    "logo": {
      "content_type": "<string>",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "networks": [
    {
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "logo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stores_total": 123
    }
  ],
  "offers": [
    {
      "cashback_rate": 5,
      "highlight_level": "HIGH",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "name": "<string>",
      "status": "<string>",
      "type": "CASHBACK",
      "application_channel": "ONLINE",
      "application_url": "https://www.mybrand.fr",
      "brand": {
        "description": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "legal_terms": "<string>",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "<string>",
        "universes": [
          {
            "children": "<array>",
            "id": "e2c32b4b-de61-459b-accf-a75f76247946",
            "name": "<string>",
            "parent_id": "5c5e6d04-9dfc-46b8-9432-7c977f1dca23"
          }
        ]
      },
      "consumed": true,
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "description": "<string>",
      "end_date": "2017-12-26T23:00:00+00:00",
      "favorite": true,
      "is_activated": true,
      "legal_terms": "<string>",
      "max_amount": 250,
      "max_cashbacks_per_consumer": 123,
      "merchant": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "min_amount": 40,
      "network": "739c5ba7-8831-4664-9ce3-73e9f1e50c09",
      "picture": {
        "content_type": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "links": {
          "download": "<string>",
          "preview": "<string>"
        },
        "name": "<string>",
        "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "program": {
        "id": "<string>",
        "legal_terms": "<string>",
        "name": "<string>"
      },
      "publication_date": "2019-01-01T00:00:00+00:00",
      "reference": "MYBRAND-20180220-001",
      "segments": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946"
        }
      ],
      "source_transaction": true,
      "start_date": "2018-12-21T00:00:00+00:00",
      "universes": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "name": "<string>"
        }
      ]
    }
  ],
  "phone_number": "0102030405",
  "siret": 81968937300010,
  "website": "https://www.paylead.fr/",
  "zip_code": 84120
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

store_id

string<uuid>

required

Unique ID of the store on PayLead system.

Response

name

string

required

read-only

Name of the store

Example:

"MY LITTLE BRAND PARIS"

address

string | null

read-only

Address of the Store

Example:

"55 rue des moulins"

brand

object

Show child attributes

business_name

string | null

read-only

Business Name (Legal) of the store

Example:

"MY BRAND SARL"

city

string | null

read-only

City of the store

Example:

"Paris"

country

string | null

read-only

Country of the store

Example:

"France"

created_at

string<date-time> | null

read-only

Object creation datetime

Example:

"2019-01-31T15:16:15.523309+00:00"

string<uuid>

read-only

Unique ID of the object.

Example:

"e2c32b4b-de61-459b-accf-a75f76247946"

is_online

boolean | null

read-only

TRUE if the store is online (no address, no geolocation, url); FALSE if the store is physical

Example:

true

latitude

number | null

read-only

Latitude of the store

Example:

50.51534475

longitude

number | null

read-only

Longitude of the store

Example:

6.0646992

merchant

object

Show child attributes

networks

object[]

read-only

networks

Show child attributes

offers

object[]

read-only

Best available offer for current user (or generic user) in this store. The best available offer is the offer that is:

Available for the current store
Eligible for the current user
proposing the best cashback rate

Option 1
Option 2
Option 3

Show child attributes

phone_number

string | null

read-only

Phone number of the store

Example:

"0102030405"

siret

string | null

SIRET of the current Store. Siret is a 14-digit business identification number managed by INSEE. The Siret consists of the Siren number of 9 digits which identifies the company, a 4-digit number to identify the establishment and 1 digit forming a control key to verify Luhn's algorithm

Example:

81968937300010

website

string<url> | null

read-only

URL of a brand website

Example:

"https://www.paylead.fr/"

zip_code

string | null

read-only

Zip code of the store

Example:

84120

⌘I

Get Store Detail

curl --request GET \
  --url https://api.sandbox.paylead.tech/stores/{store_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/stores/{store_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.sandbox.paylead.tech/stores/{store_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>"
  ],
]);

$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.sandbox.paylead.tech/stores/{store_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/stores/{store_id}")

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

{
  "name": "MY LITTLE BRAND PARIS",
  "address": "55 rue des moulins",
  "brand": {
    "name": "<string>",
    "created_at": "2019-01-31T15:16:15.523309+00:00",
    "id": "e2c32b4b-de61-459b-accf-a75f76247946",
    "logo": {
      "content_type": "<string>",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "updated_at": "2020-01-23T12:00:00+00:00"
  },
  "business_name": "MY BRAND SARL",
  "city": "Paris",
  "country": "France",
  "created_at": "2019-01-31T15:16:15.523309+00:00",
  "id": "e2c32b4b-de61-459b-accf-a75f76247946",
  "is_online": true,
  "latitude": 50.51534475,
  "longitude": 6.0646992,
  "merchant": {
    "id": "e2c32b4b-de61-459b-accf-a75f76247946",
    "name": "<string>",
    "created_at": "2019-01-31T15:16:15.523309+00:00",
    "has_delegation": true,
    "logo": {
      "content_type": "<string>",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "networks": [
    {
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "logo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stores_total": 123
    }
  ],
  "offers": [
    {
      "cashback_rate": 5,
      "highlight_level": "HIGH",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "name": "<string>",
      "status": "<string>",
      "type": "CASHBACK",
      "application_channel": "ONLINE",
      "application_url": "https://www.mybrand.fr",
      "brand": {
        "description": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "legal_terms": "<string>",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "<string>",
        "universes": [
          {
            "children": "<array>",
            "id": "e2c32b4b-de61-459b-accf-a75f76247946",
            "name": "<string>",
            "parent_id": "5c5e6d04-9dfc-46b8-9432-7c977f1dca23"
          }
        ]
      },
      "consumed": true,
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "description": "<string>",
      "end_date": "2017-12-26T23:00:00+00:00",
      "favorite": true,
      "is_activated": true,
      "legal_terms": "<string>",
      "max_amount": 250,
      "max_cashbacks_per_consumer": 123,
      "merchant": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "min_amount": 40,
      "network": "739c5ba7-8831-4664-9ce3-73e9f1e50c09",
      "picture": {
        "content_type": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "links": {
          "download": "<string>",
          "preview": "<string>"
        },
        "name": "<string>",
        "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "program": {
        "id": "<string>",
        "legal_terms": "<string>",
        "name": "<string>"
      },
      "publication_date": "2019-01-01T00:00:00+00:00",
      "reference": "MYBRAND-20180220-001",
      "segments": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946"
        }
      ],
      "source_transaction": true,
      "start_date": "2018-12-21T00:00:00+00:00",
      "universes": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "name": "<string>"
        }
      ]
    }
  ],
  "phone_number": "0102030405",
  "siret": 81968937300010,
  "website": "https://www.paylead.fr/",
  "zip_code": 84120
}

Banks

Bank Synchronization

Brands

User

Accounts

Payment Account

Reward

Metrics

Offers

Offer

Personal Finance Manager

Pools

Policies

Authentication

Store

Segment

Files

Universe

Get Store Detail

Authorizations

Path Parameters

Response