Initiate Cashback Withdrawal

POST

cashbacks

withdraw

curl --request POST \
  --url https://api.cleverhub.co/api/v2/cashbacks/withdraw \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "user_id": "8GAVZZKTI3",
  "client_transaction_id": "withdraw_r15e23",
  "cashback_transaction_detail": {
    "amount": 1000,
    "payout_method_name": "au_bank_npp_aud",
    "payout_method_params": {
      "bsb": "572505",
      "account_number": "76273288"
    },
    "payment_description": "Withdrawal to bank account",
    "currency": "AUD"
  },
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_headers": "Bearer your_token"
  }
}
'

import requests

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

payload = {
    "user_id": "8GAVZZKTI3",
    "client_transaction_id": "withdraw_r15e23",
    "cashback_transaction_detail": {
        "amount": 1000,
        "payout_method_name": "au_bank_npp_aud",
        "payout_method_params": {
            "bsb": "572505",
            "account_number": "76273288"
        },
        "payment_description": "Withdrawal to bank account",
        "currency": "AUD"
    },
    "webhook_notification": {
        "endpoint_url": "https://merchant.example.com/webhook",
        "authorization_headers": "Bearer your_token"
    }
}
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',
    client_transaction_id: 'withdraw_r15e23',
    cashback_transaction_detail: {
      amount: 1000,
      payout_method_name: 'au_bank_npp_aud',
      payout_method_params: {bsb: '572505', account_number: '76273288'},
      payment_description: 'Withdrawal to bank account',
      currency: 'AUD'
    },
    webhook_notification: {
      endpoint_url: 'https://merchant.example.com/webhook',
      authorization_headers: 'Bearer your_token'
    }
  })
};

fetch('https://api.cleverhub.co/api/v2/cashbacks/withdraw', 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/withdraw",
  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',
    'client_transaction_id' => 'withdraw_r15e23',
    'cashback_transaction_detail' => [
        'amount' => 1000,
        'payout_method_name' => 'au_bank_npp_aud',
        'payout_method_params' => [
                'bsb' => '572505',
                'account_number' => '76273288'
        ],
        'payment_description' => 'Withdrawal to bank account',
        'currency' => 'AUD'
    ],
    'webhook_notification' => [
        'endpoint_url' => 'https://merchant.example.com/webhook',
        'authorization_headers' => 'Bearer your_token'
    ]
  ]),
  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/withdraw"

	payload := strings.NewReader("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"client_transaction_id\": \"withdraw_r15e23\",\n  \"cashback_transaction_detail\": {\n    \"amount\": 1000,\n    \"payout_method_name\": \"au_bank_npp_aud\",\n    \"payout_method_params\": {\n      \"bsb\": \"572505\",\n      \"account_number\": \"76273288\"\n    },\n    \"payment_description\": \"Withdrawal to bank account\",\n    \"currency\": \"AUD\"\n  },\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  }\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/withdraw")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"client_transaction_id\": \"withdraw_r15e23\",\n  \"cashback_transaction_detail\": {\n    \"amount\": 1000,\n    \"payout_method_name\": \"au_bank_npp_aud\",\n    \"payout_method_params\": {\n      \"bsb\": \"572505\",\n      \"account_number\": \"76273288\"\n    },\n    \"payment_description\": \"Withdrawal to bank account\",\n    \"currency\": \"AUD\"\n  },\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"client_transaction_id\": \"withdraw_r15e23\",\n  \"cashback_transaction_detail\": {\n    \"amount\": 1000,\n    \"payout_method_name\": \"au_bank_npp_aud\",\n    \"payout_method_params\": {\n      \"bsb\": \"572505\",\n      \"account_number\": \"76273288\"\n    },\n    \"payment_description\": \"Withdrawal to bank account\",\n    \"currency\": \"AUD\"\n  },\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  }\n}"

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

