Skip to docs navigation

BTCPay Server integration guide

Verified

How to connect BTCPay Server to WEXTL and use its 1 trigger and 149 actions in your workflows. About BTCPay Server: Self-hosted Bitcoin payments: invoices, payment requests, payouts, stores, webhooks and lightning.

  • 1 trigger
  • 72 searches
  • 77 actions
  • Instant (webhooks)
  • Auth: API key

AI-assisted documentation41 min read

This documentation is compiled from our integration source code, internal specs for BTCPay Server, its official API documentation and anonymized requests logs we collect from our support team[2].

Open BTCPay Server on WEXTL →
  • BTCPay Server
  • WEXTL
  • Chargebee
  • Commas
  • Adyen
  • Altoviz
  • Clientary
  • Billingo
  • Comanage
  • Billogram
  • Billtrust
  • Daftra
  • Billdu
  • Debitura
  • Checkout
  • BlueSnap
  • Coinbase
  • ApproveIt
  • Capium
  • Alpaca
  • 1C:Enterprise (OData)
  • Distru
  • Bybit
  • CoinGecko
  • Credit Repair Cloud
  • Brex
  • bexio
  • Bling
  • Bill
  • Corpay
  • Candis
  • Server URLtextRequired

    The address you open BTCPay Server at, for example https://btcpay.example.com (no path after it unless your server runs under one). It must start with https:// and be reachable from the internet on the standard HTTPS port or a common alternative. Servers on a LAN address, localhost or .onion cannot be reached.[1]

  • API KeypasswordRequired

    In BTCPay Server open Account, Manage Account, API Keys and create a key. Tick only the permissions your workflows need. Unrestricted access works for testing.[1]

  1. Log in to your WEXTL account, add the BTCPay Server node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your BTCPay Server account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant trigger for BTCPay events.
Output fields[3]
FieldType
Delivery IDtext
Webhook IDtext
Is Redeliveryboolean
Original Delivery IDtext
Event Typetext
Timestamp (Unix Seconds)number
Store IDtext
Invoice IDtext

10other output fields

Get a File

ActionLooks up the name and URL of an uploaded file.
Input fields[3]
FieldType
FileRequired
choice
Output fields[3]
FieldType
IDtext
User IDtext
URItext
URLtext
Original Nametext
Storage Nametext
Created (Unix Seconds)number

Get a Lightning Address

ActionLimits and metadata of a Lightning address.
Input fields[3]
FieldType
StoreRequired
choice
UsernameRequired
choice
Output fields[3]
FieldType
Usernametext
Currency Codetext
Mintext
Maxtext
Invoice Metadatatext

Get a Lightning Deposit Address

ActionOn-chain address to fund a node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Output fields[3]
FieldType
Addresstext

Get a Lightning Invoice

ActionLightning invoice with its payment state.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Lightning Invoice IDRequired
text
Output fields[3]
FieldType
IDtext
Statustext
BOLT11text
Paid At (Unix Seconds)number
Expires At (Unix Seconds)number
Amounttext
Amount Receivedtext
Payment Hashtext

2other output fields

Get a Lightning Node Balance

ActionFunds held on a node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Output fields[3]
FieldType
Onchainobject
Confirmedtext
Unconfirmedtext
Reservedtext
Offchainobject
Openingtext
Localtext
Remotetext
Closingtext

Get a Lightning Node Info

ActionIdentity and sync state of a node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Output fields[3]
FieldType
Node UR Isarray
Block Heightnumber
Aliastext
Colortext
Versiontext
Peers Countnumber
Active Channels Countnumber
Inactive Channels Countnumber

1other output field

Get a Lightning Payment

ActionPayment proof from a Lightning node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Payment HashRequired
text
Output fields[3]
FieldType
IDtext
Statustext
BOLT11text
Payment Hashtext
Preimagetext
Created At (Unix Seconds)number
Total Amounttext
Fee Amounttext

Get a Notification

ActionMessage text and link of one notification.
Input fields[3]
FieldType
Notification IDRequired
text
Output fields[3]
FieldType
IDtext
Identifiertext
Typetext
Bodytext
Store IDtext
Linktext
Created Timenumber
Seenboolean

Get a Payment Request

ActionTerms and deadline of a payment request.
Input fields[3]
FieldType
Payment Request IDRequired
text
Output fields[3]
FieldType
Amounttext
Titletext
Currencytext
Emailtext
Descriptiontext
Expiry Datenumber
Reference IDtext
Allow Custom Payment Amountsboolean

6other output fields

Get a Payout

ActionDestination and currency of a payout.
Input fields[3]
FieldType
Payout IDRequired
text
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

Get a Pull Payment

ActionBudget and expiry rules of a pull payment.
Input fields[3]
FieldType
Pull Payment IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Currencytext
Amounttext
BOLT11 Expirationtext
Auto Approve Claimsboolean
Archivedboolean

1other output field

Get a Pull Payment LNURL

ActionLightning link for claiming a pull payment.
Input fields[3]
FieldType
Pull Payment IDRequired
text
Output fields[3]
FieldType
LNURL Bech32text
LNURL URItext

Get a Pull Payment Payout

ActionOne claim made on a pull payment.
Input fields[3]
FieldType
Pull Payment IDRequired
text
Payout IDRequired
text
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

