Skip to main content
GET
/
connectors
/
m2m
/
ventilations
/
rewards
/
cashbacks
Get the Cashbacks ventilation file
curl --request GET \
  --url https://api.sandbox.paylead.tech/connectors/m2m/ventilations/rewards/cashbacks \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sandbox.paylead.tech/connectors/m2m/ventilations/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/m2m/ventilations/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/m2m/ventilations/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/m2m/ventilations/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/m2m/ventilations/rewards/cashbacks")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/m2m/ventilations/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": "<unknown>",
      "execution_date": "<unknown>",
      "fee_invoice_id": "<unknown>",
      "fee_invoice_reference": "<unknown>",
      "invoicing_cycle": "<string>",
      "payout_id": "<unknown>",
      "status": "<unknown>"
    }
  ],
  "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.

Query Parameters

execution_date
string

Filter by execution_date

fee_invoice_id
string<uuid>

Filter by fee_invoice_id

page
integer

the page number

Required range: x >= 1
payout_id
string<uuid>

Filter by payout_id

payout_status
enum<string>

Filter by payout_status

Available options:
TODO,
PENDING,
CREATED,
VALIDATED,
REJECTED,
ERROR,
DEACTIVATED
per_page
integer

the number of elements per page

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

Sort by given attribute

Available options:
status,
payout_status,
execution_date,
fee_invoice_id,
payout_id,
-status,
-payout_status,
-execution_date,
-fee_invoice_id,
-payout_id
status
enum<string>

Filter by status

Available options:
PENDING,
VALIDATED,
PAID,
ERROR

Response

OK

items
object[]
meta
object