AUD BSB/Account Number

Create BSB/Account Number Payment

Initiate a payment request to a BSB and account number by specifying the amount, customer details, and additional attributes. This endpoint supports only Australian Dollar (AUD) payments. Transactions will be rejected if any of the required fields, such as Account Name, BSB Number, Account Number, Description, or Amount, are incorrect or missing.

This payment method provides flexibility in sending funds directly to Australian bank accounts, ideal for merchants needing BSB and account number transfers.

POST

merchants

create_bank_payment

Create BSB/Account Number Payment

curl --request POST \
  --url https://api.cleverhub.co/api/v1/merchants/create_bank_payment \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "name": "Jane Doe",
  "gst": true,
  "amount": 1000,
  "description": "Payment for invoice #1234",
  "emails": "customer@example.com",
  "payment_request_notification": {
    "endpoint_url": "https://example.com/payment_callback",
    "authorization_header": "Bearer your_token"
  },
  "expired_at": "2024-12-31T23:59:59Z",
  "external_id": "custom-id-12345"
}
'

import requests

url = "https://api.cleverhub.co/api/v1/merchants/create_bank_payment"

payload = {
    "name": "Jane Doe",
    "gst": True,
    "amount": 1000,
    "description": "Payment for invoice #1234",
    "emails": "customer@example.com",
    "payment_request_notification": {
        "endpoint_url": "https://example.com/payment_callback",
        "authorization_header": "Bearer your_token"
    },
    "expired_at": "2024-12-31T23:59:59Z",
    "external_id": "custom-id-12345"
}
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({
    name: 'Jane Doe',
    gst: true,
    amount: 1000,
    description: 'Payment for invoice #1234',
    emails: 'customer@example.com',
    payment_request_notification: {
      endpoint_url: 'https://example.com/payment_callback',
      authorization_header: 'Bearer your_token'
    },
    expired_at: '2024-12-31T23:59:59Z',
    external_id: 'custom-id-12345'
  })
};

fetch('https://api.cleverhub.co/api/v1/merchants/create_bank_payment', 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/v1/merchants/create_bank_payment",
  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([
    'name' => 'Jane Doe',
    'gst' => true,
    'amount' => 1000,
    'description' => 'Payment for invoice #1234',
    'emails' => 'customer@example.com',
    'payment_request_notification' => [
        'endpoint_url' => 'https://example.com/payment_callback',
        'authorization_header' => 'Bearer your_token'
    ],
    'expired_at' => '2024-12-31T23:59:59Z',
    'external_id' => 'custom-id-12345'
  ]),
  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/v1/merchants/create_bank_payment"

	payload := strings.NewReader("{\n  \"name\": \"Jane Doe\",\n  \"gst\": true,\n  \"amount\": 1000,\n  \"description\": \"Payment for invoice #1234\",\n  \"emails\": \"customer@example.com\",\n  \"payment_request_notification\": {\n    \"endpoint_url\": \"https://example.com/payment_callback\",\n    \"authorization_header\": \"Bearer your_token\"\n  },\n  \"expired_at\": \"2024-12-31T23:59:59Z\",\n  \"external_id\": \"custom-id-12345\"\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/v1/merchants/create_bank_payment")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Jane Doe\",\n  \"gst\": true,\n  \"amount\": 1000,\n  \"description\": \"Payment for invoice #1234\",\n  \"emails\": \"customer@example.com\",\n  \"payment_request_notification\": {\n    \"endpoint_url\": \"https://example.com/payment_callback\",\n    \"authorization_header\": \"Bearer your_token\"\n  },\n  \"expired_at\": \"2024-12-31T23:59:59Z\",\n  \"external_id\": \"custom-id-12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/merchants/create_bank_payment")

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  \"name\": \"Jane Doe\",\n  \"gst\": true,\n  \"amount\": 1000,\n  \"description\": \"Payment for invoice #1234\",\n  \"emails\": \"customer@example.com\",\n  \"payment_request_notification\": {\n    \"endpoint_url\": \"https://example.com/payment_callback\",\n    \"authorization_header\": \"Bearer your_token\"\n  },\n  \"expired_at\": \"2024-12-31T23:59:59Z\",\n  \"external_id\": \"custom-id-12345\"\n}"

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

