Cancel Or Reverse a Payout with Stripe API on New Webhook Event (Instant) from Payhere API

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

Trigger workflow on

New Webhook Event (Instant) from the Payhere 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 Payhere 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 Webhook Event (Instant) trigger
1. Connect your Payhere account
2. Configure Integration Name
3. Select a Event Type
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 Webhook Event (Instant) on Payhere

Description:Emit new event for each new webhook event

Version:0.0.1

Key:payhere-new-webhook-event

View on GitHub

Payhere Overview#

Payhere, powered by Xendit, offers a powerful API that allows you to craft seamless payment experiences within your apps and websites. By leveraging this API on Pipedream, you can automate payment processing, synchronize transaction data with accounting systems, or trigger communication based on payment events. Pipedream's serverless platform enables the orchestration of Payhere with an array of other services to streamline financial operations, enhance customer engagement, and maintain robust financial records.

Trigger Code#

import payhere from "../../payhere.app.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "payhere-new-webhook-event",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for each new webhook event",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    payhere,
    db: "$.service.db",
    http: "$.interface.http",
    integrationName: {
      label: "Integration Name",
      description: "Friendly name of your platform, helps with metrics and debugging",
      type: "string",
    },
    resource: {
      label: "Event Type",
      description: "The event that will be listen",
      type: "string",
      options: constants.WEBHOOK_EVENT_TYPES,
    },
  },
  methods: {
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const response = await this.payhere.createWebhook({
        integration: this.integrationName,
        post_url: this.http.endpoint,
        resource: this.resource,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.payhere.removeWebhook(webhookId);
    },
  },
  async run(event) {
    const { body } = event;

    const resourceId = body?.payment?.id ?? body?.subscription?.id;
    const ts = body?.payment?.created_at ?? body?.subscription?.created_at;

    this.$emit(body, {
      id: resourceId,
      summary: `New event ${body.event} with id ${resourceId}`,
      ts: Date.parse(ts),
    });
  },
};

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
Payhere	`payhere`	`app`	This component uses the Payhere 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.
Integration Name	`integrationName`	`string`	Friendly name of your platform, helps with metrics and debugging
Event Type	`resource`	`string`	Select a value from the drop down menu:`{ "label": "Payment Received", "value": "payment_received" }{ "label": "Subscription Cancelled", "value": "subscription_cancelled" }{ "label": "Subscription Created", "value": "subscription_created" }`

Trigger Authentication#

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

You can find your API key in the integrations section of the merchants admin.

For environment, Payhere provides a sandbox site so you can easily test your integration without using your own money. See docs. If you aren't testing, use the production option.

About Payhere#

Easy payment links

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

Other Popular Integrations#

List Invoices with Stripe API on New Webhook Event (Instant) from Payhere API

Payhere + Stripe

Cancel Or Reverse a Payout with Stripe API on New Webhook Event (Instant) from Payhere API

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