Hello Clever Developer Docs

The simulate deposit endpoint mimics an inbound bank transfer into one of your Treasury Accounts. Use it to confirm that your integration receives the deposit, credits the correct account, and updates the Incoming and Available balances, all without moving real funds.

This is a sandbox testing endpoint. It is available on the sandbox base URL (https://api.cleverhub.co/api) and has no production equivalent. For the sandbox and production base URLs, see the v1 introduction.

For AUD Treasury Accounts you can simulate a deposit through the TestBank simulator instead of calling this endpoint. See the deposit flow.

Simulate a deposit

POST /v1/simulate_deposit

Credits a simulated inbound transfer to the Treasury Account matching account_number.

Headers

string

required

A unique identifier assigned to your application. See where to find app-id and secret-key.

string

required

A secure token associated with your app-id.

Body parameters

string

required

The Treasury Account number to credit. Find it on the account’s Account Details tab in the Merchant Portal.

string

required

The deposit amount. For JPY accounts, specify whole yen.

string

The simulated sender’s name.

string

The simulated sender’s bank name.

string

The simulated sender’s branch name.

string

A free-text note that appears against the transaction.

For JPY accounts, enter remitter_name, remitter_bank_name, and remitter_branch_name in half-width katakana. This matches the Zengin network’s own formatting, so the simulated transaction reads the same way a real one would.

Code example

curl --request POST \
  --url https://api.cleverhub.co/api/v1/simulate_deposit \
  --header 'app-id: YOUR_APP_ID' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_number": "3451385",
  "amount": "10000",
  "remitter_name": "ﾃｽﾄﾆﾕｳｷﾝﾅ",
  "remitter_bank_name": "ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗ",
  "remitter_branch_name": "ﾃｽﾄｼﾃﾝ",
  "remarks": "Testing deposit flow"
}'

Once the call succeeds, the deposit appears in the Treasury Account’s transaction history and the Incoming and Available balances update, exactly as they would for a real inbound transfer.

A Postman collection can be imported to run this request directly. It uses the environment variable v1_url for the base URL, so set that before sending.

Basics

Payment Gateway (AUD)

Multi-Currency Payment API

Payment Gateway 3

Card API

Cashback API

Simulate Deposit API Reference

Simulate a deposit

Headers

Body parameters

Code example

​Simulate a deposit

​Headers

​Body parameters

​Code example

Simulate a deposit

Headers

Body parameters

Code example