Initiate Cashback Delivery

POST

cashbacks

deliver

curl --request POST \
  --url https://api.cleverhub.co/api/v2/cashbacks/deliver \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "user_id": "8GAVZZKTI3",
  "payment_method": "pay_id",
  "client_transaction_id": "delivery_8263e133e2",
  "purchase_amount": 500,
  "campaign_id": "LOQVYIM0",
  "currency": "aud",
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_headers": "Bearer your_token"
  },
  "transaction_date": "2024-10-09",
  "transaction_time": "00:00:11"
}
'

import requests

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

payload = {
    "user_id": "8GAVZZKTI3",
    "payment_method": "pay_id",
    "client_transaction_id": "delivery_8263e133e2",
    "purchase_amount": 500,
    "campaign_id": "LOQVYIM0",
    "currency": "aud",
    "webhook_notification": {
        "endpoint_url": "https://merchant.example.com/webhook",
        "authorization_headers": "Bearer your_token"
    },
    "transaction_date": "2024-10-09",
    "transaction_time": "00:00:11"
}
headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'app-id': '<api-key>',
    'secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: '8GAVZZKTI3',
    payment_method: 'pay_id',
    client_transaction_id: 'delivery_8263e133e2',
    purchase_amount: 500,
    campaign_id: 'LOQVYIM0',
    currency: 'aud',
    webhook_notification: {
      endpoint_url: 'https://merchant.example.com/webhook',
      authorization_headers: 'Bearer your_token'
    },
    transaction_date: '2024-10-09',
    transaction_time: '00:00:11'
  })
};

fetch('https://api.cleverhub.co/api/v2/cashbacks/deliver', 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/deliver",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '8GAVZZKTI3',
    'payment_method' => 'pay_id',
    'client_transaction_id' => 'delivery_8263e133e2',
    'purchase_amount' => 500,
    'campaign_id' => 'LOQVYIM0',
    'currency' => 'aud',
    'webhook_notification' => [
        'endpoint_url' => 'https://merchant.example.com/webhook',
        'authorization_headers' => 'Bearer your_token'
    ],
    'transaction_date' => '2024-10-09',
    'transaction_time' => '00:00:11'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"payment_method\": \"pay_id\",\n  \"client_transaction_id\": \"delivery_8263e133e2\",\n  \"purchase_amount\": 500,\n  \"campaign_id\": \"LOQVYIM0\",\n  \"currency\": \"aud\",\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  },\n  \"transaction_date\": \"2024-10-09\",\n  \"transaction_time\": \"00:00:11\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cleverhub.co/api/v2/cashbacks/deliver")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"payment_method\": \"pay_id\",\n  \"client_transaction_id\": \"delivery_8263e133e2\",\n  \"purchase_amount\": 500,\n  \"campaign_id\": \"LOQVYIM0\",\n  \"currency\": \"aud\",\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  },\n  \"transaction_date\": \"2024-10-09\",\n  \"transaction_time\": \"00:00:11\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"payment_method\": \"pay_id\",\n  \"client_transaction_id\": \"delivery_8263e133e2\",\n  \"purchase_amount\": 500,\n  \"campaign_id\": \"LOQVYIM0\",\n  \"currency\": \"aud\",\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  },\n  \"transaction_date\": \"2024-10-09\",\n  \"transaction_time\": \"00:00:11\"\n}"

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

{
  "id": "JTDOL51K",
  "client_transaction_id": "8263e133e2",
  "transaction_type": "money_in",
  "balance_id": "B283A882-18A4C85E",
  "campaign_id": "NBAOZMPR",
  "site_id": "3BAVFJ6H",
  "purchase_amount": 500,
  "payment_method": "pay_id",
  "customer_id": "8GAVZZKTI3",
  "cashback_amount": 25,
  "status": "settled",
  "created_at": "2024-11-06T16:49:44.402Z",
  "updated_at": "2024-11-06T16:49:44.402Z",
  "transaction_date": "2024-10-09",
  "transaction_time": "00:00:11",
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_headers": "Bearer your_token"
  }
}

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.

