Circle provides payments infrastructure that creates a seamless connection between fiat and crypto transactions. In order to enhance the developer experience, Circle has recently released a public Postman workspace to visually explore and interact with our Payments, Payouts, and Accounts APIs.
The public collection includes request templates for our API resources, available parameters, and configurable variables for authenticating API requests against your account.
Prerequisites
Before you start, be sure to register for a Circle sandbox account. Once you’ve registered for an account, navigate to the settings screen where you can generate your key from the Sandbox API keys section. This API key will allow you to make requests from the Postman collection in Circle's test environment.
If you are new to Circle APIs, head over to our developer docs where you can learn all about our product offerings.
Getting Started
To start, go to the Circle public workspace and fork the Circle API collection. Alternatively, you can visit our GitHub repository and directly import the collection.
Next, navigate to your Circle Postman collection and set the variable’s initial value to your API key. Select your new Postman environment as the active environment.
Lastly, go to the top-level folder of the Circle API collection. Under the Authorization tab, set the token to the variable and save, so that all API calls in the collection are using your sandbox account API credentials.
Congratulations! You’re ready to explore the Circle APIs by making test calls against all our endpoints.
Exploring the APIs
Circle’s APIs are divided into multiple collections which include folders with preconfigured calls you can use to test each endpoint. Each folder contains possible request shapes, and each request shape includes relevant fields. Fields include a description that specifies the format and type. Before making a request, it’s good practice to review the fields to see which ones are required and what they do.
Feedback
We welcome any feedback as we continue to provide resources for building on USDC. Feel free to submit ideas, report bugs, or feature requests.
