Create Payment Request with BTCPay Server API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule 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 Schedule 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 Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron 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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

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.