Get a Rate Configuration

ActionExchange rate settings for a store.
Input fields[3]
FieldType
StoreRequired
choice
Rate SourceRequired
choice
Output fields[3]
FieldType
Spreadtext
Preferred Sourcetext
Is Custom Scriptboolean
Effective Scripttext

Get a Store

ActionBranding and identity of one store.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Nametext
Websitetext
Support URLtext
Logo URLtext
CSS URLtext
Payment Sound URLtext
Brand Colortext
Apply Brand Color To Backendboolean

32other output fields

Get a Store Payment Method

ActionStatus and settings of a payment method.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Include Configchoice
Output fields[3]
FieldType
Enabledboolean
Payment Method IDtext
Configobject
Use Bech32 Schemeboolean
Lud12 Enabledboolean
Lud21 Enabledboolean
Connection Stringtext
Derivation Schemetext
Labeltext
Account Key Pathtext

Get a Subscriber

ActionOne subscriber with plan and dates.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
Output fields[3]
FieldType
Created (Unix Seconds)number
Customerobject
Store IDtext
IDtext
External IDtext
Identitiestext
Metadatatext
Offeringobject
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray
Planobject
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber
Descriptiontext
Member Countnumber
Period End (Unix Seconds)number
Trial End (Unix Seconds)number
Grace Period End (Unix Seconds)number
Is Activeboolean

9other output fields

Get a Subscriber Credit

ActionCredit balance held by a subscriber.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
CurrencyRequired
text
Output fields[3]
FieldType
Currencytext
Valuetext

Get a User

ActionProfile and confirmation state of a user.
Input fields[3]
FieldType
User ID or EmailRequired
text
Output fields[3]
FieldType
IDtext
Emailtext
Nametext
Image URLtext
Invitation URLtext
Email Confirmedboolean
Requires Email Confirmationboolean
Approvedboolean

6other output fields

Get a Wallet Fee Rate

ActionCurrent on-chain fee estimate.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Block Targetnumber
Output fields[3]
FieldType
Fee Ratenumber

Get a Wallet Overview

ActionConfirmed and pending funds in a wallet.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Output fields[3]
FieldType
Balancetext
Unconfirmed Balancetext
Confirmed Balancetext

Get a Wallet Receive Address

ActionOn-chain address for receiving funds.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Force New Addresschoice
Output fields[3]
FieldType
Addresstext
Key Pathtext
Payment Linktext

Get a Wallet Transaction

ActionChain position of a wallet transaction.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Transaction IDRequired
text
Output fields[3]
FieldType
Transaction Hashtext
Commenttext
Amounttext
Block Hashtext
Block Heighttext
Confirmationstext
Timestampnumber
Statustext

1other output field

Get a Webhook

ActionAddress and event filter of a webhook.
Input fields[3]
FieldType
Webhook IDRequired
text
Output fields[3]
FieldType
Enabledboolean
Automatic Redeliveryboolean
URLtext
Authorized Eventsobject
Everythingboolean
Specific Eventsarray
IDtext

Get a Webhook Delivery

ActionOutcome and error of one delivery.
Input fields[3]
FieldType
Webhook IDRequired
text
Delivery IDRequired
text
Output fields[3]
FieldType
IDtext
Timestampnumber
Delivery Timenumber
Http Codenumber
Error Messagetext
Statustext

Get a Webhook Delivery Request

ActionPayload sent during one delivery.
Input fields[3]
FieldType
Webhook IDRequired
text
Delivery IDRequired
text
Output fields[3]
FieldType
Requesttext

Get an App

ActionName, kind and archive state of an app.
Input fields[3]
FieldType
AppRequired
choice
Output fields[3]
FieldType
IDtext
App Nametext
Store IDtext
Created (Unix Seconds)number
App Typetext
Archivedboolean

Get an Invoice

ActionFull invoice record with checkout data.
Input fields[3]
FieldType
Invoice IDRequired
text
Include Payment Methodsboolean
Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

9other output fields

Get an Offering

ActionFeatures and redirect of a subscription product.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Output fields[3]
FieldType
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray

Get an Offering Plan

ActionPricing and renewal cycle of a plan.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
PlanRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber

6other output fields

Get App Details

ActionType-dependent app configuration.
Input fields[3]
FieldType
AppRequired
choice
App TypeRequired
choice
Output fields[3]
FieldType
IDtext
App Nametext
Store IDtext
Created (Unix Seconds)number
App Typetext
Archivedboolean
Titletext
Descriptiontext

19other output fields

Get App Sales

ActionSales numbers over recent days.
Input fields[3]
FieldType
AppRequired
choice
Number of Daysnumber
Output fields[3]
FieldType
Sales Countnumber
Seriesarray

Get App Top Items

SearchBest sellers ranked by sales.
Input fields[3]
FieldType
AppRequired
choice
Countnumber
Offsetnumber
Output fields[3]
FieldType
Item Codetext
Titletext
Sales Countnumber
Totaltext
Total Formattedtext

Get Invoice Refund Details

ActionRefund amounts at past and current rates.
Input fields[3]
FieldType
Invoice IDRequired
text
Payment Method IDRequired
text
Output fields[3]
FieldType
Payment Amount Thentext
Payment Amount Nowtext
Invoice Amounttext
Payment Currencytext
Payment Currency Divisibilitynumber
Invoice Currency Divisibilitynumber
Invoice Currencytext
Overpaid Payment Amounttext

