clearddocs
cleard.ai ↗
Get started Quickstart
Markdown ↗

Get started

Quickstart

Understand the public example without an account, then sign in to save your own sandbox experiments.

1. Check what is available#

Read the capability manifest first. It tells you which operations exist and which are unsupported. Run this in the developer console on any page of this portal:

Browser JavaScript
const capabilities = await fetch('/portal/capabilities.json')
  .then(response => response.json());

console.log(capabilities.mode);
// simulation
console.log(capabilities.supported_networks);
// []

2. Inspect the purchase#

Browser JavaScript
const purchase = await fetch('/portal/examples/purchase.json')
  .then(response => response.json());

console.log({
  purchase: purchase.purchase_id,
  cap: purchase.maximum_refund_units,
  beneficiary: purchase.refund_beneficiary,
  authority: purchase.decision_authority,
  verification: purchase.verification_status
});
Expected output
{
  "purchase": "DEMO-1087",
  "cap": 100,
  "beneficiary": "demo-buyer-001",
  "authority": "demo-reviewer",
  "verification": "unsigned_fixture"
}

Check the field reference for terms, deadlines and the collection source. This file is an unsigned example. Reading it does not verify a merchant or create refund rights.

3. Follow the guided example#

  1. Open the Sandbox. No sign-in is needed for the walkthrough.
  2. Read the terms the fictional buyer accepts before payment.
  3. Follow the final payment and a service-failure claim. Each step identifies who acts and why.
  4. Inspect the review result: 100 DEMO approved, 40 paid and 60 still owed.
  5. See how 60 of new eligible reserve funds pays the remainder under the same decision.

4. Try your own purchase#

Choose “Your workspace” in the sandbox and sign in. Your records stay private and persist across visits. The manual controls let you act as each fictional participant: create a purchase, accept it, record test settlement, file a claim and issue a decision.

For the same partial-refund example, add 40 DEMO to the reserve before approving 100. The ledger records 40 paid and 60 owed. A later 60 top-up can pay the remainder without another decision. Download the purchase record to inspect test signatures and accounting; private evidence is excluded.

Expected partial-refund amounts
{
  "mode": "simulation",
  "approved": 100,
  "paid": 40,
  "outstanding": 60
}

The walkthrough’s API examples show the existing workspace operations. They do not execute requests. Read the sandbox manifest before using the authenticated API. Scoped agent keys and a client SDK are not implemented.

Before a real integration#

The saved workspace tests purchase binding, signed decisions, cumulative limits and simulated accounting. A real integration still needs authenticated commercial enrollment, independent decision authority, verified actual settlement and an enforceable collection path. See Funding and execution.

Cleard · Commercial relationships for open commerce.Preview / Quickstart

Searches these docs locally. Use Tab to choose a result.