{
  "id": 12345,
  "payee_detail": {
    "account_holder_name": "Jane Doe",
    "bsb": "654321",
    "account_number": "987654321"
  },
  "name": "Jane Doe",
  "merchant_name": "Merchant Inc.",
  "gst": true,
  "amount": "1000.0",
  "total": "1100.0",
  "gst_amount": "100.0",
  "expired_at": "2024-12-31T23:59:59Z",
  "external_id": "custom-id-12345",
  "cashback_amount": "50.0",
  "pay_by": "2024-12-30T23:59:59Z",
  "paid_at": "2024-12-25T12:34:56Z",
  "status": "received",
  "description": "Payment for invoice #1234",
  "refund_information": {
    "refund_bsb": "654321",
    "refund_account_number": "987654321",
    "refund_amount": "10.99",
    "request_date": "2024-07-01T00:00:00Z",
    "reason": "Refund for incorrect payment"
  },
  "payment_request_notification": {
    "endpoint_url": "https://merchant.com/payment_callback",
    "authorization_header": "Bearer your_token"
  },
  "nonce": "unique_nonce_string",
  "stage": "overpaid",
  "additional_property": "Additional value"
}

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

name

string

required

The full name of the customer for whom the payment is being created.

Pattern: ^(?![! ](?![!]*$))[a-zA-Z0-9 ]*(?![ ])$

Example:

"Jane Doe"

gst

boolean

required

Indicates whether Goods and Services Tax (GST) applies to the payment (for Australian merchants).

Example:

true

amount

number

required

The total amount to be charged, specified in Australian Dollars (AUD).

Example:

1000

description

string

required

A brief description of the purpose of the payment.

Pattern: ^(?![! ](?![!]*$))[a-zA-Z0-9 _-]*(?![ ])$

Example:

"Payment for invoice #1234"

emails

string

required

Comma-separated list of email addresses for notifications. Only lowercase letters are allowed.

Pattern: ^([a-z0-9_\-\.]+)@([a-z]+)\.([a-z]+)(,[a-z0-9_\-\.]+@[a-z]+\.([a-z]+))*$

Example:

"customer@example.com"

payment_request_notification

object

required

Callback configuration for receiving payment status updates.

Show child attributes

expired_at

string<date-time>

Expiration date and time of the payment, in UTC. Must be at least 15 minutes from the current time.

Example:

"2024-12-31T23:59:59Z"

external_id

string

A custom identifier provided by the merchant for tracking purposes.

Example:

"custom-id-12345"

Callbacks

POST