{
  "transaction_type": "money_out",
  "withdrawal_id": "HQ2GGUO7",
  "client_transaction_id": "r15e23",
  "merchant_name": "Hello Clever",
  "site_name": "Cashback",
  "customer_id": "8GAVZZKTI3",
  "amount": 10,
  "withdrawal_method": "au_bank_npp_aud",
  "status": "processing",
  "created_at": "2024-11-07T02:32:42.200Z",
  "updated_at": "2024-11-07T02:32:42.231Z",
  "payout_method_params": {
    "bsb": "572505",
    "account_number": "76273288"
  },
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_header": "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 customer withdrawing cashback.

Example:

"8GAVZZKTI3"

client_transaction_id

string

required

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

Example:

"withdraw_r15e23"

cashback_transaction_detail

object

required

Contains details for processing the cashback payout.

Show child attributes

webhook_notification

object

required

Webhook notification details for callback after processing the payout.

Show child attributes

Callbacks

POST

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

Body

application/json

transaction_type

string

The type of transaction ("money_out").

withdrawal_id

string

The unique identifier for the withdrawal transaction.

client_transaction_id

string

The client's transaction identifier.

merchant_name

string

The merchant's name.

site_name

string

The site name.

customer_id

string

The customer's unique identifier.

amount

number<float>

The amount withdrawn.

withdrawal_method

string

The method used for withdrawal.

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.

payout_method_params

object

The parameters used for the payout method.

Option 1
Option 2

Show child attributes

webhook_notification

object

Details for webhook notification after the transaction is processed.

Show child attributes

Response

Callback received successfully.

Response

Withdrawal initiated successfully.

transaction_type

string

Specifies the type of transaction ("money_out" for withdrawal).

Example:

"money_out"

withdrawal_id

string

The unique identifier for this withdrawal transaction.

Example:

"HQ2GGUO7"

client_transaction_id

string

The client's unique transaction identifier.

Example:

"r15e23"

merchant_name

string

The name of the merchant associated with the withdrawal.

Example:

"Hello Clever"

site_name

string

The name of the site where the withdrawal is processed.

Example:

"Cashback"

customer_id

string

The unique identifier of the customer withdrawing cashback.

Example:

"8GAVZZKTI3"

amount

number<float>

The amount of cashback withdrawn, in major units.

Example:

10

withdrawal_method

string

The method used for the withdrawal (e.g., "au_bank_npp_aud").

Example:

"au_bank_npp_aud"

status

string

The current status of the transaction (e.g., "processing").

Example:

"processing"

created_at

string<date-time>

The timestamp when the transaction was created.

Example:

"2024-11-07T02:32:42.200Z"

updated_at

string<date-time>

The timestamp when the transaction was last updated.

Example:

"2024-11-07T02:32:42.231Z"

payout_method_params

object

The parameters used for the payout method.

Option 1
Option 2

Show child attributes

webhook_notification

object

Details for webhook notification after the transaction is processed.

Show child attributes

Initiate Cashback Delivery

Get User List

Initiate Cashback Withdrawal

curl --request POST \
  --url https://api.cleverhub.co/api/v2/cashbacks/withdraw \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "user_id": "8GAVZZKTI3",
  "client_transaction_id": "withdraw_r15e23",
  "cashback_transaction_detail": {
    "amount": 1000,
    "payout_method_name": "au_bank_npp_aud",
    "payout_method_params": {
      "bsb": "572505",
      "account_number": "76273288"
    },
    "payment_description": "Withdrawal to bank account",
    "currency": "AUD"
  },
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_headers": "Bearer your_token"
  }
}
'

import requests

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

