├── .gitignore ├── screenshots ├── postman_save_key.png ├── postman_fork_form.png ├── postman_set_metadata.png ├── postman_create_new_env.png ├── postman_fork_collection.png ├── postman_import_raw_text.png ├── postman_remove_metadata.png ├── postman_set_active_env.png ├── postman_update_metadata.png ├── postman_customer_endpoints.png ├── postman_fork_env_template.png ├── postman_import_collection.png ├── postman_set_key_and_save.png ├── postman_create_customer_send.png ├── postman_secret_key_mouseover.png ├── postman_set_collection_environment.png ├── postman_create_customer_with_email_request.png ├── postman_create_customer_with_email_response.png └── postman_customer_create_no_params_response.png ├── SECURITY.md ├── LICENSE.md ├── CODE_OF_CONDUCT.md ├── CHANGELOG.md └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store -------------------------------------------------------------------------------- /screenshots/postman_save_key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_save_key.png -------------------------------------------------------------------------------- /screenshots/postman_fork_form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_fork_form.png -------------------------------------------------------------------------------- /screenshots/postman_set_metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_set_metadata.png -------------------------------------------------------------------------------- /screenshots/postman_create_new_env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_create_new_env.png -------------------------------------------------------------------------------- /screenshots/postman_fork_collection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_fork_collection.png -------------------------------------------------------------------------------- /screenshots/postman_import_raw_text.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_import_raw_text.png -------------------------------------------------------------------------------- /screenshots/postman_remove_metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_remove_metadata.png -------------------------------------------------------------------------------- /screenshots/postman_set_active_env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_set_active_env.png -------------------------------------------------------------------------------- /screenshots/postman_update_metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_update_metadata.png -------------------------------------------------------------------------------- /screenshots/postman_customer_endpoints.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_customer_endpoints.png -------------------------------------------------------------------------------- /screenshots/postman_fork_env_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_fork_env_template.png -------------------------------------------------------------------------------- /screenshots/postman_import_collection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_import_collection.png -------------------------------------------------------------------------------- /screenshots/postman_set_key_and_save.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_set_key_and_save.png -------------------------------------------------------------------------------- /screenshots/postman_create_customer_send.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_create_customer_send.png -------------------------------------------------------------------------------- /screenshots/postman_secret_key_mouseover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_secret_key_mouseover.png -------------------------------------------------------------------------------- /screenshots/postman_set_collection_environment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_set_collection_environment.png -------------------------------------------------------------------------------- /screenshots/postman_create_customer_with_email_request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_create_customer_with_email_request.png -------------------------------------------------------------------------------- /screenshots/postman_create_customer_with_email_response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_create_customer_with_email_response.png -------------------------------------------------------------------------------- /screenshots/postman_customer_create_no_params_response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stripe/stripe-postman/master/screenshots/postman_customer_create_no_params_response.png -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ### Reporting a vulnerability 4 | 5 | Please do not open GitHub issues or pull requests - this makes the problem immediately visible to everyone, including malicious actors. 6 | 7 | Security issues in this open source project can be safely reported to Stripe's [Vulnerability Disclosure and Reward Program](https://stripe.com/docs/security/stripe#disclosure-and-reward-program). 8 | Stripe's security team will triage your report and respond according to its impact on Stripe users and systems. 9 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Stripe, Inc. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at conduct@stripe.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | #CHANGELOG 2 | 3 | ## Changelog 4 | ## 2024-04-15 5 | * Add support for `balances` and `payouts_list` on `AccountSession#create.components` and `AccountSession.components` 6 | * Change `AccountSession.components.payment_details.features.destination_on_behalf_of_charge_management` and `AccountSession.components.payments.features.destination_on_behalf_of_charge_management` to be required 7 | * Change type of `Dispute.payment_method_details.card` from `nullable(DisputePaymentMethodDetailsCard)` to `DisputePaymentMethodDetailsCard` 8 | * Change `Dispute.payment_method_details.card` to be optional 9 | * Remove support for `config` on `Forwarding.Request#create` and `Forwarding.Request` 10 | * Add support for `swish` on `PaymentMethodConfiguration#create`, `PaymentMethodConfiguration#update`, and `PaymentMethodConfiguration` 11 | 12 | ## 2024-04-13 13 | * Add support for new resource `Entitlements.ActiveEntitlementSummary` 14 | * Change `Billing.MeterEvent#create.timestamp` to be optional 15 | * Add support for new value `entitlements.active_entitlement_summary.updated` on enum `Event.type` 16 | * Add support for new value `entitlements.active_entitlement_summary.updated` on enums `WebhookEndpoint#create.enabled_events[]` and `WebhookEndpoint#update.enabled_events[]` 17 | 18 | ## 2024-04-11 19 | * Add support for `account_management` and `notification_banner` on `AccountSession#create.components` and `AccountSession.components` 20 | * Add support for `external_account_collection` on `AccountSession#create.components.account_onboarding.features` and `AccountSession.components.account_onboarding.features` 21 | * Add support for new values `billing_policy_remote_function_response_invalid`, `billing_policy_remote_function_timeout`, `billing_policy_remote_function_unexpected_status_code`, and `billing_policy_remote_function_unreachable` on enums `Invoice.last_finalization_error.code`, `PaymentIntent.last_payment_error.code`, `SetupAttempt.setup_error.code`, `SetupIntent.last_setup_error.code`, and `StripeError.code` 22 | * Change `Billing.MeterEventAdjustment#create.cancel.identifier` and `Billing.MeterEventAdjustment#create.cancel` to be optional 23 | * Change `Billing.MeterEventAdjustment#create.type` to be required 24 | * Change type of `Billing.MeterEventAdjustment.cancel` from `BillingMeterResourceBillingMeterEventAdjustmentCancel` to `nullable(BillingMeterResourceBillingMeterEventAdjustmentCancel)` 25 | * Add support for `amazon_pay` on `Charge.payment_method_details`, `Checkout.Session#create.payment_method_options`, `Checkout.Session.payment_method_options`, `ConfirmationToken.payment_method_preview`, `ConfirmationToken.testHelpers#create.payment_method_data`, `PaymentIntent#confirm.payment_method_data`, `PaymentIntent#confirm.payment_method_options`, `PaymentIntent#create.payment_method_data`, `PaymentIntent#create.payment_method_options`, `PaymentIntent#update.payment_method_data`, `PaymentIntent#update.payment_method_options`, `PaymentIntent.payment_method_options`, `PaymentMethod#create`, `PaymentMethodConfiguration#create`, `PaymentMethodConfiguration#update`, `PaymentMethodConfiguration`, `PaymentMethod`, `Refund.destination_details`, `SetupIntent#confirm.payment_method_data`, `SetupIntent#confirm.payment_method_options`, `SetupIntent#create.payment_method_data`, `SetupIntent#create.payment_method_options`, `SetupIntent#update.payment_method_data`, `SetupIntent#update.payment_method_options`, and `SetupIntent.payment_method_options` 26 | * Add support for new value `ownership` on enums `Checkout.Session#create.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `Checkout.Session.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `Invoice#create.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `Invoice#update.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `PaymentIntent#confirm.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `PaymentIntent#create.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `PaymentIntent#update.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `PaymentIntent.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `SetupIntent#confirm.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `SetupIntent#create.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `SetupIntent#update.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `SetupIntent.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `Subscription#create.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[]`, `Subscription#update.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[]`, and `Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[]` 27 | * Add support for new value `amazon_pay` on enum `Checkout.Session#create.payment_method_types[]` 28 | * Add support for new values `bh_vat`, `kz_bin`, `ng_tin`, and `om_vat` on enums `Checkout.Session.customer_details.tax_ids[].type`, `Invoice.customer_tax_ids[].type`, `Tax.Calculation.customer_details.tax_ids[].type`, `Tax.Transaction.customer_details.tax_ids[].type`, and `TaxId.type` 29 | * Add support for new value `amazon_pay` on enums `ConfirmationToken.testHelpers#create.payment_method_data.type`, `PaymentIntent#confirm.payment_method_data.type`, `PaymentIntent#create.payment_method_data.type`, `PaymentIntent#update.payment_method_data.type`, `SetupIntent#confirm.payment_method_data.type`, `SetupIntent#create.payment_method_data.type`, and `SetupIntent#update.payment_method_data.type` 30 | * Add support for new value `amazon_pay` on enums `ConfirmationToken.payment_method_preview.type` and `PaymentMethod.type` 31 | * Add support for new values `bh_vat`, `kz_bin`, `ng_tin`, and `om_vat` on enums `Customer#create.tax_id_data[].type`, `Invoice#upcoming.customer_details.tax_ids[].type`, `Invoice#upcomingLines.customer_details.tax_ids[].type`, `Tax.Calculation#create.customer_details.tax_ids[].type`, and `TaxId#create.type` 32 | * Add support for new value `amazon_pay` on enums `Customer#list_payment_methods.type`, `PaymentMethod#create.type`, and `PaymentMethod#list.type` 33 | * Add support for `next_refresh_available_at` on `FinancialConnections.Account.ownership_refresh` 34 | * Add support for new value `ownership` on enums `Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections.permissions[]` and `Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections.permissions[]` 35 | * Add support for `capture_method` on `PaymentIntent#confirm.payment_method_options.revolut_pay`, `PaymentIntent#create.payment_method_options.revolut_pay`, `PaymentIntent#update.payment_method_options.revolut_pay`, and `PaymentIntent.payment_method_options.revolut_pay` -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | > ## Now available within Postman's API Network 3 | > The Stripe API Collection is now hosted within [Stripe's public workspace](https://www.postman.com/stripedev/workspace/stripe-developers/overview) 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. 4 | ## Stripe API Postman Collection 5 | This is a postman collection covering the Stripe API. See https://stripe.com/docs/api for more details. 6 | ## Prerequisites 7 | - [Postman](https://www.getpostman.com/downloads/) 8 | - [Stripe Account](https://dashboard.stripe.com/register) 9 | ## Getting Started 10 | To get started you can either fork the collection from [Stripe's public workspace](https://www.postman.com/stripedev/workspace/stripe-developers/overview) within Postman or import the collection JSON file from this repo. 11 | ### Fork the collection from Stripe's public workspace 12 | From within the [Stripe's public workspace](https://www.postman.com/stripedev/workspace/stripe-developers/overview), fork the Stripe API collection: 13 | 14 | ![Fork collection](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_fork_collection.png) 15 | 16 | Enter a name for your fork and select the workspace where it will be created: 17 | 18 | ![Fork form](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_fork_form.png) 19 | 20 | You can also fork the environment template from the Stripe Developers Workspace: 21 | 22 | ![Fork environment template](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_fork_env_template.png) 23 | 24 | Next: [Set your API key](#set-your-api-key) 25 | ### Import the collection file into your workspace 26 | If you don't want to fork the collection from the public workspace, you can import it from this repo. 27 | 28 | Within your Postman workspace select the Import button: 29 | 30 | ![Import collection](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_import_collection.png) 31 | 32 | Next copy the [StripeAPICollection.json](https://github.com/stripe/stripe-postman/blob/master/StripeAPICollection.json) contents and paste in the **Paste Raw Text** section of the import dialog: 33 | 34 | ![Import raw text](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_import_raw_text.png) 35 | 36 | ### Set your API key 37 | To run requests you'll need to supply your [testmode secret API key](https://dashboard.stripe.com/test/apikeys) and set it as an [environment variable](https://learning.postman.com/docs/sending-requests/variables/) within your workspace. 38 | 39 | To set any environment variable, fork the environment template within the Stripe public workspace, or create a new envionment within Postman: 40 | 41 | ![create a new environment](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_create_new_env.png) 42 | 43 | Add your secret key as a variable to the environment and save: 44 | 45 | ![set API key](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_set_key_and_save.png) 46 | 47 | Set the environment to active: 48 | 49 | ![save as active](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_set_active_env.png) 50 | 51 | Now within the collection set it to use the environment you just created: 52 | 53 | ![set collection environment](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_set_collection_environment.png) 54 | 55 | 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: 56 | 57 | ![secret key mouseover](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_secret_key_mouseover.png) 58 | 59 | 60 | 61 | Be sure to save the collection after you've configured the set the key: 62 | 63 | ![save key](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_save_key.png) 64 | 65 | ## Make a test call 66 | You should be ready now to make a test call. An easy first call is to create a customer: 67 | 68 | ![customer endpoints](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_customer_endpoints.png) 69 | 70 | Since no parameters are required to create a customer, you can just hit the Send button to run this request: 71 | 72 | ![create customer send](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_create_customer_send.png) 73 | 74 | If your environment is set up you'll get a customer object back as the response to the call: 75 | 76 | ![create customer send](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_customer_create_no_params_response.png) 77 | 78 | 79 | 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: 80 | 81 | ![create customer with email](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_create_customer_with_email_request.png) 82 | 83 | You'll see the email address in the reponse: 84 | 85 | ![create customer with email](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_create_customer_with_email_response.png) 86 | 87 | ## Passing Metadata In a Request 88 | Right now [metadata](https://stripe.com/docs/api/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: 89 | 90 | ![set metadata on a request](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_set_metadata.png) 91 | 92 | 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: 93 | 94 | ![clear metadata key](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_update_metadata.png) 95 | 96 | To remove all metadata pass the `metadata` parameter without a value set: 97 | 98 | ![remove metadata key](https://raw.github.com/stripe/stripe-postman/master/screenshots/postman_remove_metadata.png) 99 | 100 | ## Other useful links 101 | - [Stripe API docs](https://docs.stripe.com/api) 102 | - [Stripe Developers YouTube](https://www.youtube.com/stripedevelopers) 103 | 104 | To keep track of major Stripe API updates and version, reference the [API upgrades page](https://docs.stripe.com/upgrades#api-versions) in our documentation. For a detailed list of API changes, please refer to our [API Changelog](https://docs.stripe.com/changelog). 105 | 106 | 107 | ## We want to hear from you 108 | We want to hear how we can make the collection better! Don't hestiate to file [issues](https://github.com/stripe/stripe-postman/issues) for any bugs you encounters, features you'd like to see or other suggestions you have. 109 | --------------------------------------------------------------------------------