{$request.body#/payment_request_notification.endpoint_url}statusChange

Body

application/json

integer

The unique identifier of the payment, used for tracking purposes.

Example:

12345

payee_detail

object

Details of the payee's bank account, including BSB and account number, to facilitate the payment.

Show child attributes

name

string

The name of the customer associated with the payment request.

Example:

"Jane Doe"

merchant_name

string

The name of the merchant handling the payment request, allowing identification of the party being paid.

Example:

"Merchant Inc."

gst

boolean

Indicates whether GST (Goods and Services Tax) is applicable to the payment. A value of true indicates GST is included.

Example:

true

amount

string

The amount for the payment, excluding GST. This represents the base transaction value.

Example:

"1000.0"

total

string

The total payment amount, including GST. This is the final amount to be paid by the customer.

Example:

"1100.0"

gst_amount

string

The portion of the total amount that represents GST. This helps break down the tax component.

Example:

"100.0"

expired_at

string<date-time>

The expiration date and time of the payment request, indicating the deadline for making the payment.

Example:

"2024-12-31T23:59:59Z"

external_id

string

A custom identifier used for tracking purposes, such as an invoice or reference number provided by the user.

Example:

"custom-id-12345"

cashback_amount

string

The cashback amount offered as part of the transaction, if applicable.

Example:

"50.0"

pay_by

string<date-time>

The deadline by which the payment must be completed, providing a clear due date.

Example:

"2024-12-30T23:59:59Z"

paid_at

string<date-time>

The date and time when the payment was successfully made, used for record-keeping.

Example:

"2024-12-25T12:34:56Z"

status

enum<string>

The current status of the payment request. Possible values include:

pending: Awaiting payment.
received: Payment completed.
expired: Payment request expired.
return_pending: Refund process initiated.
return_received: Refund completed.
return_expired: Refund request expired.
return_rejected: Refund request rejected.

Available options:

pending,

received,

expired,

return_pending,

return_received,

return_expired,

return_rejected

Example:

"received"

description

string

A description associated with the payment request, providing context or additional details about the transaction.

Example:

"Payment for invoice #1234"

refund_information

object

Details of any refund associated with the payment, including bank details and refund amount.

Show child attributes

payment_request_notification

object

Details of the merchant's callback settings, including the endpoint URL and authorization information for receiving payment status updates.

Show child attributes

nonce

string

A nonce value used to validate the transaction, ensuring that it is unique and preventing replay attacks.

Example:

"unique_nonce_string"

stage

enum<string>

Represents the specific stage in a pending transaction. Default value is null unless the payment amount is incorrect or the nonce is unmatched.

Available options:

overpaid,

underpaid,

unmatched_nonce,

null

Example:

"overpaid"

additional_property

string

A new property added to the BSBAccountObject for extended functionality or specific use cases.

Example:

"Additional value"

Response

Callback received successfully.

Response

Payment request created successfully.

integer

The unique identifier of the payment, used for tracking purposes.

Example:

12345

payee_detail

object

Details of the payee's bank account, including BSB and account number, to facilitate the payment.

Show child attributes

name

string

The name of the customer associated with the payment request.

Example:

"Jane Doe"

merchant_name

string

The name of the merchant handling the payment request, allowing identification of the party being paid.

Example:

"Merchant Inc."

gst

boolean

Indicates whether GST (Goods and Services Tax) is applicable to the payment. A value of true indicates GST is included.

Example:

true

amount

string

The amount for the payment, excluding GST. This represents the base transaction value.

Example:

"1000.0"

total

string

The total payment amount, including GST. This is the final amount to be paid by the customer.

Example:

"1100.0"

gst_amount

string

The portion of the total amount that represents GST. This helps break down the tax component.

Example:

"100.0"

expired_at

string<date-time>

The expiration date and time of the payment request, indicating the deadline for making the payment.

Example:

"2024-12-31T23:59:59Z"

external_id

string

A custom identifier used for tracking purposes, such as an invoice or reference number provided by the user.

Example:

"custom-id-12345"

cashback_amount

string

The cashback amount offered as part of the transaction, if applicable.

Example:

"50.0"

pay_by

string<date-time>

The deadline by which the payment must be completed, providing a clear due date.

Example:

"2024-12-30T23:59:59Z"

paid_at

string<date-time>

The date and time when the payment was successfully made, used for record-keeping.

Example:

"2024-12-25T12:34:56Z"

status

enum<string>

The current status of the payment request. Possible values include:

pending: Awaiting payment.
received: Payment completed.
expired: Payment request expired.
return_pending: Refund process initiated.
return_received: Refund completed.
return_expired: Refund request expired.
return_rejected: Refund request rejected.

Available options:

pending,

received,

expired,

return_pending,

return_received,

return_expired,

return_rejected

Example:

"received"

description

string

A description associated with the payment request, providing context or additional details about the transaction.

Example:

"Payment for invoice #1234"

refund_information

object

Details of any refund associated with the payment, including bank details and refund amount.

Show child attributes

payment_request_notification

object

Details of the merchant's callback settings, including the endpoint URL and authorization information for receiving payment status updates.

Show child attributes

nonce

string

A nonce value used to validate the transaction, ensuring that it is unique and preventing replay attacks.

Example:

"unique_nonce_string"

stage

enum<string>

Represents the specific stage in a pending transaction. Default value is null unless the payment amount is incorrect or the nonce is unmatched.

Available options:

overpaid,

underpaid,

unmatched_nonce,

null

Example:

"overpaid"

additional_property

string

A new property added to the BSBAccountObject for extended functionality or specific use cases.

Example:

"Additional value"

Get Payment Request Statistics

Get Payment Request List

Create BSB/Account Number Payment

curl --request POST \
  --url https://api.cleverhub.co/api/v1/merchants/create_bank_payment \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "name": "Jane Doe",
  "gst": true,
  "amount": 1000,
  "description": "Payment for invoice #1234",
  "emails": "customer@example.com",
  "payment_request_notification": {
    "endpoint_url": "https://example.com/payment_callback",
    "authorization_header": "Bearer your_token"
  },
  "expired_at": "2024-12-31T23:59:59Z",
  "external_id": "custom-id-12345"
}
'

import requests

url = "https://api.cleverhub.co/api/v1/merchants/create_bank_payment"

