Beta: we aim to avoid breaking changes, but they may occur before 1.0.
➊ Prerequisites
- Node 22.12 or later.
- A Paxos Sandbox account.
➋ Install
➌ Set up credentials
Create Sandbox API credentials with thefunding:read_profile scope. See Configure API Credentials.
funding:read_profile, which lets the client list profiles.
➍ List your profiles
Save the following asquickstart.ts:
listProfiles returns an async iterator that fetches additional pages automatically.
If a call fails, include the requestId when you contact Support.
Next steps
- Read Authentication to learn how credentials and scopes work.
- Explore the Sandbox to fund test profiles and simulate flows.
- Browse the API Reference for the endpoints available on each service.
Questions? Contact Support.