Get Lightning Balance History

ActionBalance over time for a node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Output fields[3]
FieldType
Typetext
Balancetext
Seriesarray
Labelsarray

Get Notification Settings

ActionWhich alert types are currently enabled.
Output fields[3]
FieldType
Notificationsarray

Get Store Email Settings

ActionSMTP host and login used for store mail.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Fromtext
Servertext
Portnumber
Logintext
Disable Certificate Checkboolean
Password Setboolean

Get Store Rates

SearchLive conversion rates for chosen pairs.
Input fields[3]
FieldType
StoreRequired
choice
Currency Pairsarray
Currency pairtext
Output fields[3]
FieldType
Currency Pairtext
Errorsarray
Ratetext

Get the Current API Key

ActionInfo about the key in use.
Output fields[3]
FieldType
IDtext
API Keytext
Labeltext
Created (Unix Seconds)number
Permissionsarray

Get the Current User

ActionProfile of the account behind your key.
Output fields[3]
FieldType
IDtext
Emailtext
Nametext
Image URLtext
Invitation URLtext
Email Confirmedboolean
Requires Email Confirmationboolean
Approvedboolean

6other output fields

Get the Server Health

ActionWhether the server is fully synced.
Output fields[3]
FieldType
Synchronizedboolean

Get the Server Info

ActionVersion and sync state of the server.
Output fields[3]
FieldType
Versiontext
Oniontext
Supported Payment Methodsarray
Fully Synchedboolean
Sync Statusarray

Get Wallet History

ActionWallet balance over time.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Output fields[3]
FieldType
Typetext
Balancetext
Seriesarray
Labelsarray

List Apps

SearchApps across all your stores.
Input fields[3]
FieldType
Storechoice
Output fields[3]
FieldType
IDtext
App Nametext
Store IDtext
Created (Unix Seconds)number
App Typetext
Archivedboolean

List Files

SearchUploaded files on the server.
Output fields[3]
FieldType
IDtext
User IDtext
URItext
URLtext
Original Nametext
Storage Nametext
Created (Unix Seconds)number

List Invoice Payment Methods

SearchWays a customer can pay one invoice.
Input fields[3]
FieldType
Invoice IDRequired
text
Output fields[3]
FieldType
Payment Method IDtext
Currencytext
Destinationtext
Payment Linktext
Ratetext
Payment Method Paidtext
Total Paidtext
Duetext

5other output fields

List Invoices

SearchInvoices matching your filters.
Input fields[3]
FieldType
StoreRequired
choice
LimitRequired
number
Statuschoice
Order IDsarray
Order IDtext
Search Texttext
Start Datedate
End Datedate
Include Payment Methodsboolean
Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

10other output fields

List Lightning Addresses

SearchReceiving addresses configured for a store.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Usernametext
Currency Codetext
Mintext
Maxtext
Invoice Metadatatext

List Lightning Channels

SearchOpen channels on a node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Output fields[3]
FieldType
Remote Nodetext
Is Publicboolean
Is Activeboolean
Capacitytext
Local Balancetext
Channel Pointtext

List Lightning Invoices

SearchInvoices issued by a node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Pending Onlyboolean
Offset Indexnumber
Output fields[3]
FieldType
IDtext
Statustext
BOLT11text
Paid At (Unix Seconds)number
Expires At (Unix Seconds)number
Amounttext
Amount Receivedtext
Payment Hashtext

2other output fields

List Lightning Payments

SearchPayments sent from a Lightning node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Include Pendingboolean
Offset Indexnumber
Output fields[3]
FieldType
IDtext
Statustext
BOLT11text
Payment Hashtext
Preimagetext
Created At (Unix Seconds)number
Total Amounttext
Fee Amounttext

List Notifications

SearchInbox notifications with filters.
Input fields[3]
FieldType
LimitRequired
number
Seenchoice
Store IDsarray
Store IDtext
Output fields[3]
FieldType
IDtext
Identifiertext
Typetext
Bodytext
Store IDtext
Linktext
Created Timenumber
Seenboolean

List Offerings

SearchSubscription products in a store.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray

List Payment Requests

SearchRequests for money made by a store.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Amounttext
Titletext
Currencytext
Emailtext
Descriptiontext
Expiry Datenumber
Reference IDtext
Allow Custom Payment Amountsboolean

6other output fields

List Payout Processors

SearchAvailable automatic payout processors.
Output fields[3]
FieldType
Nametext
Friendly Nametext
Payout Methodsarray

List Pull Payment Payouts

SearchClaims made on a pull payment.
Input fields[3]
FieldType
Pull Payment IDRequired
text
Include Cancelledboolean
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

List Pull Payments

SearchClaimable budgets issued by a store.
Input fields[3]
FieldType
StoreRequired
choice
Include Archivedboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Currencytext
Amounttext
BOLT11 Expirationtext
Auto Approve Claimsboolean
Archivedboolean

1other output field

List Rate Sources

SearchExchanges available for rates.
Output fields[3]
FieldType
IDtext
Nametext

List Reports

SearchTypes of report a store supports.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Reporttext

List Roles

