Create Payment Request with BTCPay Server API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Create Payment Request with the BTCPay Server API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Payment Request with BTCPay Server API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + BTCPay Server

Try it

Create Payment Request with BTCPay Server API on New Submission from Typeform API

Typeform + BTCPay Server

Try it

Create Payment Request with BTCPay Server API on Custom Events from Zoom API

Zoom + BTCPay Server

Try it

Create Payment Request with BTCPay Server API on New Submission (Instant) from Jotform API

Jotform + BTCPay Server

Try it

Create Payment Request with BTCPay Server API on New Scheduled Tasks from Pipedream API

Pipedream + BTCPay Server

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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.2

Key:btcpay_server-create-payment-request

View on GitHub

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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;
  },
};

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
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.