Skip to content

stripe/stripe-postman

Repository files navigation

Now available within Postman's API Network

The Stripe API Collection is now hosted within Stripe's public workspace in Postman. This means you no longer need to import this collection, but can instead fork from the public workspace into yours. Head over there to get started.

Stripe API Postman Collection

This is a postman collection covering the Stripe API. See https://stripe.com/docs/api for more details.

Prerequisites

Getting Started

To get started you can either fork the collection from Stripe's public workspace within Postman or import the collection JSON file from this repo.

Fork the collection from Stripe's public workspace

From within the Stripe's public workspace, fork the Stripe API collection:

Fork collection

Enter a name for your fork and select the workspace where it will be created:

Fork form

You can also fork the environment template from the Stripe Developers Workspace:

Fork environment template

Next: Set your API key

Import the collection file into your workspace

If you don't want to fork the collection from the public workspace, you can import it from this repo.

Within your Postman workspace select the Import button:

Import collection

Next copy the StripeAPICollection.json contents and paste in the Paste Raw Text section of the import dialog:

Import raw text

Set your API key

To run requests you'll need to supply your testmode secret API key and set it as an environment variable within your workspace.

To set any environment variable, fork the environment template within the Stripe public workspace, or create a new envionment within Postman:

create a new environment

Add your secret key as a variable to the environment and save:

set API key

Set the environment to active:

save as active

Now within the collection set it to use the environment you just created:

set collection environment

If your environment is set up correctly, you should see your secret key value if you mouse over the secret_key variable in the Token field:

secret key mouseover

Be sure to save the collection after you've configured the set the key:

save key

Make a test call

You should be ready now to make a test call. An easy first call is to create a customer:

customer endpoints

Since no parameters are required to create a customer, you can just hit the Send button to run this request:

create customer send

If your environment is set up you'll get a customer object back as the response to the call:

create customer send

Add parameters to the call by clicking the body tab, where you'll see a list of available parameters. Select and populate the ones you want to use. Here's an example of adding an email parameter:

create customer with email

You'll see the email address in the reponse:

create customer with email

Passing Metadata In a Request

Right now metadata does not show up as a optional parameter on requests, but it can still be provided to calls that will accept it. Here's an example of adding 2 metadata fields to the customer create call:

set metadata on a request

Metadata key value pairs can be updated in a similar manner. To remove a metadata key during an update call, supply the metadata[key] parameter without setting a value. This will pass an empty string as part of the request:

clear metadata key

To remove all metadata pass the metadata parameter without a value set:

remove metadata key

Other useful links

To keep track of major Stripe API updates and version, reference the API upgrades page in our documentation. For a detailed list of API changes, please refer to our API Changelog.

We want to hear from you

We want to hear how we can make the collection better! Don't hestiate to file issues for any bugs you encounters, features you'd like to see or other suggestions you have.

About

Postman collection for Stripe's API

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published