SearchRoles and the permissions they grant.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
IDtext
Roletext
Permissionsarray
Is Server Roleboolean

List Store Invitations

SearchInvites still awaiting an answer.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Store IDtext
Store Nametext
User IDtext
User Emailtext
Role IDtext
Invited By User IDtext
Createddate
Expires Atdate

2other output fields

List Store Payment Methods

SearchWays your store accepts payment.
Input fields[3]
FieldType
StoreRequired
choice
Only Enabledchoice
Include Configchoice
Output fields[3]
FieldType
Enabledboolean
Payment Method IDtext
Configobject
Use Bech32 Schemeboolean
Lud12 Enabledboolean
Lud21 Enabledboolean
Connection Stringtext
Derivation Schemetext
Labeltext
Account Key Pathtext

List Store Payout Processors

SearchAutomatic payout automation for a store.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Nametext
Friendly Nametext
Payout Methodsarray

List Store Payouts

SearchOutgoing money from a store.
Input fields[3]
FieldType
StoreRequired
choice
Include Cancelledboolean
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

List Store Users

SearchPeople with store access.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
IDtext
Emailtext
Role IDtext

List Stores

SearchYour BTCPay stores with their websites.
Output fields[3]
FieldType
Nametext
Websitetext
Support URLtext
Logo URLtext
CSS URLtext
Payment Sound URLtext
Brand Colortext
Apply Brand Color To Backendboolean

32other output fields

List Users

SearchEveryone registered on this server.
Output fields[3]
FieldType
IDtext
Emailtext
Nametext
Image URLtext
Invitation URLtext
Email Confirmedboolean
Requires Email Confirmationboolean
Approvedboolean

6other output fields

List Wallet Coins

SearchSpendable coin outputs held in a wallet.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Output fields[3]
FieldType
Commenttext
Amounttext
Linktext
Outpointtext
Timestampnumber
Key Pathtext
Addresstext
Confirmationsnumber

1other output field

List Wallet Transactions

SearchOn-chain wallet history with filters.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
LimitRequired
number
Statuschoice
Labeltext
Output fields[3]
FieldType
Transaction Hashtext
Commenttext
Amounttext
Block Hashtext
Block Heighttext
Confirmationstext
Timestampnumber
Statustext

1other output field

List Webhook Deliveries

SearchLatest delivery attempts with outcomes.
Input fields[3]
FieldType
Webhook IDRequired
text
Countnumber
Output fields[3]
FieldType
IDtext
Timestampnumber
Delivery Timenumber
Http Codenumber
Error Messagetext
Statustext

List Webhooks

SearchEndpoints receiving store events.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Enabledboolean
Automatic Redeliveryboolean
URLtext
Authorized Eventsobject
Everythingboolean
Specific Eventsarray
IDtext

Preview a Rate Configuration

SearchDry run of rate settings.
Input fields[3]
FieldType
StoreRequired
choice
Spread (%)text
Preferred Sourcechoice
Custom Scriptchoice
Effective Scripttext
Currency Pairsarray
Currency pairtext
Output fields[3]
FieldType
Currency Pairtext
Errorsarray
Ratetext

Activate an Invoice Payment Method

ActionEnables a chosen payment option for an invoice.
Input fields[3]
FieldType
Invoice IDRequired
text
Payment Method IDRequired
text
Output fields[3]
FieldType
Successboolean
Invoice IDtext
Payment Method IDtext

Add a Store User

ActionAdds a person to a store with a role.
Input fields[3]
FieldType
StoreRequired
choice
User ID or EmailRequired
text
RoleRequired
choice
Require Invitationchoice
Output fields[3]
FieldType
Store Invitationobject
Tokentext
Linktext

Approve a Payout

ActionMoves a payout to approved.
Input fields[3]
FieldType
Payout IDRequired
text
Revisionnumber
Rate Ruletext
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

Approve a User

ActionSets the approval state of a user.
Input fields[3]
FieldType
User ID or EmailRequired
text
ApprovedRequired
boolean
Output fields[3]
FieldType
Successboolean
User IDtext

Archive a Payment Request

ActionPuts a finished payment request aside.
Input fields[3]
FieldType
Payment Request IDRequired
text
Output fields[3]
FieldType
Successboolean
Payment Request IDtext

Archive a Pull Payment

ActionCloses a pull payment to new claims.
Input fields[3]
FieldType
Pull Payment IDRequired
text
Output fields[3]
FieldType
Successboolean
Pull Payment IDtext

Archive an Invoice

ActionInvoice moved out of default lists.
Input fields[3]
FieldType
Invoice IDRequired
text
Output fields[3]
FieldType
Successboolean
Invoice IDtext

Broadcast a Wallet Transaction

ActionPublishes a signed on-chain transaction.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
TransactionRequired
text
Output fields[3]
FieldType
Transaction Hashtext
Commenttext
Amounttext
Block Hashtext
Block Heighttext
Confirmationstext
Timestampnumber
Statustext

1other output field

Cancel a Payout

ActionStops a payout before it goes out.
Input fields[3]
FieldType
Payout IDRequired
text
Output fields[3]
FieldType
Successboolean
Payout IDtext

Cancel a Store Invitation

ActionWithdraws an invite to a store.
Input fields[3]
FieldType
StoreRequired
choice
User ID or EmailRequired
text
Output fields[3]
FieldType
Successboolean
Store IDtext
User IDtext

