Get started with Pharos
Choose a dashboard task or connect your application to hosted checkout.
Use the dashboard to manage collections and financial operations, or use the API to connect your application to hosted checkout.
Choose your starting point
| Your task | Start here |
|---|---|
| Create an offer and share a checkout URL | Payment Links |
| Create an invoice for a customer | Invoices |
| Manage recurring billing | Subscriptions |
| Review supplier invoices and prepare payments | Payments |
| Open a financial account or check a balance | Financial accounts |
| Build checkout into your application | Cart Checkout |
Prepare your account and Sandbox
Signup creates one Production account. Use the account selector to create a separate account, create a subaccount that inherits the root team, or open the linked Sandbox. Administrators can also create and open the Sandbox from Dashboard → Settings → Sandboxes.
A new Sandbox has no customers, invoices, payments, financial accounts, integrations, or API keys. Configure your test data and payment connection before testing. Confirm the active account and environment before making changes.
Authentication
For an API integration, create a key in the dashboard's developer settings. All /api/v1 endpoints require the x-api-key header. Keep the key on your server.
The following request targets a local development environment:
curl -H 'x-api-key: YOUR_API_KEY' \
'http://localhost:3000/api/v1/products?limit=20'Suggested First Flow
- Confirm the connected account with
GET /api/v1/accountusing a key withREAD. - List products or look up saved IDs with
GET /api/v1/products/{id}orGET /api/v1/products?ids[]=.... See Pagination for list results and cursors. - Create a reusable Payment Link, or create a Checkout Session for a cart controlled by your backend.
- Configure Webhooks. Verify signatures and handle duplicate deliveries before fulfilling a purchase.
- Complete a Sandbox purchase, check the resulting invoice and payment, and verify receipt of the signed
invoice.paidevent before going live.
Core Guides
Key Concepts
Products
Products describe what you sell. Plans define how you charge, and prices specify the amount in each currency.
Payment Links
Payment Links are reusable hosted checkout URLs. Starting checkout creates or resumes a Checkout Session with a saved copy of the offer. Use a link when you want to share the same offer across your site, messages, or campaigns.
Webhooks
Webhooks notify your backend about checkout, payment, and subscription events. Pharos signs deliveries with Pharos-Signature. A redirect or success page does not prove payment: fulfill a paid purchase only after verifying the signed invoice.paid event.