Hello Clever Developer Docs

GET

payins

detail

Get Payin Details

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

import requests

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

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/payins/detail', 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/detail",
  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/payins/detail"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "uuid": "VMMAOTFQ",
  "name": "Hello Clever",
  "description": "description",
  "email": "test@example.com",
  "external_id": "123456",
  "status": "pending",
  "pay_code": {
    "payment_url": "https://sandbox-api.lightningpay.me/v1/shorted_url?hash=o10MJUBg"
  },
  "currency": "AUD",
  "gst": false,
  "amount": "1000.0",
  "gst_amount": "0",
  "total": "1000.0",
  "paid_amount": "0",
  "payment_method": "au_payid_npp_aud",
  "is_refundable": "false",
  "expired_at": "2021-12-23T06:00:00.000+0000",
  "pay_by": "2021-12-23T06:00:00.000+0000",
  "webhook_notification": {
    "endpoint_url": "https://yourserver.co/notifications",
    "authorization_header": "****"
  },
  "metadata": {
    "custom_note": "Priority customer"
  }
}

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

uuid

string

Unique ID in system.

Response

uuid

string

Unique Id in system.

Example:

"VMMAOTFQ"

name

string

Customer name.

Example:

"Test"

string

Customer email.

Example:

"test@example.com"

external_id

string

Custom ID.

Example:

"123456"

status

Example:

"pending"

pay_code

object

Code using pay

Show child attributes

currency

string

Example:

"PHP"

gst

boolean

Example:

false

amount

number

Example:

1000

gst_amount

number

Example:

0

total

number

Example:

1000

paid_amount

number

Example:

1000

payment_method

string

Example:

"ph_ewallet_gcash_php"

description

string

Example:

"description"

is_refundable

boolean

Example:

false

expired_at

string<date-time>

Example:

"2021-12-24T06:00:00.000+0000"

pay_by

string<date-time>

Example:

"2021-12-23T06:00:00.000+0000"

webhook_notification

object

Show child attributes

metadata

object

Optional custom metadata to attach to the transaction.

Get Payin Details

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

import requests

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

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/payins/detail', 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/detail",
  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/payins/detail"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "uuid": "VMMAOTFQ",
  "name": "Hello Clever",
  "description": "description",
  "email": "test@example.com",
  "external_id": "123456",
  "status": "pending",
  "pay_code": {
    "payment_url": "https://sandbox-api.lightningpay.me/v1/shorted_url?hash=o10MJUBg"
  },
  "currency": "AUD",
  "gst": false,
  "amount": "1000.0",
  "gst_amount": "0",
  "total": "1000.0",
  "paid_amount": "0",
  "payment_method": "au_payid_npp_aud",
  "is_refundable": "false",
  "expired_at": "2021-12-23T06:00:00.000+0000",
  "pay_by": "2021-12-23T06:00:00.000+0000",
  "webhook_notification": {
    "endpoint_url": "https://yourserver.co/notifications",
    "authorization_header": "****"
  },
  "metadata": {
    "custom_note": "Priority customer"
  }
}

Basics

Payment APIs

Card API

Cashback API

Get Payin Details

Authorizations

Query Parameters

Response