Connect to a Lightning Peer

ActionPeer link between two Lightning nodes.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Node URIRequired
text
Output fields[3]
FieldType
Successboolean
Node URItext

Create a Lightning Invoice

ActionReceives sats through a node invoice.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Amount (millisats)Required
text
Descriptiontext
Description Hash Onlychoice
Expiry (seconds)number
Private Route Hintschoice
Output fields[3]
FieldType
IDtext
Statustext
BOLT11text
Paid At (Unix Seconds)number
Expires At (Unix Seconds)number
Amounttext
Amount Receivedtext
Payment Hashtext

2other output fields

Create a Payment Request

ActionShareable request for a set sum.
Input fields[3]
FieldType
StoreRequired
choice
TitleRequired
text
AmountRequired
text
Currencytext
Emailtext
Descriptiontext
Expiry Datedate
Reference IDtext

1other input field

Output fields[3]
FieldType
Amounttext
Titletext
Currencytext
Emailtext
Descriptiontext
Expiry Datenumber
Reference IDtext
Allow Custom Payment Amountsboolean

6other output fields

Create a Pull Payment

ActionBudget that recipients can claim from.
Input fields[3]
FieldType
StoreRequired
choice
AmountRequired
text
CurrencyRequired
text
Payout MethodsRequired
array
Payout methodtext
Nametext
Descriptiontext
BOLT11 Expiration (days)text
Auto Approve Claimsboolean

2other input fields

Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Currencytext
Amounttext
BOLT11 Expirationtext
Auto Approve Claimsboolean
Archivedboolean

1other output field

Create a Pull Payment Payout

ActionClaims money from a pull payment.
Input fields[3]
FieldType
Pull Payment IDRequired
text
DestinationRequired
text
Payout Method IDRequired
text
Amounttext
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

Create a Store

ActionNew BTCPay store with branding options.
Input fields[3]
FieldType
NameRequired
text
Websitetext
Support URLtext
Logo URLtext
CSS URLtext
Payment Sound URLtext
Brand Colortext
HTML Titletext

20other input fields

Output fields[3]
FieldType
Nametext
Websitetext
Support URLtext
Logo URLtext
CSS URLtext
Payment Sound URLtext
Brand Colortext
Apply Brand Color To Backendboolean

32other output fields

Create a Store Payout

ActionMoney sent from your store funds.
Input fields[3]
FieldType
StoreRequired
choice
DestinationRequired
text
AmountRequired
text
Payout Method IDRequired
text
Pull Payment IDtext
Approvedchoice
Metadatatext
Output fields[3]
FieldType
IDtext
Revisionnumber
Pull Payment IDtext
Datetext
Destinationtext
Original Currencytext
Original Amounttext
Payout Currencytext

5other output fields

Create a User

ActionNew BTCPay user account.
Input fields[3]
FieldType
EmailRequired
text
Passwordsecret
Nametext
Is Administratorchoice
Send Invitation Emailchoice
Output fields[3]
FieldType
IDtext
Emailtext
Nametext
Image URLtext
Invitation URLtext
Email Confirmedboolean
Requires Email Confirmationboolean
Approvedboolean

6other output fields

Create a Wallet Transaction

ActionOn-chain spend from a store wallet.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
DestinationsRequired
array
Destinationobject
Fee Rate (sat/vB)number
Broadcastboolean
Sign With Seedboolean
Use Payjoinboolean
No Changeboolean

3other input fields

Output fields[3]
FieldType
Transaction Hashtext
Commenttext
Amounttext
Block Hashtext
Block Heighttext
Confirmationstext
Timestampnumber
Statustext

3other output fields

Create a Webhook

ActionStore webhook for BTCPay events.
Input fields[3]
FieldType
StoreRequired
choice
Endpoint URLRequired
text
Enabledboolean
Automatic Redeliveryboolean
Eventschoice
Secretsecret
Output fields[3]
FieldType
Enabledboolean
Automatic Redeliveryboolean
URLtext
Authorized Eventsobject
Everythingboolean
Specific Eventsarray
IDtext
Secrettext

Create an API Key

ActionFresh personal API key with limited scope.
Input fields[3]
FieldType
Labeltext
Permissionschoice
Output fields[3]
FieldType
IDtext
API Keytext
Labeltext
Created (Unix Seconds)number
Permissionsarray

Create an API Key for a User

ActionNew API key issued for another user.
Input fields[3]
FieldType
User ID or EmailRequired
text
Labeltext
Permissionschoice
Output fields[3]
FieldType
IDtext
API Keytext
Labeltext
Created (Unix Seconds)number
Permissionsarray

Create an App

ActionAdds an app to your store.
Input fields[3]
FieldType
StoreRequired
choice
App NameRequired
text
App TypeRequired
choice
Titletext
Descriptiontext
Notification URLtext
Output fields[3]
FieldType
IDtext
App Nametext
Store IDtext
Created (Unix Seconds)number
App Typetext
Archivedboolean
Titletext
Descriptiontext

19other output fields

Create an Invoice

ActionPayment invoice with amount and buyer details.
Input fields[3]
FieldType
StoreRequired
choice
Amounttext
Currencytext
Order IDtext
Item Descriptiontext
Buyer Emailtext
Metadatatext
Additional Search Termsarray
Search termtext