Body

application/json

user_id

string

required

The unique identifier of the user receiving the cashback.

Example:

"8GAVZZKTI3"

payment_method

string

required

The payment method used in the transaction (e.g., "pay_id").

Example:

"pay_id"

client_transaction_id

string

required

A unique identifier for the transaction on the client's side to prevent duplicate processing.

Example:

"delivery_8263e133e2"

purchase_amount

integer

required

The total amount of the purchase for which cashback is applicable, in minor units (e.g., 500 for $5.00).

Example:

500

campaign_id

string

required

The unique identifier (UUID) of the cashback campaign associated with this transaction.

Example:

"LOQVYIM0"

currency

string

required

The currency code of the transaction, following ISO 4217 standards (e.g., "aud" for Australian Dollar). Default is "aud".

Example:

"aud"

webhook_notification

object

required

Details for sending a webhook notification after processing the transaction.

Show child attributes

transaction_date

string<date>

The date of the transaction in "YYYY-MM-DD" format.

Example:

"2024-10-09"

transaction_time

string<time>

The time of the transaction in "HH:mm:ss" format.

Example:

"00:00:11"

Callbacks

POST

{$request.body#/webhook_notification/endpoint_url}cashbackDeliveryCallback

Body

application/json

string

The unique identifier for the cashback transaction.

client_transaction_id

string

The client's unique transaction identifier.

transaction_type

string

The type of transaction ("money_in").

balance_id

string

The unique identifier for the balance transaction.

campaign_id

string

The unique identifier of the cashback campaign.

site_id

string

The unique identifier of the site.

purchase_amount

number<float>

The purchase amount.

payment_method

string

The payment method used.

customer_id

string

The customer's unique identifier.

cashback_amount

number<float>

The cashback amount awarded.

status

string

The status of the transaction ("settled" or "failed").

created_at

string<date-time>

The timestamp when the transaction was created.

updated_at

string<date-time>

The timestamp when the transaction was last updated.

transaction_date

string<date>

The date of the transaction.

transaction_time

string<time>

The time of the transaction.

webhook_notification

object

Configuration for the webhook notification.

Show child attributes

Response

Callback received successfully.

Response

Cashback delivered successfully.

string

The unique identifier for this cashback transaction in Hello Clever's system.

Example:

"JTDOL51K"

client_transaction_id

string

The client's unique transaction identifier.

Example:

"8263e133e2"

transaction_type

string

The type of transaction, indicating the flow of money (e.g., "money_in" for cashback deposits).

Example:

"money_in"

balance_id

string

The unique identifier for the balance transaction in Hello Clever's dashboard linked to this transaction.

Example:

"B283A882-18A4C85E"

campaign_id

string

The unique identifier of the cashback campaign.

Example:

"NBAOZMPR"

site_id

string

The unique identifier of the site where the transaction occurred.

Example:

"3BAVFJ6H"

purchase_amount

number<float>

The total amount of the purchase for which cashback applies, in major units (e.g., 500.0 for $500.00).

Example:

500

payment_method

string

The payment method used in the transaction.

Example:

"pay_id"

customer_id

string

The unique identifier of the customer receiving the cashback.

Example:

"8GAVZZKTI3"

cashback_amount

number<float>

The amount of cashback awarded in the transaction, in major units.

Example:

25

status

string

The status of the cashback transaction. Possible values are "created", "processing", "settled", or "failed".

Example:

"settled"

created_at

string<date-time>

The timestamp when the transaction was created.

Example:

"2024-11-06T16:49:44.402Z"

updated_at

string<date-time>

The timestamp when the transaction was last updated.

Example:

"2024-11-06T16:49:44.402Z"

transaction_date

string<date>

The date of the transaction as provided by the client.

Example:

"2024-10-09"

transaction_time

string<time>

The time of the transaction as provided by the client.

Example:

"00:00:11"

webhook_notification

object

Configuration for sending webhook notifications.

Show child attributes

Activate User's Cashback Account

Initiate Cashback Withdrawal

Initiate Cashback Delivery

curl --request POST \
  --url https://api.cleverhub.co/api/v2/cashbacks/deliver \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "user_id": "8GAVZZKTI3",
  "payment_method": "pay_id",
  "client_transaction_id": "delivery_8263e133e2",
  "purchase_amount": 500,
  "campaign_id": "LOQVYIM0",
  "currency": "aud",
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_headers": "Bearer your_token"
  },
  "transaction_date": "2024-10-09",
  "transaction_time": "00:00:11"
}
'

