clearddocs
cleard.ai ↗
API reference API reference
Markdown ↗

API reference

Versioned routed test USDC operations with exact scopes and purchase bindings.

Routing contract#

API 1.4.0 uses https://sandbox.cleard.ai/v1/routing. POST bodies are JSON up to 32 KiB. Program and wallet writes require an 8–100 character Idempotency-Key; access issuance and the signed receiver have separate renewal/event-ID semantics. Preserve the exact body/key after uncertain responses. Read operations do not execute transactions.

Routing OpenAPIAuthoritative request, response, security and required-scope schemas.
OperationAuthorizationResult
GET /v1/routing/capabilitiespublicEnabled route metadata
POST /v1/routing/accessaccountIssue seven-day access; revoke prior credential on renewal
GET /v1/routing/programs/{program}records:readScoped program and pinned public contract/key metadata
POST /v1/routing/programs/{program}/merchantsmerchants:writeCreate merchant funding authorization and wallet link
POST /v1/routing/programs/{program}/merchants/{id}/enrollmentmerchants:writeConfirm exact wallet enrollment and personal signature
POST /v1/routing/programs/{program}/purchasespurchases:writeCreate signed purchase commitment and buyer wallet link
GET /v1/routing/programs/{program}/purchases/{id}records:readFresh approved/paid/outstanding and log receipts
POST /v1/routing/programs/{program}/purchases/{id}/activatepurchases:writeBounded registrar offers this exact purchase
POST /v1/routing/programs/{program}/purchases/{id}/registrationpurchases:writeConfirm direct merchant registration
POST /v1/routing/programs/{program}/purchases/{id}/reconcilepurchases:writeReconcile all affected receipt logs atomically
POST /v1/routing/programs/{program}/purchases/{id}/claimsclaims:writeVerify beneficiary signature and timely onchain claim
POST /v1/routing/programs/{program}/purchases/{id}/decisionsdecisions:writeVerify designated reviewer Ed25519 approval
POST /v1/routing/programs/{program}/purchases/{id}/refundsrefunds:executeRecord award and collect from the accepted funding source
POST /v1/routing/programs/{program}/notificationspurchases:writeAttempt up to five signed HTTP deliveries
GET /v1/routing/programs/{program}/notification-receiptsrecords:readRead deduplicated signed delivery receipts
GET /v1/routing/programs/{program}/transactionsrecords:readRead relayer operation IDs and hashes for the client gas budget
POST /v1/routing/notification-receiversigned_eventAccept exact signed outbox event at pinned receiver

Wallet routes are scoped to /wallet/{program}/{merchant|purchase}/{id}; the OpenAPI lists their exact permitted actions. A confirmed transaction hash must match the bound wallet, contract, calldata and immutable purchase. Arbitrary callback destinations and general-purpose signing are not exposed.

Cleard · Commercial relationships for open commerce.Docs / API reference

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