Pharos documentation
Manage your account in Pharos or integrate hosted checkout with your application. Find task guides and the API reference here.
Operate Collections
Manage sales and follow up on collections from the dashboard.
- Configure products, customers, coupons and automatic promotions.
- Manage subscriptions and invoices, review collection attempts and give customers portal access.
Authentication
All `/api/v1` endpoints require your account API key in the `x-api-key` header.
- Create and manage keys from the backoffice developers settings.
- Use read-only keys for retrieval flows and broader permissions for write flows.
First request
Start with a simple authenticated read request so you can confirm your key, environment, and response handling.
- List products or payment links before attempting write operations.
- Treat all API responses as account-scoped to the authenticated key.
Products
Products and prices define what a buyer can purchase through payment links and hosted checkout.
- Use the Products endpoints to fetch the catalog exposed to your integration.
- Map product and price IDs before creating or updating payment links.
Payment Links
Payment links are reusable hosted checkout URLs. Starting the interactive flow creates or resumes a checkout session for that link.
- Create links for offers you want to share from your own site, CRM flows, or campaigns.
- Retrieve and update links through the API when you need to synchronize status or content.
Hosted checkout flow
Pharos hosts the checkout experience. Your integration decides when to send the buyer into checkout and how to reconcile the outcome.
- Use Payment Links for reusable offers or Checkout Sessions for backend-owned carts.
- Handle completion and follow-up in your own systems using webhook events.
Webhooks
Use webhook deliveries to react to checkout, payment, and subscription events on your own backend.
- Validate `x-pharos-signature` with your signing secret.
- Treat deliveries as at-least-once and make handlers safe for duplicates.
Error handling
Design your integration to handle validation failures, authorization problems, and not-found responses explicitly.
- Expect `401` when the API key is missing, invalid, or lacks permission.
- Expect `404` when the requested account-scoped resource does not exist.
Next steps
Once the core flow is working, move from a first request to a production-ready integration.
- Connect your catalog to products and prices.
- Publish payment links or launch hosted checkout from your site.
- Subscribe to webhook events before going live.