Get Campaign Configurations

GET

cashbacks

configuration_campaign

curl --request GET \
  --url https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

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

print(response.text)

const options = {method: 'GET', headers: {'app-id': '<api-key>', 'secret-key': '<api-key>'}};

fetch('https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign', 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.cleverhub.co/api/v2/cashbacks/configuration_campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$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.cleverhub.co/api/v2/cashbacks/configuration_campaign"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

	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.cleverhub.co/api/v2/cashbacks/configuration_campaign")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "merchant_id": 123,
  "site_id": "site_123",
  "campaign_id": "campaign_456",
  "name": "Holiday Cashback Campaign",
  "max_payable_cashback_amount": {
    "in_whole_campaign_duration": null,
    "per_transaction": 50
  },
  "max_cashback_amount_receivable_per_user": 200,
  "time_schedule_response": {
    "start_time": "2024-11-05T16:20:00.000Z",
    "end_time": "2024-12-05T16:20:00.000Z",
    "start_time_repeat": null,
    "end_time_repeat": null,
    "repeat_days": [
      "Mon",
      "Wed",
      "Fri"
    ]
  },
  "payment_methods": [
    "pay_id",
    "pay_to",
    "card"
  ],
  "status": "active",
  "tiers": [
    {
      "cashback_type": "percentage",
      "cashback_value": 10,
      "absolute_type": "min_order",
      "absolute_value": 100
    }
  ]
}

Authorizations

app-id

string

header

required

A unique identifier assigned to each application.

secret-key

string

header

required

A secure token associated with the app-id.

Query Parameters

page

integer

default:1

The page number to retrieve in the paginated response. Defaults to 1 if not specified.

per_page

integer

default:10

The number of campaigns to display per page. Defaults to 10 if not specified.

status

string

Filter the campaigns by their status.

Response

A successful response containing cashback conditions and configurations.

merchant_id

integer

The unique identifier of the merchant associated with the campaign.

Example:

123

site_id

string

The unique identifier of the site where the campaign is active.

Example:

"site_123"

campaign_id

string

The unique identifier of the cashback campaign.

Example:

"campaign_456"

name

string

The name of the cashback campaign.

Example:

"Holiday Cashback Campaign"

max_payable_cashback_amount

object

Specifies maximum cashback amounts that can be paid out.

Show child attributes

max_cashback_amount_receivable_per_user

number | null

The maximum cashback amount each user can receive throughout the entire campaign. Null indicates no per-user limit.

Example:

200

time_schedule_response

object

The time schedule for the campaign, including start and end times, and any repeating schedule.

Show child attributes

payment_methods

string[]

A list of payment methods that are valid for the cashback program.

Example:

["pay_id", "pay_to", "card"]

status

string

The current status of the campaign.

Example:

"active"

tiers

object[]

A list of cashback tiers within the campaign, each defining specific cashback conditions and rewards.

Show child attributes

Get Cashback Campaign List

Activate User's Cashback Account

Get Campaign Configurations

curl --request GET \
  --url https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

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

print(response.text)

const options = {method: 'GET', headers: {'app-id': '<api-key>', 'secret-key': '<api-key>'}};

fetch('https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign', 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.cleverhub.co/api/v2/cashbacks/configuration_campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$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.cleverhub.co/api/v2/cashbacks/configuration_campaign"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

	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.cleverhub.co/api/v2/cashbacks/configuration_campaign")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "merchant_id": 123,
  "site_id": "site_123",
  "campaign_id": "campaign_456",
  "name": "Holiday Cashback Campaign",
  "max_payable_cashback_amount": {
    "in_whole_campaign_duration": null,
    "per_transaction": 50
  },
  "max_cashback_amount_receivable_per_user": 200,
  "time_schedule_response": {
    "start_time": "2024-11-05T16:20:00.000Z",
    "end_time": "2024-12-05T16:20:00.000Z",
    "start_time_repeat": null,
    "end_time_repeat": null,
    "repeat_days": [
      "Mon",
      "Wed",
      "Fri"
    ]
  },
  "payment_methods": [
    "pay_id",
    "pay_to",
    "card"
  ],
  "status": "active",
  "tiers": [
    {
      "cashback_type": "percentage",
      "cashback_value": 10,
      "absolute_type": "min_order",
      "absolute_value": 100
    }
  ]
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Get Campaign Configurations

Authorizations

Query Parameters

Response