Create Payment Request with BTCPay Server API on New Invoice Created from Recurly API

Pipedream makes it easy to connect APIs for BTCPay Server, Recurly and 2,700+ other apps remarkably fast.

Trigger workflow on

New Invoice Created from the Recurly API

Next, do this

Create Payment Request with the BTCPay Server 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 Recurly trigger and BTCPay Server action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Invoice Created trigger
1. Connect your Recurly account
2. Configure Polling schedule
Configure the Create Payment Request action
1. Connect your BTCPay Server account
2. Select a Store ID
3. Configure Amount
4. Configure Title
5. Optional- Configure Currency
6. Optional- Configure Description
7. Optional- Configure Email
8. Optional- Configure Expiry Date
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 Invoice Created on Recurly

Description:Emit new event when a new invoice is created. [See the docs](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_invoices).

Version:0.0.1

Key:recurly-new-invoice-created

View on GitHub

Recurly Overview#

Recurly API provides robust functionality for subscription management, including creating and updating customer accounts, managing billing information, and handling subscription lifecycle events. With Pipedream, you can leverage these capabilities to create automated workflows that respond to events in Recurly, sync data with other systems, and perform actions that enhance your subscription operations and customer experiences.

Trigger Code#

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

export default {
  ...common,
  key: "recurly-new-invoice-created",
  name: "New Invoice Created",
  description: "Emit new event when a new invoice is created. [See the docs](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_invoices).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    listInvoices(args = {}) {
      return this.app.makeRequest({
        method: "listInvoices",
        ...args,
      });
    },
    getResourcesFn() {
      return this.listInvoices;
    },
    getResourcesFnArgs() {
      const lastCreatedAt = this.getLastCreatedAt();
      if (lastCreatedAt) {
        return {
          params: {
            limit: constants.DEFAULT_LIMIT,
            beginTime: lastCreatedAt,
          },
        };
      }
      return {
        params: {
          limit: constants.DEFAULT_LIMIT,
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        ts: Date.parse(resource.createdAt),
        summary: `New Invoice ID ${resource.id}`,
      };
    },
  },
};

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
Recurly	`app`	`app`	This component uses the Recurly app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the Recurly API

Trigger Authentication#

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

To access your API key, navigate to Integrations > API Credentials in your Recurly account (https://[your_subdomain].recurly.com/integrations/api_keys).

About Recurly#

The subscription management platform delivering unrivaled results to smart brands worldwide.

Action#

Create Payment Request on BTCPay Server

Description:Generates a new payment request for a user. [See the documentation](https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_CreatePaymentRequest)

Version:0.0.1

Key:btcpay_server-create-payment-request

View on GitHub

BTCPay Server Overview#

The BTCPay Server API provides a robust interface for automating payment processing, managing invoices, and overseeing stores within a BTCPay Server instance. Leveraging Pipedream, you can build powerful serverless workflows that react to events in BTCPay Server, such as new payments or invoice statuses, and integrate with countless other services through Pipedream's platform.

Action Code#

import btcPayServer from "../../btcpay_server.app.mjs";

export default {
  key: "btcpay_server-create-payment-request",
  name: "Create Payment Request",
  description: "Generates a new payment request for a user. [See the documentation](https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_CreatePaymentRequest)",
  version: "0.0.1",
  type: "action",
  props: {
    btcPayServer,
    storeId: {
      propDefinition: [
        btcPayServer,
        "storeId",
      ],
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "The amount of the payment request",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the payment request",
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "The currency of the payment request. If empty, the store's default currency code will be used.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the payment request",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email used in invoices generated by the payment request",
      optional: true,
    },
    expiryDate: {
      type: "string",
      label: "Expiry Date",
      description: "The expiry date of the payment request in ISO 8601 format.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.btcPayServer.createPaymentRequest({
      $,
      storeId: this.storeId,
      data: {
        amount: this.amount,
        currency: this.currency,
        title: this.title,
        description: this.description,
        email: this.email,
        expiryDate: this.expiryDate && (Date.parse(this.expiryDate)) / 1000,
      },
    });
    $.export("$summary", `Successfully created payment request with ID: ${response.id}`);
    return response;
  },
};

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
BTCPay Server	`btcPayServer`	`app`	This component uses the BTCPay Server app.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
Amount	`amount`	`string`	The amount of the payment request
Title	`title`	`string`	The title of the payment request
Currency	`currency`	`string`	The currency of the payment request. If empty, the store's default currency code will be used.
Description	`description`	`string`	The description of the payment request
Email	`email`	`string`	The email used in invoices generated by the payment request
Expiry Date	`expiryDate`	`string`	The expiry date of the payment request in ISO 8601 format.