10other input fields

Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

9other output fields

Create an Offering

ActionSubscription product for a store.
Input fields[3]
FieldType
StoreRequired
choice
NameRequired
text
Success Redirect URLtext
Metadatatext
Featurestext
Output fields[3]
FieldType
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray

Create an Offering Plan

ActionNew priced plan inside an offering.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
NameRequired
text
PriceRequired
text
CurrencyRequired
text
Recurring Typechoice
Trial Daysnumber
Grace Period Daysnumber

5other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber

6other output fields

Delete a File

ActionRemoves one uploaded document.
Input fields[3]
FieldType
FileRequired
choice
Output fields[3]
FieldType
Successboolean
File IDtext

Delete a Notification

ActionClears a single inbox notification.
Input fields[3]
FieldType
Notification IDRequired
text
Output fields[3]
FieldType
Successboolean
Notification IDtext

Delete a Store

ActionRemoves a whole store.
Input fields[3]
FieldType
StoreRequired
choice
Output fields[3]
FieldType
Successboolean
Store IDtext

Delete a Store Payment Method

ActionUnlinks one way of paying your store.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Output fields[3]
FieldType
Successboolean
Store IDtext
Payment Method IDtext

Delete a Subscriber

ActionSubscriber gone from an offering.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
Output fields[3]
FieldType
Successboolean
Store IDtext
Offering IDtext
Customer Selectortext

Delete a User

ActionRemoves a user account from the server.
Input fields[3]
FieldType
User ID or EmailRequired
text
Output fields[3]
FieldType
Successboolean
User IDtext

Delete a Webhook

ActionStops a store webhook.
Input fields[3]
FieldType
Webhook IDRequired
text
Output fields[3]
FieldType
Successboolean
Webhook IDtext

Delete an App

ActionApp gone from BTCPay Server.
Input fields[3]
FieldType
AppRequired
choice
Output fields[3]
FieldType
Successboolean
App IDtext

Delete the Current User

ActionDeletes your own account.
Input fields[3]
FieldType
Confirm DeletionRequired
boolean
Output fields[3]
FieldType
Successboolean

Link a Boltcard

ActionPairs a Boltcard with a pull payment.
Input fields[3]
FieldType
Pull Payment IDRequired
text
Card UIDRequired
text
If Already Linkedchoice
Output fields[3]
FieldType
LNURLWtext
Versionnumber
K0text
K1text
K2text
K3text
K4text

Lock a User

ActionLocks or unlocks an account.
Input fields[3]
FieldType
User ID or EmailRequired
text
LockedRequired
boolean
Output fields[3]
FieldType
Successboolean
User IDtext

Make an API Call

universalYour own BTCPay Server REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Mark a Payout

ActionRecords payout progress with proof.
Input fields[3]
FieldType
Payout IDRequired
text
StateRequired
choice
Payment Prooftext
Output fields[3]
FieldType
Successboolean
Payout IDtext
Statetext

Mark a Payout as Paid

ActionRecords an external payout as paid.
Input fields[3]
FieldType
Payout IDRequired
text
Output fields[3]
FieldType
Successboolean
Payout IDtext

Mark an Invoice Status

ActionManually overrides an invoice state.
Input fields[3]
FieldType
Invoice IDRequired
text
StatusRequired
choice
Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

9other output fields

Open a Lightning Channel

ActionOpens a funded channel with a peer.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
Node URIRequired
text
Channel Amount (sats)Required
text
Fee Rate (sat/vB)number
Output fields[3]
FieldType
Successboolean
Node URItext

Pay a Lightning Invoice

ActionSends a payment from your node.
Input fields[3]
FieldType
NodeRequired
choice
Crypto CodeRequired
text
BOLT11 InvoiceRequired
text
Amount (millisats)text
Max Fee (%)text
Max Fee (flat)text
Send Timeout (seconds)number
Output fields[3]
FieldType
IDtext
Statustext
BOLT11text
Payment Hashtext
Preimagetext
Created At (Unix Seconds)number
Total Amounttext
Fee Amounttext

Pay a Payment Request

ActionStarts a payment against a request.
Input fields[3]
FieldType
Payment Request IDRequired
text
Amounttext
Allow Pending Invoice Reusechoice
Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

9other output fields

Redeliver a Webhook Delivery

ActionResends one failed event call.
Input fields[3]
FieldType
Webhook IDRequired
text
Delivery IDRequired
text
Output fields[3]
FieldType
Delivery IDtext

Refund an Invoice

ActionRefund an invoice through a pull payment.
Input fields[3]
FieldType
Invoice IDRequired
text
Refund VariantRequired
choice
Payout Methodsarray
Payout methodtext
Nametext
Descriptiontext
Subtract Percentagetext
Custom Amounttext
Custom Currencytext
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Currencytext
Amounttext
BOLT11 Expirationtext
Auto Approve Claimsboolean
Archivedboolean

1other output field

Release a Wallet Receive Address

ActionFrees a reserved wallet address.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Output fields[3]
FieldType
Successboolean
Store IDtext
Payment Method IDtext

Remove a Lightning Address

ActionDeletes a store payment alias.
Input fields[3]
FieldType
StoreRequired
choice
UsernameRequired
choice
Output fields[3]
FieldType
Successboolean
Store IDtext
Usernametext

