AUD BSB/Account Number

Get Payment Request Status

Retrieve the current status of a bank payment request. This endpoint allows you to check the status of a specific payment, helping you track its progress and outcome. The possible statuses are as follows:

pending: The customer has not yet made the requested payment.
received: The payment has been successfully completed by the customer.
expired: The payment request has expired due to the time limit.
return_pending: A refund (either full or partial) has been requested on this payment.
return_received: The refund has been successfully transferred back to the original payer.
return_expired: The refund request expired after 10 days without being completed.
return_rejected: The refund failed due to an issue with the destination account, and Hello Clever will not retry the transaction.

To retrieve the status, you must provide either a unique id or both bsb and account_number. If both id and bsb with account_number are provided, id will be prioritised.

GET

payment_requests

bank_payments_status

Get Payment Request Status

curl --request GET \
  --url https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status"

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/v1/payment_requests/bank_payments_status', 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/payment_requests/bank_payments_status",
  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/v1/payment_requests/bank_payments_status"

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

}

HttpResponse<String> response = Unirest.get("https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status")

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

{
  "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.

Query Parameters

integer

The unique Hello Clever ID associated with the payment request. If provided, this will be used to fetch the payment status.

bsb

string

Bank State Branch (BSB) number associated with the payment request. Required if id is not provided.

account_number

string

Account number associated with the payment request. Required if id is not provided.

Response

Payment request status retrieved 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 Status

curl --request GET \
  --url https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status"

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/v1/payment_requests/bank_payments_status', 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/payment_requests/bank_payments_status",
  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/v1/payment_requests/bank_payments_status"

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

}

HttpResponse<String> response = Unirest.get("https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status")
  .header("app-id", "<api-key>")
  .header("secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status")

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

{
  "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"
}

Basics

Payment APIs

Card API

Cashback API

Reporting API

Get Payment Request Status

Authorizations

Query Parameters

Response