Retrieves a reward.

GET

connectors

consumers

{consumer_id}

rewards

cashbacks

{cashback_id}

Retrieves a reward.

curl --request GET \
  --url https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

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/{cashback_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/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_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/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_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))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_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

{
  "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>",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    }
  },
  "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>",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    },
    "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>",
        "created_at": "2019-01-31T15:16:15.523309+00:00",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "links": {
          "download": "<string>",
          "preview": "<string>"
        },
        "name": "<string>",
        "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "path": "<string>"
      },
      "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",
    "frequency": 123,
    "frequency_counter": 123,
    "is_consumed": true,
    "is_favorite": true,
    "legal_terms": "<string>",
    "max_amount": 250,
    "max_cashbacks_per_consumer": 123,
    "max_limit_transaction_amount": 123,
    "min_amount": 40,
    "picture": {
      "content_type": "<string>",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    },
    "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"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

cashback_id

string<uuid>

required

Unique ID of the cashback reward.

consumer_id

string

required

The id you used to create the given consumer

Response

amount

number

required

read-only

Amount of the transaction

Example:

-23.68

string<uuid>

required

read-only

Unique ID of the object.

Example:

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

cancellation_date

string<date-time> | null

read-only

Date of cancellation by the merchant of a reward

Example:

"2019-01-23T12:00:00+00:00"

cancellation_reason

string | null

read-only

Text message explaining the reason of cancellation

Example:

"Transaction has been deleted"

created_at

string<date-time>

read-only

Object creation datetime

Example:

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

estimated_payment_date

string<date-time>

read-only

Estimation date of the credit on the pool of the reward

Example:

"2019-01-23T12:00:00+00:00"

merchant

object

Option 1
Option 2

Show child attributes

payment_date

string<date-time> | null

read-only

Actual credit date on the pool of the reward

Example:

"2019-01-23T12:00:00+00:00"

pending_validation_date

string<date-time> | null

read-only

The date when the validation period of the reward starts

Example:

"2019-01-23T12:00:00+00:00"

status

string

read-only

Status of the cashback:

PENDING_VALIDATION: The cashback has been generated from the transaction date, but the merchant can cancel the cashback because within the validation period (e.g. 14 days)
VALIDATED: The merchant hasn't cancelled the cashback and we are out of the validation period. This cashback is meant to be paid by the merchant on the first open day of the month and can't be cancelled anymore.
PAID_IN: Cashback has been paid by the merchant and is collected by our PSP.
PAID_OUT: Consumer collected his/her cashback (whether manually or automatically, triggered by your pay out threshold).
ERROR: Something went wrong with the cashback (technical).
CANCELLED: Cancelled by the merchant. The cashback is not considered as due anymore. Most of the time, because the purchased item has been returned to the merchant.

Example:

"VALIDATED"

transaction

object

Show child attributes

transfer_date

string<date-time> | null

read-only

The date where the reward is actually paid to the consumer

Example:

"2019-01-23T12:00:00+00:00"

universe

object

Option 1
Option 2

Show child attributes

user_offer

object

Show child attributes

validation_date

string<date-time> | null

read-only

End of the validation period, the merchant can't cancel the reward anymore

validation_estimated_date

string<date-time>

read-only

Estimation of the end of the validation period

Rewards cashback timelineReturns this specific rewards timeline, i.e. all the different states of this cashback, through time.

⌘I

Retrieves a reward.

curl --request GET \
  --url https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

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/{cashback_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/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_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/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_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))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/cashbacks/{cashback_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

{
  "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>",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    }
  },
  "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>",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    },
    "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>",
        "created_at": "2019-01-31T15:16:15.523309+00:00",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "links": {
          "download": "<string>",
          "preview": "<string>"
        },
        "name": "<string>",
        "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "path": "<string>"
      },
      "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",
    "frequency": 123,
    "frequency_counter": 123,
    "is_consumed": true,
    "is_favorite": true,
    "legal_terms": "<string>",
    "max_amount": 250,
    "max_cashbacks_per_consumer": 123,
    "max_limit_transaction_amount": 123,
    "min_amount": 40,
    "picture": {
      "content_type": "<string>",
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "links": {
        "download": "<string>",
        "preview": "<string>"
      },
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>"
    },
    "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"
}