AUD PayTo

Get Payment Agreement Detail

Retrieve the details of a specific payment agreement, including its current status. This endpoint provides insight into the lifecycle and status of a payment agreement, which can be one of the following:

created: The customer has initiated the creation of the Payment Agreement.
active: The Payment Agreement is active and ready to process payments.
suspended: The Payment Agreement is temporarily suspended, pausing all associated transactions.
cancelled: The Payment Agreement has been cancelled, and no further payments can be processed.
failed: The Payment Agreement has failed due to an error.

For testing purposes, specific PayIDs can be used to simulate different statuses:

created: Use PayID no-action@example.com to keep the agreement status as created.
failed: Use PayID error@example.com to trigger a failure status.
cancelled: Use PayID cancel-agreement@example.com to simulate a cancelled status.
suspended: Use PayID suspend-agreement@example.com to simulate a suspended status.

GET

pay_to

payment_agreement

detail

Get Payment Agreement Detail

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

import requests

url = "https://api.cleverhub.co/api/v1/pay_to/payment_agreement/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/v1/pay_to/payment_agreement/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/v1/pay_to/payment_agreement/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/v1/pay_to/payment_agreement/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))

}

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

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/pay_to/payment_agreement/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

{
  "id": 12345,
  "payment_agreement_id": "agreement-12345",
  "client_transaction_id": "client-trans-001",
  "limit_amount": 5000,
  "description": "Monthly utility bill payment agreement.",
  "external_id": "custom-agreement-id-7890",
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z",
  "payment_agreement_type": "UTILITY",
  "agreement_details": {
    "variable_agreement_details_obj": {
      "start_date": "15/07/24",
      "frequency": "MONTHLY"
    }
  },
  "payer_details": {
    "name": "Jane Doe",
    "bank_account_details": {
      "bsb": "123456",
      "account_number": "987654321"
    },
    "pay_id_details": {
      "pay_id": "payer@payid.com",
      "pay_id_type": "EMAIL"
    }
  },
  "payment_agreement_notification": {
    "endpoint_url": "https://merchant.com/payment_callback",
    "authorization_header": "Bearer your_token"
  }
}

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

required

The unique Hello Clever payment ID for the payment agreement.

Response

Request processed successfully.

integer

A unique identifier for the payment agreement, used for tracking and management.

Example:

12345

payment_agreement_id

string

The unique identifier for the payment agreement, providing a reference to the specific agreement being handled.

Example:

"agreement-12345"

client_transaction_id

string

A unique ID for the transaction as provided by the merchant, used to ensure transactions can be uniquely tracked.

Required string length: 1 - 90

Example:

"client-trans-001"

limit_amount

number

The maximum allowable amount for each payment under this agreement, helping to manage the scope of transactions.

Example:

5000

description

string

A description of the payment agreement, providing context and information for the payer and merchant.

Required string length: 5 - 140

Example:

"Monthly utility bill payment agreement."

external_id

string

A custom identifier assigned to the payment agreement, typically used for tracking and reference purposes.

Maximum string length: 255

Example:

"custom-agreement-id-7890"

status

enum<string>

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

created: Agreement has been created but not yet activated.
active: Agreement is currently active.
suspended: Agreement has been temporarily suspended.
cancelled: Agreement has been cancelled.
failed: Agreement creation or payment has failed.

Available options:

created,

active,

suspended,

cancelled,

failed

Example:

"active"

created_at

string<date-time>

The timestamp indicating when the payment agreement was created, in UTC.

Example:

"2024-01-01T00:00:00Z"

payment_agreement_type

enum<string>

The type of payment agreement, indicating the nature of the payments involved.

Available options:

MORTGAGE,

UTILITY,

LOAN,

DEPENDANT SUPPORT,

GAMBLING,

RETAIL,

SALARY,

PERSONAL,

GOVERNMENT,

PENSION,

TAX,

OTHER SERVICE

Example:

"UTILITY"

agreement_details

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

payer_details

object

Details about the payer, including either bank account information or PayID details.

Show child attributes

payment_agreement_notification

object

Details for the merchant callback, including endpoint URL and authorization header for receiving status updates on the payment agreement.

Show child attributes

Change Payment Agreement Status

Get Payment Agreements

Get Payment Agreement Detail

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

import requests

url = "https://api.cleverhub.co/api/v1/pay_to/payment_agreement/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/v1/pay_to/payment_agreement/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/v1/pay_to/payment_agreement/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/v1/pay_to/payment_agreement/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))

}

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

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/pay_to/payment_agreement/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

{
  "id": 12345,
  "payment_agreement_id": "agreement-12345",
  "client_transaction_id": "client-trans-001",
  "limit_amount": 5000,
  "description": "Monthly utility bill payment agreement.",
  "external_id": "custom-agreement-id-7890",
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z",
  "payment_agreement_type": "UTILITY",
  "agreement_details": {
    "variable_agreement_details_obj": {
      "start_date": "15/07/24",
      "frequency": "MONTHLY"
    }
  },
  "payer_details": {
    "name": "Jane Doe",
    "bank_account_details": {
      "bsb": "123456",
      "account_number": "987654321"
    },
    "pay_id_details": {
      "pay_id": "payer@payid.com",
      "pay_id_type": "EMAIL"
    }
  },
  "payment_agreement_notification": {
    "endpoint_url": "https://merchant.com/payment_callback",
    "authorization_header": "Bearer your_token"
  }
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Get Payment Agreement Detail

Authorizations

Query Parameters

Response