Skip to main content
Beta: we aim to avoid breaking changes, but they may occur before 1.0.
This quickstart installs the Paxos TypeScript SDK and lists the profiles on your Sandbox account. It takes about five minutes.

➊ Prerequisites

➋ Install

➌ Set up credentials

Create Sandbox API credentials with the funding:read_profile scope. See Configure API Credentials.
Scopes are required when you construct a client. This quickstart requests funding:read_profile, which lets the client list profiles.

➍ List your profiles

Save the following as quickstart.ts:
Run it:
The output lists each profile’s ID and nickname. 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.