Remove a Store User

ActionEnds store access for one person.
Input fields[3]
FieldType
StoreRequired
choice
UserRequired
choice
Output fields[3]
FieldType
Successboolean
Store IDtext
User IDtext

Resend a Store Invitation

ActionRe-sends a pending invite.
Input fields[3]
FieldType
StoreRequired
choice
User ID or EmailRequired
text
Output fields[3]
FieldType
Tokentext
Linktext

Revoke an API Key

ActionDisables a single API key by id.
Input fields[3]
FieldType
API Key IDRequired
text
Output fields[3]
FieldType
Successboolean
API Key IDtext

Revoke an API Key of a User

ActionDisables the API key of someone else.
Input fields[3]
FieldType
User ID or EmailRequired
text
API Key IDRequired
text
Output fields[3]
FieldType
Successboolean
User IDtext
API Key IDtext

Revoke the Current API Key

ActionDisables the key currently in use.
Input fields[3]
FieldType
Confirm RevocationRequired
boolean
Output fields[3]
FieldType
IDtext
API Keytext
Labeltext
Created (Unix Seconds)number
Permissionsarray

Run a Report

ActionReport rows for a store.
Input fields[3]
FieldType
StoreRequired
choice
SearchRequired
text
Output fields[3]
FieldType
Report Nametext
Time Zonetext
Fromnumber
Tonumber
Fieldsarray
Dataarray

Save a Lightning Address

ActionSets up a receiving address on a store.
Input fields[3]
FieldType
StoreRequired
choice
UsernameRequired
text
Currency Codetext
Minimumtext
Maximumtext
Invoice Metadatatext
Output fields[3]
FieldType
Usernametext
Currency Codetext
Mintext
Maxtext
Invoice Metadatatext

Send a Store Email

ActionMails a customer from a store.
Input fields[3]
FieldType
StoreRequired
choice
ToRequired
text
SubjectRequired
text
BodyRequired
text
Output fields[3]
FieldType
Successboolean
Emailtext

Suspend a Subscriber

ActionPauses a customer subscription.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
Reasontext
Output fields[3]
FieldType
Created (Unix Seconds)number
Customerobject
Store IDtext
IDtext
External IDtext
Identitiestext
Metadatatext
Offeringobject
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray
Planobject
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber
Descriptiontext
Member Countnumber
Period End (Unix Seconds)number
Trial End (Unix Seconds)number
Grace Period End (Unix Seconds)number
Is Activeboolean

9other output fields

Unarchive an Invoice

ActionRestores an archived invoice.
Input fields[3]
FieldType
Invoice IDRequired
text
Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

9other output fields

Unsuspend a Subscriber

ActionResumes a suspended subscription.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
Output fields[3]
FieldType
Created (Unix Seconds)number
Customerobject
Store IDtext
IDtext
External IDtext
Identitiestext
Metadatatext
Offeringobject
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray
Planobject
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber
Descriptiontext
Member Countnumber
Period End (Unix Seconds)number
Trial End (Unix Seconds)number
Grace Period End (Unix Seconds)number
Is Activeboolean

9other output fields

Update a Notification

ActionMarks a notification seen.
Input fields[3]
FieldType
Notification IDRequired
text
SeenRequired
boolean
Output fields[3]
FieldType
IDtext
Identifiertext
Typetext
Bodytext
Store IDtext
Linktext
Created Timenumber
Seenboolean

Update a Payment Request

ActionRetitles or reprices a payment request.
Input fields[3]
FieldType
Payment Request IDRequired
text
Titletext
Amounttext
Currencytext
Emailtext
Descriptiontext
Expiry Datedate
Reference IDtext

2other input fields

Output fields[3]
FieldType
Amounttext
Titletext
Currencytext
Emailtext
Descriptiontext
Expiry Datenumber
Reference IDtext
Allow Custom Payment Amountsboolean

6other output fields

Update a Rate Configuration

ActionSets how a store prices rates.
Input fields[3]
FieldType
StoreRequired
choice
Rate SourceRequired
choice
Spread (%)text
Preferred Sourcechoice
Custom Scriptchoice
Effective Scripttext
Output fields[3]
FieldType
Spreadtext
Preferred Sourcetext
Is Custom Scriptboolean
Effective Scripttext

Update a Store

ActionRebrands or renames a store.
Input fields[3]
FieldType
StoreRequired
choice
Nametext
Websitetext
Support URLtext
Logo URLtext
CSS URLtext
Payment Sound URLtext
Brand Colortext

22other input fields

Output fields[3]
FieldType
Nametext
Websitetext
Support URLtext
Logo URLtext
CSS URLtext
Payment Sound URLtext
Brand Colortext
Apply Brand Color To Backendboolean

32other output fields

Update a Store Payment Method

ActionSwitches or configures a payment option.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Enabledchoice
Configtext
Output fields[3]
FieldType
Enabledboolean
Payment Method IDtext
Configobject
Use Bech32 Schemeboolean
Lud12 Enabledboolean
Lud21 Enabledboolean
Connection Stringtext
Derivation Schemetext
Labeltext
Account Key Pathtext

Update a Store User

