Cancel Or Reverse a Payout with Stripe API on Balance Updated from Mocean API API

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

Trigger workflow on

Balance Updated from the Mocean API 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 Mocean API 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 Balance Updated trigger
1. Connect your Mocean API account
2. Configure timer
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#

Balance Updated on Mocean API

Description:Emit new event when the account balance has been updated. [See the documentation](https://moceanapi.com/docs/#get-balance)

Version:0.0.1

Key:mocean_api-balance-updated

View on GitHub

Mocean API Overview#

The Mocean API provides tools for sending SMS and making voice calls, enabling you to integrate communication features into your applications or workflows seamlessly. With MoceanAPI on Pipedream, you can automate sending notifications, create alert systems, or even implement two-factor authentication (2FA). It interacts with other apps and services to craft powerful, event-driven automation.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "mocean_api-balance-updated",
  name: "Balance Updated",
  description: "Emit new event when the account balance has been updated. [See the documentation](https://moceanapi.com/docs/#get-balance)",
  version: "0.0.1",
  type: "source",
  methods: {
    ...common.methods,
    _getPreviousBalance() {
      return this.db.get("previousBalance");
    },
    _setPreviousBalance(previousBalance) {
      this.db.set("previousBalance", previousBalance);
    },
    generateMeta(balance) {
      return {
        id: Date.now(),
        summary: `New Balance ${balance.value}`,
        ts: Date.now(),
      };
    },
  },
  async run() {
    const previousBalance = this._getPreviousBalance();
    const balance = await this.mocean.getBalance();
    if (balance.value !== previousBalance) {
      const meta = this.generateMeta(balance);
      this.$emit(balance, meta);
    }
    this._setPreviousBalance(balance.value);
  },
};

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

Trigger Authentication#

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

About Mocean API#

Mocean is a communication platform that provides an API and SDK for software developers to programmatically send and receive SMS worldwide, and perform other communication functions.

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 + Mocean API#

Other Popular Integrations#

Get Balance with Mocean API API on Canceled Subscription from Stripe API

Stripe + Mocean API

Cancel Or Reverse a Payout with Stripe API on Balance Updated from Mocean API API

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