Skip to main content
GET
/
connectors
/
consumers
/
{consumer_id}
/
rewards
/
cashbacks
Gets the list of cashbacks.
curl --request GET \
  --url https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks', 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/connectors/consumers/{consumer_id}/rewards/cashbacks",
  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/connectors/consumers/{consumer_id}/rewards/cashbacks"

	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.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks")

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
{
  "items": [
    {
      "amount": -23.68,
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "cancellation_date": "2019-01-23T12:00:00+00:00",
      "cancellation_reason": "Transaction has been deleted",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "estimated_payment_date": "2019-01-23T12:00:00+00:00",
      "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"
        }
      },
      "payment_date": "2019-01-23T12:00:00+00:00",
      "pending_validation_date": "2019-01-23T12:00:00+00:00",
      "status": "VALIDATED",
      "transaction": {
        "amount": -23.68,
        "executed_at": "2019-01-31T12:00:00+00:00",
        "descriptor": "MYBRAND",
        "external_id": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946"
      },
      "transfer_date": "2019-01-23T12:00:00+00:00",
      "universe": {
        "children": [
          {
            "children": "<array>",
            "id": "e2c32b4b-de61-459b-accf-a75f76247946",
            "name": "<string>",
            "parent_id": "5c5e6d04-9dfc-46b8-9432-7c977f1dca23"
          }
        ],
        "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"
        },
        "name": "<string>",
        "parent_id": "5c5e6d04-9dfc-46b8-9432-7c977f1dca23"
      },
      "user_offer": {
        "cashback_rate": 5,
        "highlight_level": "HIGH",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "name": "<string>",
        "reference": "MYBRAND-20180220-001",
        "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"
            }
          ]
        },
        "description": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "is_consumed": true,
        "is_favorite": true,
        "legal_terms": "<string>",
        "loyalty_counter": 123,
        "loyalty_frequency": 123,
        "max_amount": 250,
        "max_cashbacks_per_consumer": 123,
        "max_limit_transaction_amount": 123,
        "min_amount": 40,
        "picture": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "publication_date": "2019-01-01T00:00:00+00:00",
        "segments": [
          {
            "id": "e2c32b4b-de61-459b-accf-a75f76247946"
          }
        ],
        "source_transaction": true,
        "start_date": "2023-11-07T05:31:56Z"
      },
      "validation_date": "2023-11-07T05:31:56Z",
      "validation_estimated_date": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
consumer_id
string
required

The id you used to create the given consumer

Query Parameters

​
amount
number

Filter by amount

Amount of the transaction

​
created_at
string

Filter by created_at

Filtering on date of creation between -- after -- before --

​
descriptor
string

Filter by descriptor

Label of the transaction

​
loyalty_frequency
integer

Filter by loyalty_frequency

Number of purchases before the customer gets a reward.

​
loyalty_frequency__gt
integer

Filters all loyalty_frequency higher than those provided in loyalty_frequency__gt.

​
loyalty_frequency__isnull
boolean

Filters all offers depending on whether they are a loyalty_offer or not. If "true", retrieves all the Offers that are not of loyalty type. If "false", retrieves all the Offers of loyalty type.

​
page
integer

the page number

Required range: x >= 1
​
per_page
integer

the number of elements per page

Required range: 1 <= x <= 100
​
sort
enum<string>

Sort by given attribute

Available options:
amount,
status,
created_at,
user_offer__reference,
user_offer__id,
user_offer__name,
user_offer__brand__name,
descriptor,
transaction__amount,
transaction__score,
loyalty_frequency,
-amount,
-status,
-created_at,
-user_offer__reference,
-user_offer__id,
-user_offer__name,
-user_offer__brand__name,
-descriptor,
-transaction__amount,
-transaction__score,
-loyalty_frequency
​
status
enum<string>

Filter by status

Available options:
CANCELLED,
PENDING_VALIDATION,
VALIDATED,
PAID_IN,
PAID_OUT,
ERROR
​
transaction__amount
number

Filter by transaction__amount

​
transaction__score
integer

Filter by transaction__score

​
user_offer__brand__name
string

Filter by user_offer__brand__name

​
user_offer__id
string<uuid>

Filter by user_offer__id

​
user_offer__name
string

Filter by user_offer__name

​
user_offer__reference
string

Filter by user_offer__reference

Response

OK

​
items
object[]
​
meta
object