import requests

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

payload = {
    "user_id": "8GAVZZKTI3",
    "payment_method": "pay_id",
    "client_transaction_id": "delivery_8263e133e2",
    "purchase_amount": 500,
    "campaign_id": "LOQVYIM0",
    "currency": "aud",
    "webhook_notification": {
        "endpoint_url": "https://merchant.example.com/webhook",
        "authorization_headers": "Bearer your_token"
    },
    "transaction_date": "2024-10-09",
    "transaction_time": "00:00:11"
}
headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'app-id': '<api-key>',
    'secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: '8GAVZZKTI3',
    payment_method: 'pay_id',
    client_transaction_id: 'delivery_8263e133e2',
    purchase_amount: 500,
    campaign_id: 'LOQVYIM0',
    currency: 'aud',
    webhook_notification: {
      endpoint_url: 'https://merchant.example.com/webhook',
      authorization_headers: 'Bearer your_token'
    },
    transaction_date: '2024-10-09',
    transaction_time: '00:00:11'
  })
};

fetch('https://api.cleverhub.co/api/v2/cashbacks/deliver', 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/deliver",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '8GAVZZKTI3',
    'payment_method' => 'pay_id',
    'client_transaction_id' => 'delivery_8263e133e2',
    'purchase_amount' => 500,
    'campaign_id' => 'LOQVYIM0',
    'currency' => 'aud',
    'webhook_notification' => [
        'endpoint_url' => 'https://merchant.example.com/webhook',
        'authorization_headers' => 'Bearer your_token'
    ],
    'transaction_date' => '2024-10-09',
    'transaction_time' => '00:00:11'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"payment_method\": \"pay_id\",\n  \"client_transaction_id\": \"delivery_8263e133e2\",\n  \"purchase_amount\": 500,\n  \"campaign_id\": \"LOQVYIM0\",\n  \"currency\": \"aud\",\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  },\n  \"transaction_date\": \"2024-10-09\",\n  \"transaction_time\": \"00:00:11\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cleverhub.co/api/v2/cashbacks/deliver")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"payment_method\": \"pay_id\",\n  \"client_transaction_id\": \"delivery_8263e133e2\",\n  \"purchase_amount\": 500,\n  \"campaign_id\": \"LOQVYIM0\",\n  \"currency\": \"aud\",\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  },\n  \"transaction_date\": \"2024-10-09\",\n  \"transaction_time\": \"00:00:11\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"payment_method\": \"pay_id\",\n  \"client_transaction_id\": \"delivery_8263e133e2\",\n  \"purchase_amount\": 500,\n  \"campaign_id\": \"LOQVYIM0\",\n  \"currency\": \"aud\",\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  },\n  \"transaction_date\": \"2024-10-09\",\n  \"transaction_time\": \"00:00:11\"\n}"

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

{
  "id": "JTDOL51K",
  "client_transaction_id": "8263e133e2",
  "transaction_type": "money_in",
  "balance_id": "B283A882-18A4C85E",
  "campaign_id": "NBAOZMPR",
  "site_id": "3BAVFJ6H",
  "purchase_amount": 500,
  "payment_method": "pay_id",
  "customer_id": "8GAVZZKTI3",
  "cashback_amount": 25,
  "status": "settled",
  "created_at": "2024-11-06T16:49:44.402Z",
  "updated_at": "2024-11-06T16:49:44.402Z",
  "transaction_date": "2024-10-09",
  "transaction_time": "00:00:11",
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_headers": "Bearer your_token"
  }
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Initiate Cashback Delivery

Authorizations

Body

Callbacks

Body

Response

Response