Hello Clever Developer Docs

POST

payins

refund

Refund Payin

curl --request POST \
  --url https://api.cleverhub.co/api/v2/payins/refund \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "uuid": "APU221YS",
  "description": "Partial Refund Reason",
  "amount": 10
}
'

import requests

url = "https://api.cleverhub.co/api/v2/payins/refund"

payload = {
    "uuid": "APU221YS",
    "description": "Partial Refund Reason",
    "amount": 10
}
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({uuid: 'APU221YS', description: 'Partial Refund Reason', amount: 10})
};

fetch('https://api.cleverhub.co/api/v2/payins/refund', 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/payins/refund",
  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([
    'uuid' => 'APU221YS',
    'description' => 'Partial Refund Reason',
    'amount' => 10
  ]),
  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/payins/refund"

	payload := strings.NewReader("{\n  \"uuid\": \"APU221YS\",\n  \"description\": \"Partial Refund Reason\",\n  \"amount\": 10\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/payins/refund")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"uuid\": \"APU221YS\",\n  \"description\": \"Partial Refund Reason\",\n  \"amount\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v2/payins/refund")

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  \"uuid\": \"APU221YS\",\n  \"description\": \"Partial Refund Reason\",\n  \"amount\": 10\n}"

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

{
  "uuid": "TYK80AI9",
  "name": "Hello Clever",
  "email": "test@example.com",
  "external_id": null,
  "status": "partially_refunded",
  "pay_code": {},
  "currency": "VND",
  "amount": "1000000.0",
  "total": "1000000.0",
  "paid_amount": "1000000.0",
  "is_refundable": true,
  "payment_method": "vn_other_vietqr_vnd",
  "expired_at": "",
  "webhook_notification": {
    "endpoint_url": "https://webhook.site/789d4a41-9a6a-4cd7-925e-6db7bddb13c3",
    "authorization_header": "****"
  },
  "description": "Test Payin",
  "gst": false,
  "gst_amount": 0,
  "pay_by": "2025-06-06T07:57:20.464+0000",
  "sender_details": null,
  "stage": "normal_stage",
  "refund_information": {
    "total_amount": "1000000.0",
    "refund_amount": "10.0",
    "description": "1234566"
  }
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "payment_request_id": "is invalid",
    "refund_amount": "can't be blank",
    "reason": "can't be blank"
  }
}

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

uuid

string

required

Payment request ID

Example:

"APU221YS"

description

string

required

Partial refund reason, must be at least 5 characters long

Example:

"Partial Refund Reason"

amount

number

Refund amount, must be numeric. If not specified, the refund amount will be the same as the total amount.

Example:

10

Response

Refund Started

uuid

string

Example:

"TYK80AI9"

name

string

Example:

"Hello Clever"

string

Example:

"test@example.com"

external_id

string | null

Example:

null

status

string

Example:

"partially_refunded"

pay_code

object

Example:

{}

currency

string

Example:

"VND"

amount

string

Example:

"1000000.0"

total

string

Example:

"1000000.0"

paid_amount

string

Example:

"1000000.0"

is_refundable

boolean

Example:

true

payment_method

string

Example:

"vn_other_vietqr_vnd"

expired_at

string

Example:

""

webhook_notification

object

Show child attributes

description

string

Example:

"Test Payin"

gst

boolean

Example:

false

gst_amount

number

Example:

0

pay_by

string<date-time>

Example:

"2025-06-06T07:57:20.464+0000"

sender_details

unknown

stage

string

Example:

"normal_stage"

refund_information

object

Show child attributes

Refund Payin

curl --request POST \
  --url https://api.cleverhub.co/api/v2/payins/refund \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "uuid": "APU221YS",
  "description": "Partial Refund Reason",
  "amount": 10
}
'

import requests

url = "https://api.cleverhub.co/api/v2/payins/refund"

payload = {
    "uuid": "APU221YS",
    "description": "Partial Refund Reason",
    "amount": 10
}
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({uuid: 'APU221YS', description: 'Partial Refund Reason', amount: 10})
};

fetch('https://api.cleverhub.co/api/v2/payins/refund', 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/payins/refund",
  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([
    'uuid' => 'APU221YS',
    'description' => 'Partial Refund Reason',
    'amount' => 10
  ]),
  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/payins/refund"

	payload := strings.NewReader("{\n  \"uuid\": \"APU221YS\",\n  \"description\": \"Partial Refund Reason\",\n  \"amount\": 10\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/payins/refund")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"uuid\": \"APU221YS\",\n  \"description\": \"Partial Refund Reason\",\n  \"amount\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v2/payins/refund")

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  \"uuid\": \"APU221YS\",\n  \"description\": \"Partial Refund Reason\",\n  \"amount\": 10\n}"

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

{
  "uuid": "TYK80AI9",
  "name": "Hello Clever",
  "email": "test@example.com",
  "external_id": null,
  "status": "partially_refunded",
  "pay_code": {},
  "currency": "VND",
  "amount": "1000000.0",
  "total": "1000000.0",
  "paid_amount": "1000000.0",
  "is_refundable": true,
  "payment_method": "vn_other_vietqr_vnd",
  "expired_at": "",
  "webhook_notification": {
    "endpoint_url": "https://webhook.site/789d4a41-9a6a-4cd7-925e-6db7bddb13c3",
    "authorization_header": "****"
  },
  "description": "Test Payin",
  "gst": false,
  "gst_amount": 0,
  "pay_by": "2025-06-06T07:57:20.464+0000",
  "sender_details": null,
  "stage": "normal_stage",
  "refund_information": {
    "total_amount": "1000000.0",
    "refund_amount": "10.0",
    "description": "1234566"
  }
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "payment_request_id": "is invalid",
    "refund_amount": "can't be blank",
    "reason": "can't be blank"
  }
}

Basics

Payment APIs

Card API

Cashback API

Refund Payin

Authorizations

Body

Response