Contact

Create Contact

When processing a Payin or Payout transaction, if the require_contact parameter is true, you need to create a new contact before proceeding with the transaction. Each contact will have a unique email associated with it, ensuring that the user’s information is complete before continuing with the payment process. This email will be used during the process of calling the API to create a Payin or Payout transaction.

After successfully creating the contact, you need to perform KYC (Know Your Customer) verification for this contact if the Payin or Payout methods require KYC(require_kyc == true). This will be done through the Submit KYC API provided below. If KYC is not required, you can proceed with the transaction process without further verification. Ensure that these steps are completed thoroughly and accurately to maintain security and compliance. Wishing you success in carrying out this process!

POST

contacts

Create Contact

curl --request POST \
  --url https://api.cleverhub.co/api/v2/contacts \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "email": "test@example.com",
  "first_name": "Luxy",
  "last_name": "Tran",
  "type": "individual",
  "dob": "1991-12-24",
  "reg_no": "123456789",
  "phone": "+6123224242",
  "gender": "male",
  "street": "338 George Street",
  "city": "Sydney",
  "postal_code": "2000",
  "state": "New South Wales",
  "country": "AU"
}
'

import requests

url = "https://api.cleverhub.co/api/v2/contacts"

payload = {
    "email": "test@example.com",
    "first_name": "Luxy",
    "last_name": "Tran",
    "type": "individual",
    "dob": "1991-12-24",
    "reg_no": "123456789",
    "phone": "+6123224242",
    "gender": "male",
    "street": "338 George Street",
    "city": "Sydney",
    "postal_code": "2000",
    "state": "New South Wales",
    "country": "AU"
}
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({
    email: 'test@example.com',
    first_name: 'Luxy',
    last_name: 'Tran',
    type: 'individual',
    dob: '1991-12-24',
    reg_no: '123456789',
    phone: '+6123224242',
    gender: 'male',
    street: '338 George Street',
    city: 'Sydney',
    postal_code: '2000',
    state: 'New South Wales',
    country: 'AU'
  })
};

fetch('https://api.cleverhub.co/api/v2/contacts', 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/contacts",
  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([
    'email' => 'test@example.com',
    'first_name' => 'Luxy',
    'last_name' => 'Tran',
    'type' => 'individual',
    'dob' => '1991-12-24',
    'reg_no' => '123456789',
    'phone' => '+6123224242',
    'gender' => 'male',
    'street' => '338 George Street',
    'city' => 'Sydney',
    'postal_code' => '2000',
    'state' => 'New South Wales',
    'country' => 'AU'
  ]),
  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/contacts"

	payload := strings.NewReader("{\n  \"email\": \"test@example.com\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\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/contacts")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"test@example.com\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"email\": \"test@example.com\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\n}"

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

{
  "email": "test@example.com"
}

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

{
  "errors": {
    "message": "Email 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

string

required

Contact's email. This email will be used during the process of calling the API to create a Payin or Payout transaction. A new contact must be created to continue the payment process.

first_name

string

required

Contact's first name

last_name

string

required

Contact's last name

type

enum<string>

required

The type of contact (e.g., individual or organization)

Available options:

individual,

organization

Example:

"individual"

dob

string

required

Contact's date of birth, format 'yyyy-mm-dd'

reg_no

string

required

Contact registration number, required if type is organization

phone

string

required

Contact's phone number

Example:

"+1234567890"

gender

enum<string>

required

Contact's gender

Available options:

male,

female

Example:

"male"

street

string

required

The primary name of an address's street for the contact.

city

string

required

Name of an address's city or town for the contact.

postal_code

string

required

The contact's address's postcode

state

string

required

The contact's address's state / province / county.

country

string

required

ISO 3166-1 alpha-2 country code of the contact's country.

Response

Created

string

Get Customer Details

Submit KYC

Create Contact

curl --request POST \
  --url https://api.cleverhub.co/api/v2/contacts \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "email": "test@example.com",
  "first_name": "Luxy",
  "last_name": "Tran",
  "type": "individual",
  "dob": "1991-12-24",
  "reg_no": "123456789",
  "phone": "+6123224242",
  "gender": "male",
  "street": "338 George Street",
  "city": "Sydney",
  "postal_code": "2000",
  "state": "New South Wales",
  "country": "AU"
}
'

import requests

url = "https://api.cleverhub.co/api/v2/contacts"

payload = {
    "email": "test@example.com",
    "first_name": "Luxy",
    "last_name": "Tran",
    "type": "individual",
    "dob": "1991-12-24",
    "reg_no": "123456789",
    "phone": "+6123224242",
    "gender": "male",
    "street": "338 George Street",
    "city": "Sydney",
    "postal_code": "2000",
    "state": "New South Wales",
    "country": "AU"
}
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({
    email: 'test@example.com',
    first_name: 'Luxy',
    last_name: 'Tran',
    type: 'individual',
    dob: '1991-12-24',
    reg_no: '123456789',
    phone: '+6123224242',
    gender: 'male',
    street: '338 George Street',
    city: 'Sydney',
    postal_code: '2000',
    state: 'New South Wales',
    country: 'AU'
  })
};

fetch('https://api.cleverhub.co/api/v2/contacts', 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/contacts",
  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([
    'email' => 'test@example.com',
    'first_name' => 'Luxy',
    'last_name' => 'Tran',
    'type' => 'individual',
    'dob' => '1991-12-24',
    'reg_no' => '123456789',
    'phone' => '+6123224242',
    'gender' => 'male',
    'street' => '338 George Street',
    'city' => 'Sydney',
    'postal_code' => '2000',
    'state' => 'New South Wales',
    'country' => 'AU'
  ]),
  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/contacts"

	payload := strings.NewReader("{\n  \"email\": \"test@example.com\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\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/contacts")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"test@example.com\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"email\": \"test@example.com\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\n}"

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

{
  "email": "test@example.com"
}

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

{
  "errors": {
    "message": "Email can't be blank"
  }
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Create Contact

Authorizations

Body

Response