payload = {
    "name": "Jane Doe",
    "gst": True,
    "amount": 1000,
    "description": "Payment for invoice #1234",
    "emails": "customer@example.com",
    "payment_request_notification": {
        "endpoint_url": "https://example.com/payment_callback",
        "authorization_header": "Bearer your_token"
    },
    "expired_at": "2024-12-31T23:59:59Z",
    "external_id": "custom-id-12345"
}
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({
    name: 'Jane Doe',
    gst: true,
    amount: 1000,
    description: 'Payment for invoice #1234',
    emails: 'customer@example.com',
    payment_request_notification: {
      endpoint_url: 'https://example.com/payment_callback',
      authorization_header: 'Bearer your_token'
    },
    expired_at: '2024-12-31T23:59:59Z',
    external_id: 'custom-id-12345'
  })
};

fetch('https://api.cleverhub.co/api/v1/merchants/create_bank_payment', 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/v1/merchants/create_bank_payment",
  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([
    'name' => 'Jane Doe',
    'gst' => true,
    'amount' => 1000,
    'description' => 'Payment for invoice #1234',
    'emails' => 'customer@example.com',
    'payment_request_notification' => [
        'endpoint_url' => 'https://example.com/payment_callback',
        'authorization_header' => 'Bearer your_token'
    ],
    'expired_at' => '2024-12-31T23:59:59Z',
    'external_id' => 'custom-id-12345'
  ]),
  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/v1/merchants/create_bank_payment"

	payload := strings.NewReader("{\n  \"name\": \"Jane Doe\",\n  \"gst\": true,\n  \"amount\": 1000,\n  \"description\": \"Payment for invoice #1234\",\n  \"emails\": \"customer@example.com\",\n  \"payment_request_notification\": {\n    \"endpoint_url\": \"https://example.com/payment_callback\",\n    \"authorization_header\": \"Bearer your_token\"\n  },\n  \"expired_at\": \"2024-12-31T23:59:59Z\",\n  \"external_id\": \"custom-id-12345\"\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/v1/merchants/create_bank_payment")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Jane Doe\",\n  \"gst\": true,\n  \"amount\": 1000,\n  \"description\": \"Payment for invoice #1234\",\n  \"emails\": \"customer@example.com\",\n  \"payment_request_notification\": {\n    \"endpoint_url\": \"https://example.com/payment_callback\",\n    \"authorization_header\": \"Bearer your_token\"\n  },\n  \"expired_at\": \"2024-12-31T23:59:59Z\",\n  \"external_id\": \"custom-id-12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/merchants/create_bank_payment")

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  \"name\": \"Jane Doe\",\n  \"gst\": true,\n  \"amount\": 1000,\n  \"description\": \"Payment for invoice #1234\",\n  \"emails\": \"customer@example.com\",\n  \"payment_request_notification\": {\n    \"endpoint_url\": \"https://example.com/payment_callback\",\n    \"authorization_header\": \"Bearer your_token\"\n  },\n  \"expired_at\": \"2024-12-31T23:59:59Z\",\n  \"external_id\": \"custom-id-12345\"\n}"

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

{
  "id": 12345,
  "payee_detail": {
    "account_holder_name": "Jane Doe",
    "bsb": "654321",
    "account_number": "987654321"
  },
  "name": "Jane Doe",
  "merchant_name": "Merchant Inc.",
  "gst": true,
  "amount": "1000.0",
  "total": "1100.0",
  "gst_amount": "100.0",
  "expired_at": "2024-12-31T23:59:59Z",
  "external_id": "custom-id-12345",
  "cashback_amount": "50.0",
  "pay_by": "2024-12-30T23:59:59Z",
  "paid_at": "2024-12-25T12:34:56Z",
  "status": "received",
  "description": "Payment for invoice #1234",
  "refund_information": {
    "refund_bsb": "654321",
    "refund_account_number": "987654321",
    "refund_amount": "10.99",
    "request_date": "2024-07-01T00:00:00Z",
    "reason": "Refund for incorrect payment"
  },
  "payment_request_notification": {
    "endpoint_url": "https://merchant.com/payment_callback",
    "authorization_header": "Bearer your_token"
  },
  "nonce": "unique_nonce_string",
  "stage": "overpaid",
  "additional_property": "Additional value"
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Create BSB/Account Number Payment

Authorizations

Body

Callbacks

Body

Response

Response