Cancel a Payment Intent with Stripe API on Order Allocated (Instant) from ShipHero API

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

Trigger workflow on

Order Allocated (Instant) from the ShipHero API

Next, do this

Cancel a Payment Intent with the Stripe API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a ShipHero trigger and Stripe action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Order Allocated (Instant) trigger
1. Connect your ShipHero account
2. Configure Shop Name
Configure the Cancel a Payment Intent action
1. Connect your Stripe account
2. Select a Payment Intent ID
3. Optional- Select a Cancellation Reason
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Order Allocated (Instant) on ShipHero

Description:Emit new event when an order is allocated. [See the documentation](https://developer.shiphero.com/webhooks#webhook_create).

Version:0.0.1

Key:shiphero-order-allocated-instant

View on GitHub

ShipHero Overview#

The ShipHero API enables granular control over warehousing and order fulfillment processes, offering endpoints for managing inventory, orders, returns, and shipping. In Pipedream, you can leverage this API to automate routine tasks, sync data across multiple platforms, and trigger actions based on specific events. This can save time, reduce errors, and increase operational efficiency for e-commerce businesses.

Trigger Code#

import common from "../common/webhook.mjs";
import events from "../common/events.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "shiphero-order-allocated-instant",
  name: "Order Allocated (Instant)",
  description: "Emit new event when an order is allocated. [See the documentation](https://developer.shiphero.com/webhooks#webhook_create).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventName() {
      return events.ORDER_ALLOCATED;
    },
    generateMeta(resource) {
      return {
        id: resource.order_id,
        summary: `Order Allocated: ${resource.order_id}`,
        ts: Date.parse(resource.allocated_at),
      };
    },
  },
  sampleEmit,
};

Trigger 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.

Label	Prop	Type	Description
ShipHero	`app`	`app`	This component uses the ShipHero app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Shop Name	`shopName`	`string`	The name of the shop. Eg: `pipedream-api`

Trigger Authentication#

ShipHero uses OAuth authentication. When you connect your ShipHero account, Pipedream will open a popup window where you can sign into ShipHero and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any ShipHero API.

Pipedream requests the following authorization scopes when you connect your account:

About ShipHero#

Whether you want to let go of running your own warehouse, or run your warehouse better, you can do both – and so much more – with ShipHero.

Action#

Cancel a Payment Intent on Stripe

Description:Cancel a [payment intent](https://stripe.com/docs/payments/payment-intents). Once canceled, no additional charges will be made by the payment intent and any operations on the payment intent will fail with an error. For payment intents with status=`requires_capture`, the remaining amount_capturable will automatically be refunded. [See the docs](https://stripe.com/docs/api/payment_intents/cancel) for more information

Version:0.1.0

Key:stripe-cancel-payment-intent

View on GitHub

Stripe Overview#

The Stripe API is a powerful tool for managing online payments, subscriptions, and invoices. With Pipedream, you can leverage this API to automate payment processing, monitor transactions, and sync billing data with other services. Pipedream's no-code platform allows for quick integration and creation of serverless workflows that react to Stripe events in real-time. For instance, you might automatically update customer records, send personalized emails after successful payments, or escalate failed transactions to your support team.

Action Code#

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

export default {
  key: "stripe-cancel-payment-intent",
  name: "Cancel a Payment Intent",
  type: "action",
  version: "0.1.0",
  description: "Cancel a [payment intent](https://stripe.com/docs/payments/payment-intents). " +
    "Once canceled, no additional charges will be made by the payment intent and any operations " +
    "on the payment intent will fail with an error. For payment intents with status=" +
    "`requires_capture`, the remaining amount_capturable will automatically be refunded. [See the" +
    " docs](https://stripe.com/docs/api/payment_intents/cancel) for more information",
  props: {
    app,
    id: {
      propDefinition: [
        app,
        "payment_intent",
      ],
      optional: false,
    },
    cancellation_reason: {
      propDefinition: [
        app,
        "payment_intent_cancellation_reason",
      ],
    },
  },
  async run({ $ }) {
    const params = pick(this, [
      "cancellation_reason",
    ]);
    const resp = await this.app.sdk().paymentIntents.cancel(this.id, params);
    $.export("$summary", "Successfully cancelled payment intent");
    return resp;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Stripe	`app`	`app`	This component uses the Stripe app.
Payment Intent ID	`id`	`string`	Select a value from the drop down menu.
Cancellation Reason	`cancellation_reason`	`string`	Select a value from the drop down menu:`duplicatefraudulentrequested_by_customerabandoned`

Action 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.

Stripe uses API keys to authenticate requests (more info in their docs here).

To connect Pipedream to your Stripe account,

Create a Stripe API key
Click "Create Restricted Key"
Enter the Restricted API key below.

To help ensure proper security, we recommend you create a Restricted key with scopes relevant to the specific operations you will use in Pipedream.

About Stripe#

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

More Ways to Connect Stripe + ShipHero#

Other Popular Integrations#

List Products with ShipHero API on New Abandoned Cart from Stripe API

Stripe + ShipHero

Cancel a Payment Intent with Stripe API on Order Allocated (Instant) from ShipHero API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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