Developer overview
Hilt Pay API gives developers and agents the API, SDK, CLI, webhook, Postman, OpenAPI, and GitHub asset surface for payment-to-access infrastructure. Use it to create products, return x402 HTTP402 Payment Required requirements, send buyers or agents into Solana USDC settlement, receive payment, receipt, membership, and entitlement events, protect paid APIs or products with access checks, and keep your own systems in sync.
For agentic payments, treat Hilt Pay API as the operating layer behind the paid-resource loop: discover the resource, check entitlement, return HTTP 402 when unpaid, complete payment, verify through Hilt, and retry only after access is active.
If you want one working flow tonight, start with Developer quickstart.
If you want the hero proof, copy the FastAPI protected-resource demo: denied request, HTTP 402, payment, proof, entitlement check, and access retry.
If you are protecting an API, AI tool, dataset, bot, or private software feature, use Hilt Pay API.
If an agent or developer tool is setting up the integration for the owner, use Agent setup.
If you want the broader model first, stay here.
What Hilt is good at
Hilt works best when you want one system to own the operational state around payment:- hosted checkout
- agent setup intents
- x402 protected-resource requirements
- payment state
- memberships and recurring operations
- entitlements and paid-access checks
- receipt proof
- support context
- webhook event delivery
- payment-to-access checks for APIs, bots, datasets, and paid software
The fastest reliable implementation path
The practical build order is:- choose Workspace or API as the primary surface
- create a sandbox setup intent or create one product from code
- configure Solana USDC rail settings and webhook endpoint
- install the SDK or import Postman
- test the denied -> 402 -> payment -> proof -> entitlement path in sandbox
- confirm live readiness before real buyer traffic
- one working product
- one working integration
- one real merchant trail to compare against
What your backend should own
Your backend is usually the right place for:- product creation or updates when needed
- signed buyer handoff link generation
- webhook consumers for longer-running automation
- active checkout polling while the buyer is still waiting
- your own correlation between users and Hilt ids
What Hilt should own
Hilt should remain the source of truth for:- payment settlement state
- membership state
- renewal intelligence
- receipt proof
- support case history
Start from a real merchant workspace
The cleanest integrations start from a real merchant workspace rather than a purely synthetic setup:- launch the first flow in the dashboard
- create the API key for that workspace
- automate the same product and checkout flow from your backend
- compare the API trail against what the merchant sees in the app
Use the right auth surface
For merchant-only routes, Hilt accepts either a merchant session token or an API key.| Surface | Typical auth | Best use |
|---|---|---|
| Public checkout payload and buyer session start | no auth | Buyer-facing hosted checkout |
| Merchant backend or bot automation | X-Hilt-Key | Server-to-server integrations |
| Dashboard-session tooling | Authorization: Bearer JWT_TOKEN | Merchant browser workflows and session-assisted tools |
- use
X-Hilt-Keyfor almost all backend work - use
Authorization: Bearer JWT_TOKENfor webhook endpoint management
API at a glance
| Area | What you do there | Main routes |
|---|---|---|
| Products | Create, update, archive, and inspect merchant offers | /v1/products |
| Hosted checkout | Read buyer payloads and start buyer sessions | /v1/products/p/{slug}, /connect, /resolve-handoff |
| Payments | Confirm and read payment state | /v1/pay/confirm, /v1/payments/{payment_id} |
| Hilt Pay API | Create Pay API apps/products/sessions and check entitlements | /v1/access* |
| Webhooks | Receive signed outbound Hilt events | /v1/webhooks* |
| Memberships | Read access state and run follow-up actions | /v1/memberships* |
| Receipts | Read proof and public verification links | /v1/receipts, /v1/receipt/{id} |
| Support | Open and manage issue threads tied to the payment trail | /v1/support/tickets* |
| Testing | Run sandbox sessions and inspect integration behavior | /v1/testing* |
The ids worth keeping
These are the ids worth persisting in your own system:product_idslugpayment_idaccess_product_idexternal_product_idmembership_idreceipt_idticket_id
payment_id. It is the clean join between:
- checkout state
- payment status
- memberships
- receipts
- support tickets
- webhook timelines
Reference and tooling
Hilt publishes its developer surface in several forms:- TypeScript SDK:
npm install @hiltpay/sdk - TypeScript SDK source:
https://github.com/Hiltpay/hilt-sdk-js - Python SDK:
pip install hilt-sdk - Python SDK source:
https://github.com/Hiltpay/hilt-sdk-python - Developer assets repo:
https://github.com/Hiltpay/hilt-developer-assets
- approved OpenAPI snapshots
- Postman imports
- example webhook payloads
Rate limits
Hilt returns standard rate-limit headers on API responses:X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetRetry-Afteron429
- unauthenticated public buyer routes:
120requests per minute - Free:
60requests per minute - Starter:
120requests per minute - Growth:
300requests per minute - Scale:
900requests per minute - Enterprise: custom or effectively unlimited by contract
When to use the dashboard, API, SDK, Postman, or CLI
| Surface | Best for |
|---|---|
| Dashboard | First launch, checkout branding, commercial setup, billing, payout settings, daily merchant operations |
| API | Agent setup, paid-access products, payment sessions, entitlement checks, backend automation, webhook consumers, ledger lookups |
| SDKs | Faster typed integration in TypeScript or Python |
| Postman | Fast request inspection without writing code |
| CLI | Repeatable support workflows, terminal lookups, and lightweight scripts |
Common questions
What can developers build with Hilt?
Developers can create products, start hosted checkout sessions, receive signed webhooks, read payment and membership state, manage receipts, open support context, and automate merchant operations with SDKs, Postman, CLI, or Zapier.What is the most important Hilt id to store?
Storepayment_id. It joins the buyer checkout, payment state, membership state, receipt proof, webhook timeline, and support trail.

