← Stripe

Capture a Payment Intent with Stripe API

Pipedream makes it easy to connect APIs for Stripe and 2,500+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Capture a Payment Intent with the Stripe API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Capture a Payment Intent with the Stripe API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Capture a Payment Intent action
    1. Connect your Stripe account
    2. Configure alert
    3. Select a Payment Intent ID
    4. Optional- Configure Amount
    5. Optional- Configure Metadata
    6. Optional- Configure Application Fee Amount
    7. Optional- Configure Final Capture
    8. Optional- Configure Statement Descriptor
    9. Optional- Configure Statement Descriptor Suffix
    10. Optional- Configure Transfer Data Amount
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Capture a Payment Intent with Stripe API on New Requests from HTTP / Webhook API
HTTP / Webhook + Stripe
 
Try it
Capture a Payment Intent with Stripe API on New Item in Feed from RSS API
RSS + Stripe
 
Try it
Capture a Payment Intent with Stripe API on New Message from Discord API
Discord + Stripe
 
Try it
Capture a Payment Intent with Stripe API on New Message In Channels from Slack API
Slack + Stripe
 
Try it
Capture a Payment Intent with Stripe API on New Message in Channel from Discord Bot API
Discord Bot + Stripe
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Capture a Payment Intent on Stripe
Description:Capture the funds of an existing uncaptured payment intent. [See the documentation](https://stripe.com/docs/api/payment_intents/capture).
Version:0.1.2
Key:stripe-capture-payment-intent

Code

import app from "../../stripe.app.mjs";

export default {
  key: "stripe-capture-payment-intent",
  name: "Capture a Payment Intent",
  type: "action",
  version: "0.1.2",
  description: "Capture the funds of an existing uncaptured payment intent. [See the documentation](https://stripe.com/docs/api/payment_intents/capture).",
  props: {
    app,
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    alert: {
      type: "alert",
      alertType: "info",
      content: "Use this Pipedream component to capture funds from an existing PaymentIntent if its status is `requires_capture`. Be aware that uncaptured PaymentIntents will automatically cancel after a certain period (typically 7 days), so ensure timely capture. This process is part of a separate authorization and capture flow for payments. [See the documentation](https://stripe.com/docs/api/payment_intents/capture).",
    },
    id: {
      propDefinition: [
        app,
        "paymentIntent",
      ],
      optional: false,
    },
    amountToCapture: {
      description: "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided.",
      propDefinition: [
        app,
        "amount",
      ],
    },
    metadata: {
      propDefinition: [
        app,
        "metadata",
      ],
    },
    applicationFeeAmount: {
      type: "integer",
      label: "Application Fee Amount",
      description: "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.",
      optional: true,
    },
    finalCapture: {
      type: "boolean",
      label: "Final Capture",
      description: "When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents.",
      optional: true,
    },
    statementDescriptor: {
      propDefinition: [
        app,
        "statementDescriptor",
      ],
    },
    statementDescriptorSuffix: {
      type: "string",
      label: "Statement Descriptor Suffix",
      description: "Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.",
      optional: true,
    },
    transferDataAmount: {
      type: "integer",
      label: "Transfer Data Amount",
      description: "The amount that will be transferred automatically when a charge succeeds.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      id,
      amountToCapture,
      metadata,
      applicationFeeAmount,
      finalCapture,
      statementDescriptor,
      statementDescriptorSuffix,
      transferDataAmount,
    } = this;

    const resp = await this.app.sdk().paymentIntents.capture(id, {
      amount_to_capture: amountToCapture,
      metadata,
      application_fee_amount: applicationFeeAmount,
      final_capture: finalCapture,
      statement_descriptor: statementDescriptor,
      statement_descriptor_suffix: statementDescriptorSuffix,
      ...(transferDataAmount && {
        transfer_data: {
          amount: transferDataAmount,
        },
      }),
    });
    $.export("$summary", `Successfully captured ${amountToCapture
      ? amountToCapture
      : `the full ${resp.amount_capturable}`} from the payment intent`);
    return resp;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
StripeappappThis component uses the Stripe app.
Payment Intent IDidstringSelect a value from the drop down menu.
AmountamountToCaptureinteger

The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full amount_capturable if it's not provided.

Metadatametadataobject

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Application Fee AmountapplicationFeeAmountinteger

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

Final CapturefinalCaptureboolean

When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents.

Statement DescriptorstatementDescriptorstring

Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

Statement Descriptor SuffixstatementDescriptorSuffixstring

Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

Transfer Data AmounttransferDataAmountinteger

The amount that will be transferred automatically when a charge succeeds.

Authentication

Stripe uses API keys for authentication. When you connect your Stripe account, Pipedream securely stores the keys so you can easily authenticate to Stripe APIs in both code and no-code steps.

About Stripe

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

More Ways to Use Stripe

Triggers

New Custom Webhook Events from the Stripe API

Emit new event on each webhook event

 
Try it
Canceled Subscription from the Stripe API

Emit new event for each new canceled subscription

 
Try it
New Abandoned Cart from the Stripe API

Emit new event when a customer abandons their cart.

 
Try it
New Customer from the Stripe API

Emit new event for each new customer

 
Try it
New Dispute from the Stripe API

Emit new event for each new dispute

 
Try it

Actions

Cancel A Payment Intent with the Stripe API

Cancel a PaymentIntent. See the documentation

 
Try it
Cancel Or Reverse A Payout with the Stripe API

Cancel a pending payout or reverse a paid payout. See the documentation here and here

 
Try it
Confirm A Payment Intent with the Stripe API

Confirm that your customer intends to pay with current or provided payment method. See the documentation

 
Try it
Create a Customer with the Stripe API

Create a customer. See the documentation

 
Try it
Create a Payment Intent with the Stripe API

Create a payment intent. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,500+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.