Cancel Or Reverse a Payout with Stripe API on New Payment Failure from Zoho Subscriptions API

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

Trigger workflow on

New Payment Failure from the Zoho Subscriptions API

Next, do this

Cancel Or Reverse a Payout 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 Zoho Subscriptions 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 New Payment Failure trigger
1. Connect your Zoho Subscriptions account
2. Configure Polling interval
3. Select a Organization Id
Configure the Cancel Or Reverse a Payout action
1. Connect your Stripe account
2. Select a Payout ID
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#

New Payment Failure on Zoho Subscriptions

Description:Emit new event when a payment fails to process.

Version:0.0.1

Key:zoho_subscriptions-payment-failure

View on GitHub

Zoho Subscriptions Overview#

The Zoho Subscriptions API allows you to manage various aspects of subscription-based billing services. With this API, you can automate tasks such as creating subscriptions, handling customer billing info, and managing invoices. In Pipedream, you can harness this API to build workflows that respond to events in Zoho Subscriptions or to perform actions based on triggers from other apps. This enables seamless automation of billing operations and integration with your broader app ecosystem.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import zohoSubscriptions from "../../zoho_subscriptions.app.mjs";

export default {
  key: "zoho_subscriptions-payment-failure",
  name: "New Payment Failure",
  version: "0.0.1",
  description: "Emit new event when a payment fails to process.",
  type: "source",
  dedupe: "unique",
  props: {
    zohoSubscriptions,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Zoho Subscriptions on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    organizationId: {
      propDefinition: [
        zohoSubscriptions,
        "organizationId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults) {
      const lastDate = this._getLastDate();
      let responseArray = [];

      const items = this.zohoSubscriptions.paginate({
        fn: this.zohoSubscriptions.listEvents,
        params: {
          event_type: "payment_declined",
          date_start: lastDate || "1970-01-01",
          date_end: moment().format("YYYY-MM-DD"),
        },
        organizationId: this.organizationId,
        maxResults,
      });

      for await (const item of items) {
        responseArray.push(item);
      }

      if (responseArray[0]) {
        this._setLastDate(responseArray[0].event_time);
      }

      for (const responseItem of responseArray.reverse()) {
        const event = await this.zohoSubscriptions.getEvent({
          eventId: responseItem.event_id,
          organizationId: this.organizationId,
        });

        this.$emit(
          event,
          {
            id: responseItem.event_id,
            summary: `New event with id: "${responseItem.event_id}" was created!`,
            ts: new Date(),
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
};

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
Zoho Subscriptions	`zohoSubscriptions`	`app`	This component uses the Zoho Subscriptions app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Zoho Subscriptions on this schedule
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

ZohoSubscriptions.fullaccess.all

About Zoho Subscriptions#

Subscription billing software, crafted for growing businesses.

Action#

Cancel Or Reverse a Payout on Stripe

Description:Cancel or reverse a [payout](https://stripe.com/docs/payouts). A payout can be canceled only if it has not yet been paid out. A payout can be reversed only if it has already been paid out. Funds will be refunded to your available balance. [See the docs](https://stripe.com/docs/api/payouts/cancel) for more information

Version:0.1.0

Key:stripe-cancel-or-reverse-payout

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 app from "../../stripe.app.mjs";

export default {
  key: "stripe-cancel-or-reverse-payout",
  name: "Cancel Or Reverse a Payout",
  type: "action",
  version: "0.1.0",
  description: "Cancel or reverse a [payout](https://stripe.com/docs/payouts). " +
    "A payout can be canceled only if it has not yet been paid out. A payout can be reversed " +
    "only if it has already been paid out. Funds will be refunded to your available balance. [See" +
    " the docs](https://stripe.com/docs/api/payouts/cancel) for more information",
  props: {
    app,
    id: {
      propDefinition: [
        app,
        "payout",
      ],
      optional: false,
    },
  },
  async run({ $ }) {
    const payout = await this.app.sdk().payouts.retrieve(this.id);
    let resp;
    switch (payout.status) {
    case "paid":
      resp = await this.app.sdk().payouts.reverse(this.id);
      $.export("$summary", "Successfully reversed paid payout");
      return resp;
    case "pending":
      resp = await this.app.sdk().payouts.cancel(this.id);
      $.export("$summary", "Successfully cancelled pending payout");
      return resp;
    case "in_transit":
      throw new Error("Payment is in transit");
    case "canceled":
      throw new Error("Payment has already been canceled");
    case "failed":
      throw new Error("Payment has already failed");
    }
  },
};

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.
Payout ID	`id`	`string`	Select a value from the drop down menu.

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 + Zoho Subscriptions#

Other Popular Integrations#

Create Customer with Zoho Subscriptions API on Canceled Subscription from Stripe API

Stripe + Zoho Subscriptions

Cancel Or Reverse a Payout with Stripe API on New Payment Failure from Zoho Subscriptions API

Pipedream makes it easy to connect APIs for Stripe, Zoho Subscriptions 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