payload = {
    "user_id": "8GAVZZKTI3",
    "client_transaction_id": "withdraw_r15e23",
    "cashback_transaction_detail": {
        "amount": 1000,
        "payout_method_name": "au_bank_npp_aud",
        "payout_method_params": {
            "bsb": "572505",
            "account_number": "76273288"
        },
        "payment_description": "Withdrawal to bank account",
        "currency": "AUD"
    },
    "webhook_notification": {
        "endpoint_url": "https://merchant.example.com/webhook",
        "authorization_headers": "Bearer your_token"
    }
}
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',
    client_transaction_id: 'withdraw_r15e23',
    cashback_transaction_detail: {
      amount: 1000,
      payout_method_name: 'au_bank_npp_aud',
      payout_method_params: {bsb: '572505', account_number: '76273288'},
      payment_description: 'Withdrawal to bank account',
      currency: 'AUD'
    },
    webhook_notification: {
      endpoint_url: 'https://merchant.example.com/webhook',
      authorization_headers: 'Bearer your_token'
    }
  })
};

fetch('https://api.cleverhub.co/api/v2/cashbacks/withdraw', 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/withdraw",
  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',
    'client_transaction_id' => 'withdraw_r15e23',
    'cashback_transaction_detail' => [
        'amount' => 1000,
        'payout_method_name' => 'au_bank_npp_aud',
        'payout_method_params' => [
                'bsb' => '572505',
                'account_number' => '76273288'
        ],
        'payment_description' => 'Withdrawal to bank account',
        'currency' => 'AUD'
    ],
    'webhook_notification' => [
        'endpoint_url' => 'https://merchant.example.com/webhook',
        'authorization_headers' => 'Bearer your_token'
    ]
  ]),
  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/withdraw"

	payload := strings.NewReader("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"client_transaction_id\": \"withdraw_r15e23\",\n  \"cashback_transaction_detail\": {\n    \"amount\": 1000,\n    \"payout_method_name\": \"au_bank_npp_aud\",\n    \"payout_method_params\": {\n      \"bsb\": \"572505\",\n      \"account_number\": \"76273288\"\n    },\n    \"payment_description\": \"Withdrawal to bank account\",\n    \"currency\": \"AUD\"\n  },\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  }\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/withdraw")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"8GAVZZKTI3\",\n  \"client_transaction_id\": \"withdraw_r15e23\",\n  \"cashback_transaction_detail\": {\n    \"amount\": 1000,\n    \"payout_method_name\": \"au_bank_npp_aud\",\n    \"payout_method_params\": {\n      \"bsb\": \"572505\",\n      \"account_number\": \"76273288\"\n    },\n    \"payment_description\": \"Withdrawal to bank account\",\n    \"currency\": \"AUD\"\n  },\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"client_transaction_id\": \"withdraw_r15e23\",\n  \"cashback_transaction_detail\": {\n    \"amount\": 1000,\n    \"payout_method_name\": \"au_bank_npp_aud\",\n    \"payout_method_params\": {\n      \"bsb\": \"572505\",\n      \"account_number\": \"76273288\"\n    },\n    \"payment_description\": \"Withdrawal to bank account\",\n    \"currency\": \"AUD\"\n  },\n  \"webhook_notification\": {\n    \"endpoint_url\": \"https://merchant.example.com/webhook\",\n    \"authorization_headers\": \"Bearer your_token\"\n  }\n}"

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

{
  "transaction_type": "money_out",
  "withdrawal_id": "HQ2GGUO7",
  "client_transaction_id": "r15e23",
  "merchant_name": "Hello Clever",
  "site_name": "Cashback",
  "customer_id": "8GAVZZKTI3",
  "amount": 10,
  "withdrawal_method": "au_bank_npp_aud",
  "status": "processing",
  "created_at": "2024-11-07T02:32:42.200Z",
  "updated_at": "2024-11-07T02:32:42.231Z",
  "payout_method_params": {
    "bsb": "572505",
    "account_number": "76273288"
  },
  "webhook_notification": {
    "endpoint_url": "https://merchant.example.com/webhook",
    "authorization_header": "Bearer your_token"
  }
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Initiate Cashback Withdrawal

Authorizations

Body

Callbacks

Body

Response

Response