View as Markdown
BTCPay Server icon

BTCPay Server ACTION

Create Payment Request

Generates a new payment request for a user. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BTCPay Server account once, then configure and run Create Payment Request from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "btcpay_server-create-payment-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    btcpay_server: { authProvisionId: "apn_xxxxxxx" },
    storeId: "Store ID",
    amount: "Amount",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Payment Request inputs
Property Type Description
storeId Store ID string
Identifier of a store
Required Dynamic
amount Amount string
The amount of the payment request
Required
title Title string
The title of the payment request
Required
currency Currency string
The currency of the payment request. If empty, the store's default currency code will be used.
Optional
description Description string
The description of the payment request
Optional
email Email string
The email used in invoices generated by the payment request
Optional
expiryDate Expiry Date string
The expiry date of the payment request in ISO 8601 format.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
btcpay_server-create-payment-request
Version
0.0.2
App
BTCPay Server
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes