Retrieves an affiliation cashback.

GET

connectors

consumers

{consumer_id}

rewards

affiliation

cashbacks

{cashback_id}

Retrieves an affiliation cashback.

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

import requests

url = "https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/affiliation/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/affiliation/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/affiliation/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/affiliation/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/affiliation/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/affiliation/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",
  "pending_validation_date": "2018-11-28T16:52:47.768060+00:00",
  "status": "PENDING_VALIDATION",
  "transfer_date": "2019-01-23T12:00:00+00:00",
  "user_offer": {
    "reference": "MYBRAND-20180220-001",
    "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"
        }
      ]
    },
    "commissions": [
      {
        "name": "<string>",
        "type": "CASHBACK",
        "reward_fixed_amount": 123,
        "reward_rate": 50
      }
    ],
    "deep_link_url": "<unknown>",
    "description": "<string>",
    "end_date": "2018-12-21T00:00:00+00:00",
    "highlight_level": "HIGH",
    "id": "e2c32b4b-de61-459b-accf-a75f76247946",
    "is_consumed": true,
    "is_favorite": true,
    "legal_terms": "<string>",
    "max_fixed_reward_amount": 123,
    "max_reward_rate": 50,
    "name": "<string>",
    "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",
    "start_date": "2018-12-21T00:00:00+00:00",
    "status": "<string>"
  }
}

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"

pending_validation_date

string<date-time> | null

read-only

Date of the cashback pending validation status

Example:

"2018-11-28T16:52:47.768060+00:00"

status

string

read-only

Status of the affiliation cashback:

PENDING_VALIDATION: The reward is pending the payment from the merchant.
PAID_OUT: The reward has been paid to the program.
CANCELLED : Cancelled by the merchant or by a technical action.

Example:

"PENDING_VALIDATION"

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"

user_offer

object

Show child attributes

Gets the list of cashbacks. Returns the list of all the cashbacks generated for a consumer.

⌘I

Retrieves an affiliation cashback.

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

import requests

url = "https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/rewards/affiliation/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/affiliation/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/affiliation/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/affiliation/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/affiliation/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/affiliation/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",
  "pending_validation_date": "2018-11-28T16:52:47.768060+00:00",
  "status": "PENDING_VALIDATION",
  "transfer_date": "2019-01-23T12:00:00+00:00",
  "user_offer": {
    "reference": "MYBRAND-20180220-001",
    "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"
        }
      ]
    },
    "commissions": [
      {
        "name": "<string>",
        "type": "CASHBACK",
        "reward_fixed_amount": 123,
        "reward_rate": 50
      }
    ],
    "deep_link_url": "<unknown>",
    "description": "<string>",
    "end_date": "2018-12-21T00:00:00+00:00",
    "highlight_level": "HIGH",
    "id": "e2c32b4b-de61-459b-accf-a75f76247946",
    "is_consumed": true,
    "is_favorite": true,
    "legal_terms": "<string>",
    "max_fixed_reward_amount": 123,
    "max_reward_rate": 50,
    "name": "<string>",
    "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",
    "start_date": "2018-12-21T00:00:00+00:00",
    "status": "<string>"
  }
}