ActionChanges what a store user may do.
Input fields[3]
FieldType
StoreRequired
choice
UserRequired
choice
RoleRequired
choice
Output fields[3]
FieldType
Successboolean
Store IDtext
User IDtext

Update a Subscriber Credit

ActionAdjusts the credit balance of a subscriber.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
CurrencyRequired
text
Credittext
Chargetext
Descriptiontext
Allow Overdraftboolean
Output fields[3]
FieldType
Currencytext
Valuetext

Update a Wallet Transaction

ActionAnnotates a transaction with notes.
Input fields[3]
FieldType
StoreRequired
choice
Payment MethodRequired
choice
Transaction IDRequired
text
Commenttext
Labelsarray
Labeltext
Output fields[3]
FieldType
Transaction Hashtext
Commenttext
Amounttext
Block Hashtext
Block Heighttext
Confirmationstext
Timestampnumber
Statustext

1other output field

Update a Webhook

ActionMoves or toggles a webhook endpoint.
Input fields[3]
FieldType
Webhook IDRequired
text
Endpoint URLtext
Enabledchoice
Automatic Redeliverychoice
Receive All Eventschoice
Eventschoice
Secretsecret
Output fields[3]
FieldType
Enabledboolean
Automatic Redeliveryboolean
URLtext
Authorized Eventsobject
Everythingboolean
Specific Eventsarray
IDtext

Update an App

ActionRenames an app and edits its description.
Input fields[3]
FieldType
AppRequired
choice
App TypeRequired
choice
App Nametext
Titletext
Descriptiontext
Notification URLtext
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
App Nametext
Store IDtext
Created (Unix Seconds)number
App Typetext
Archivedboolean
Titletext
Descriptiontext

19other output fields

Update an Invoice

ActionRewrites custom data on an invoice.
Input fields[3]
FieldType
Invoice IDRequired
text
MetadataRequired
text
Merge With Stored Metadataboolean
Output fields[3]
FieldType
Metadataobject
Buyer Nametext
Buyer Emailtext
Buyer Countrytext
Buyer Ziptext
Buyer Statetext
Buyer Citytext
Buyer Address1text
Buyer Address2text
Buyer Phonetext
Item Desctext
Checkoutobject
Speed Policytext
Payment Methodsarray
Default Payment Methodtext
Lazy Payment Methodsboolean
Expiration Minutesnumber
Monitoring Minutesnumber
Payment Tolerancenumber
Redirect URLtext
Redirect Automaticallyboolean
Default Languagetext
Receiptobject
Enabledboolean
Show QRboolean
Show Paymentsboolean
IDtext
Store IDtext
Amounttext
Paid Amounttext
Currencytext

9other output fields

Update an Offering

ActionEdits a subscription product.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Nametext
Success Redirect URLtext
Metadatatext
Featurestext
Clear Fieldschoice
Output fields[3]
FieldType
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray

Update an Offering Plan

ActionReprices or retimes a plan.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
PlanRequired
choice
Nametext
Pricetext
Currencytext
Recurring Typechoice
Trial Daysnumber

7other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber

6other output fields

Update Notification Settings

ActionChooses which alerts you receive.
Input fields[3]
FieldType
Turn Offarray
Identifiertext
Turn Onarray
Identifiertext
Output fields[3]
FieldType
Notificationsarray

Update Store Email Settings

ActionSets up store email delivery.
Input fields[3]
FieldType
StoreRequired
choice
SMTP Servertext
Portnumber
Logintext
Passwordsecret
From Addresstext
Disable Certificate Checkchoice
Output fields[3]
FieldType
Fromtext
Servertext
Portnumber
Logintext
Disable Certificate Checkboolean
Password Setboolean

Update Subscriber Dates

ActionShifts subscription start and end dates.
Input fields[3]
FieldType
StoreRequired
choice
OfferingRequired
choice
Customer SelectorRequired
text
Start Datedate
Expiration Datedate
Output fields[3]
FieldType
Created (Unix Seconds)number
Customerobject
Store IDtext
IDtext
External IDtext
Identitiestext
Metadatatext
Offeringobject
App Nametext
Success Redirect URLtext
Metadatatext
Featuresarray
IDtext
Store IDtext
App IDtext
Plansarray
Planobject
IDtext
Nametext
Statustext
Pricetext
Currencytext
Recurring Typetext
Grace Period Daysnumber
Trial Daysnumber
Descriptiontext
Member Countnumber
Period End (Unix Seconds)number
Trial End (Unix Seconds)number
Grace Period End (Unix Seconds)number
Is Activeboolean

9other output fields

Update the Current User

ActionEdits the profile behind your key.
Input fields[3]
FieldType
Emailtext
Nametext
Image URLtext
Current Passwordsecret
New Passwordsecret
Allow Basic Auth for APIchoice
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Emailtext
Nametext
Image URLtext
Invitation URLtext
Email Confirmedboolean
Requires Email Confirmationboolean
Approvedboolean

6other output fields

Upload a File

ActionStores a file on the server.
Input fields[3]
FieldType
FileRequired
text
File NameRequired
text
Output fields[3]
FieldType
IDtext
User IDtext
URItext
URLtext
Original Nametext
Storage Nametext
Created (Unix Seconds)number

Look for BTCPay Server templates in the WEXTL template library.

Browse templates →
  1. WEXTL® BTCPay Server Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for BTCPay Server.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.