Postman Suite

We are happy to share our Postman collections with you! If you are not familiar with Postman it is one of the easiest ways to send API requests and try out Circle’s APIs. Within each of our postman collection are templated requests that you can use to start learning Circle’s APIs

How Its Organized

We created a Postman Circle workspace that includes a collection per product i.e. General, Core, Payments, Payouts, and Accounts API. Within each of these collections are folders that are organized one to one with how we organize our API References.

How To Use It

Option 1: Run in Postman

Start by selecting one of the five run in postman's below. From there you can then choose to fork the collection to your workspace, view the collection in the public workspace, or import the collection into Postman.

Fork: Creates a copy of the collection while maintaining a link to the parent.
View: Allows you to quickly try out the API without having to import anything into your Postman suite.
Import: Creates a copy of the collection but does not maintain a link to Circle’s copy.

Collection

Run it!

General API

Run in PostmanRun in Postman

Core Functionality API

Run in PostmanRun in Postman

Payments API

Run in PostmanRun in Postman

Payouts API

Run in PostmanRun in Postman

Accounts API

Run in PostmanRun in Postman

📘

Authorization

For authorization, we have inserted the postman variable apiKey. Once setup, add your API key to the environment or collection variables. Please see Postman’s using variables for more information.

If you do not have an API Key head over to our Sandbox signup form.

24982498

Option 2: Import from Github

We also offer the ability to download and import the Postman collections JSON files. For more detail on how to use this method please head over to our GitHub repository.


Did this page help you?