Get Payment Request Status

GET 
https://api.cleverhub.co/api/v1/payment_requests/bank_payments_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.

Request

Query Parameters

id integer
The unique Hello Clever ID associated with the payment request. If provided, this will be used to fetch the payment status.
Example: 12345
bsb string
Bank State Branch (BSB) number associated with the payment request. Required if id is not provided.
Example: 123456
account_number string
Account number associated with the payment request. Required if id is not provided.
Example: 987654321

Responses

200

Payment request status retrieved successfully.

application/json

Schema

Schema

idinteger
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.
account_holder_namestringrequired
The name of the account holder for the payment. This helps ensure the correct payee is identified.
Example: Jane Doe
bsbstringrequired
The BSB (Bank-State-Branch) number used to facilitate the payment, identifying the bank and branch.
Example: 654321
account_numberstringrequired
The account number used to make the payment, providing the unique identifier of the payee's account.
Example: 987654321
namestring
The name of the customer associated with the payment request.
Example: Jane Doe
merchant_namestring
The name of the merchant handling the payment request, allowing identification of the party being paid.
Example: Merchant Inc.
gstboolean
Indicates whether GST (Goods and Services Tax) is applicable to the payment. A value of true indicates GST is included.
Example: true
amountstring
The amount for the payment, excluding GST. This represents the base transaction value.
Example: 1000.0
totalstring
The total payment amount, including GST. This is the final amount to be paid by the customer.
Example: 1100.0
gst_amountstring
The portion of the total amount that represents GST. This helps break down the tax component.
Example: 100.0
expired_atdate-time
The expiration date and time of the payment request, indicating the deadline for making the payment.
Example: 2024-12-31T23:59:59Z
external_idstring
A custom identifier used for tracking purposes, such as an invoice or reference number provided by the user.
Example: custom-id-12345
cashback_amountstring
The cashback amount offered as part of the transaction, if applicable.
Example: 50.0
pay_bydate-time
The deadline by which the payment must be completed, providing a clear due date.
Example: 2024-12-30T23:59:59Z
paid_atdate-time
The date and time when the payment was successfully made, used for record-keeping.
Example: 2024-12-25T12:34:56Z
statusstring
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.
Possible values: [pending, received, expired, return_pending, return_received, return_expired, return_rejected]
Example: received
descriptionstring
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.
refund_bsbstring
The BSB number used for the refund, identifying the bank involved.
Example: 654321
refund_account_numberstring
The account number used for the refund, providing the destination for refunded funds.
Example: 987654321
refund_amountstring
The amount refunded to the payee, providing clarity on the value being returned.
Example: 10.99
request_datedate-time
The date when the refund was requested, used for record-keeping.
Example: 2024-07-01T00:00:00Z
reasonstring
The reason for the refund, providing context such as incorrect payment or product issues.
Example: Refund for incorrect payment
payment_request_notification object
Details of the merchant's callback settings, including the endpoint URL and authorization information for receiving payment status updates.
endpoint_urluri
The URL to which payment status updates will be sent by the system, allowing the merchant to receive notifications.
Example: https://merchant.com/payment_callback
authorization_headerstring
The authorization header value used in the callback request, helping to ensure the request is authenticated.
Example: Bearer your_token
noncestring
A nonce value used to validate the transaction, ensuring that it is unique and preventing replay attacks.
Example: unique_nonce_string
stagestring
Represents the specific stage in a pending transaction. Default value is null unless the payment amount is incorrect or the nonce is unmatched.
Possible values: [overpaid, underpaid, unmatched_nonce, null]
Example: overpaid
additional_propertystring
A new property added to the BSBAccountObject for extended functionality or specific use cases.
Example: Additional value

Example (auto)

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

400

Bad Request

401

Unauthorized

404

Not Found

Authorization: app-id

name: app-idtype: apiKeyin: headerdescription: A unique identifier assigned to each application.

name: secret-keytype: apiKeyin: headerdescription: A secure token associated with the `app-id`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v1/payment_requests/bank_payments_status");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

id — query

bsb — query

account_number — query

ResponseClear

Click the Send API Request button above and see the response here!