Cancel a Payment Intent with Stripe API on Catalog Item Updated from Square API

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

Trigger workflow on

Catalog Item Updated from the Square 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 Square 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 Catalog Item Updated trigger
1. Connect your Square account
2. Configure timer
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#

Catalog Item Updated on Square

Description:Emit new event every time a catalog item is updated. [See the docs](https://developer.squareup.com/reference/square/catalog-api/list-catalog)

Version:0.0.3

Key:square-catalog-item-updated

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-catalog-item-updated",
  name: "Catalog Item Updated",
  description: "Emit new event every time a catalog item is updated. [See the docs](https://developer.squareup.com/reference/square/catalog-api/list-catalog)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { objects } = await this.square.listCatalogItems({
        params: {
          ...this.getBaseParams(),
        },
      });
      if (!(objects?.length > 0)) {
        return;
      }

      let newLastTs = 0;
      for (const object of objects.slice(0, constants.MAX_HISTORICAL_EVENTS)) {
        if (Date.parse(object.updated_at) > newLastTs) {
          newLastTs = Date.parse(object.updated_at);
        }
        this.$emit(object, this.generateMeta(object));
      }
      this._setLastTs(newLastTs);
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        types: "ITEM",
      };
    },
    generateMeta(object) {
      const ts = Date.parse(object.updated_at);
      return {
        id: `${object.id}${ts}`,
        summary: `Catalog Item Updated: ${object.id}`,
        ts,
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs = lastTs;
    let cursor;

    do {
      const response = await this.square.listCatalogItems({
        params: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { objects } = response;
      if (!(objects?.length > 0)) {
        break;
      }
      for (const object of objects) {
        if (Date.parse(object.updated_at) > lastTs) {
          newLastTs = Date.parse(object.updated_at);
        }
        this.emitEvent(object);
      }
      cursor = response?.cursor;
    } while (cursor);

    this._setLastTs(newLastTs);
  },
};

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
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

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 + Square#

Other Popular Integrations#

Create Customer with Square API on New Custom Webhook Events from Stripe API

Stripe + Square

Cancel a Payment Intent with Stripe API on Catalog Item Updated from Square API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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