BTCPay Server integration guide
VerifiedHow 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].
Requirements
Get your BTCPay Server credentials
- 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]
Connect BTCPay Server in WEXTL
- 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.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your BTCPay Server account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
BTCPay Server triggers and actions on WEXTL
The list below is a reference of every BTCPay Server node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any BTCPay Server node module below to inspect its input parameters, outputs, and connection requirements.
Watch Events
TriggerInstant trigger for BTCPay events.
| Field | Type |
|---|---|
| Delivery ID | text |
| Webhook ID | text |
| Is Redelivery | boolean |
| Original Delivery ID | text |
| Event Type | text |
| Timestamp (Unix Seconds) | number |
| Store ID | text |
| Invoice ID | text |
10other output fields
Get a File
ActionLooks up the name and URL of an uploaded file.
| Field | Type |
|---|---|
FileRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| User ID | text |
| URI | text |
| URL | text |
| Original Name | text |
| Storage Name | text |
| Created (Unix Seconds) | number |
Get a Lightning Address
ActionLimits and metadata of a Lightning address.
| Field | Type |
|---|---|
StoreRequired | choice |
UsernameRequired | choice |
| Field | Type |
|---|---|
| Username | text |
| Currency Code | text |
| Min | text |
| Max | text |
| Invoice Metadata | text |
Get a Lightning Deposit Address
ActionOn-chain address to fund a node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Field | Type |
|---|---|
| Address | text |
Get a Lightning Invoice
ActionLightning invoice with its payment state.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
Lightning Invoice IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| BOLT11 | text |
| Paid At (Unix Seconds) | number |
| Expires At (Unix Seconds) | number |
| Amount | text |
| Amount Received | text |
| Payment Hash | text |
2other output fields
Get a Lightning Node Balance
ActionFunds held on a node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Field | Type |
|---|---|
| Onchain | object |
| Confirmed | text |
| Unconfirmed | text |
| Reserved | text |
| Offchain | object |
| Opening | text |
| Local | text |
| Remote | text |
| Closing | text |
Get a Lightning Node Info
ActionIdentity and sync state of a node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Field | Type |
|---|---|
| Node UR Is | array |
| Block Height | number |
| Alias | text |
| Color | text |
| Version | text |
| Peers Count | number |
| Active Channels Count | number |
| Inactive Channels Count | number |
1other output field
Get a Lightning Payment
ActionPayment proof from a Lightning node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
Payment HashRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| BOLT11 | text |
| Payment Hash | text |
| Preimage | text |
| Created At (Unix Seconds) | number |
| Total Amount | text |
| Fee Amount | text |
Get a Notification
ActionMessage text and link of one notification.
| Field | Type |
|---|---|
Notification IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Identifier | text |
| Type | text |
| Body | text |
| Store ID | text |
| Link | text |
| Created Time | number |
| Seen | boolean |
Get a Payment Request
ActionTerms and deadline of a payment request.
| Field | Type |
|---|---|
Payment Request IDRequired | text |
| Field | Type |
|---|---|
| Amount | text |
| Title | text |
| Currency | text |
| text | |
| Description | text |
| Expiry Date | number |
| Reference ID | text |
| Allow Custom Payment Amounts | boolean |
6other output fields
Get a Payout
ActionDestination and currency of a payout.
| Field | Type |
|---|---|
Payout IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
Get a Pull Payment
ActionBudget and expiry rules of a pull payment.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Currency | text |
| Amount | text |
| BOLT11 Expiration | text |
| Auto Approve Claims | boolean |
| Archived | boolean |
1other output field
Get a Pull Payment LNURL
ActionLightning link for claiming a pull payment.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
| Field | Type |
|---|---|
| LNURL Bech32 | text |
| LNURL URI | text |
Get a Pull Payment Payout
ActionOne claim made on a pull payment.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
Payout IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
Get a Rate Configuration
ActionExchange rate settings for a store.
| Field | Type |
|---|---|
StoreRequired | choice |
Rate SourceRequired | choice |
| Field | Type |
|---|---|
| Spread | text |
| Preferred Source | text |
| Is Custom Script | boolean |
| Effective Script | text |
Get a Store
ActionBranding and identity of one store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Website | text |
| Support URL | text |
| Logo URL | text |
| CSS URL | text |
| Payment Sound URL | text |
| Brand Color | text |
| Apply Brand Color To Backend | boolean |
32other output fields
Get a Store Payment Method
ActionStatus and settings of a payment method.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Include Config | choice |
| Field | Type |
|---|---|
| Enabled | boolean |
| Payment Method ID | text |
| Config | object |
| Use Bech32 Scheme | boolean |
| Lud12 Enabled | boolean |
| Lud21 Enabled | boolean |
| Connection String | text |
| Derivation Scheme | text |
| Label | text |
| Account Key Path | text |
Get a Subscriber
ActionOne subscriber with plan and dates.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
| Field | Type |
|---|---|
| Created (Unix Seconds) | number |
| Customer | object |
| Store ID | text |
| ID | text |
| External ID | text |
| Identities | text |
| Metadata | text |
| Offering | object |
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
| Plan | object |
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
| Description | text |
| Member Count | number |
| Period End (Unix Seconds) | number |
| Trial End (Unix Seconds) | number |
| Grace Period End (Unix Seconds) | number |
| Is Active | boolean |
9other output fields
Get a Subscriber Credit
ActionCredit balance held by a subscriber.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
CurrencyRequired | text |
| Field | Type |
|---|---|
| Currency | text |
| Value | text |
Get a User
ActionProfile and confirmation state of a user.
| Field | Type |
|---|---|
User ID or EmailRequired | text |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Name | text |
| Image URL | text |
| Invitation URL | text |
| Email Confirmed | boolean |
| Requires Email Confirmation | boolean |
| Approved | boolean |
6other output fields
Get a Wallet Fee Rate
ActionCurrent on-chain fee estimate.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Block Target | number |
| Field | Type |
|---|---|
| Fee Rate | number |
Get a Wallet Overview
ActionConfirmed and pending funds in a wallet.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Field | Type |
|---|---|
| Balance | text |
| Unconfirmed Balance | text |
| Confirmed Balance | text |
Get a Wallet Receive Address
ActionOn-chain address for receiving funds.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Force New Address | choice |
| Field | Type |
|---|---|
| Address | text |
| Key Path | text |
| Payment Link | text |
Get a Wallet Transaction
ActionChain position of a wallet transaction.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Transaction Hash | text |
| Comment | text |
| Amount | text |
| Block Hash | text |
| Block Height | text |
| Confirmations | text |
| Timestamp | number |
| Status | text |
1other output field
Get a Webhook
ActionAddress and event filter of a webhook.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| Field | Type |
|---|---|
| Enabled | boolean |
| Automatic Redelivery | boolean |
| URL | text |
| Authorized Events | object |
| Everything | boolean |
| Specific Events | array |
| ID | text |
Get a Webhook Delivery
ActionOutcome and error of one delivery.
| Field | Type |
|---|---|
Webhook IDRequired | text |
Delivery IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Timestamp | number |
| Delivery Time | number |
| Http Code | number |
| Error Message | text |
| Status | text |
Get a Webhook Delivery Request
ActionPayload sent during one delivery.
| Field | Type |
|---|---|
Webhook IDRequired | text |
Delivery IDRequired | text |
| Field | Type |
|---|---|
| Request | text |
Get an App
ActionName, kind and archive state of an app.
| Field | Type |
|---|---|
AppRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| App Name | text |
| Store ID | text |
| Created (Unix Seconds) | number |
| App Type | text |
| Archived | boolean |
Get an Invoice
ActionFull invoice record with checkout data.
| Field | Type |
|---|---|
Invoice IDRequired | text |
| Include Payment Methods | boolean |
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
9other output fields
Get an Offering
ActionFeatures and redirect of a subscription product.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
| Field | Type |
|---|---|
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
Get an Offering Plan
ActionPricing and renewal cycle of a plan.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
PlanRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
6other output fields
Get App Details
ActionType-dependent app configuration.
| Field | Type |
|---|---|
AppRequired | choice |
App TypeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| App Name | text |
| Store ID | text |
| Created (Unix Seconds) | number |
| App Type | text |
| Archived | boolean |
| Title | text |
| Description | text |
19other output fields
Get App Sales
ActionSales numbers over recent days.
| Field | Type |
|---|---|
AppRequired | choice |
| Number of Days | number |
| Field | Type |
|---|---|
| Sales Count | number |
| Series | array |
Get App Top Items
SearchBest sellers ranked by sales.
| Field | Type |
|---|---|
AppRequired | choice |
| Count | number |
| Offset | number |
| Field | Type |
|---|---|
| Item Code | text |
| Title | text |
| Sales Count | number |
| Total | text |
| Total Formatted | text |
Get Invoice Refund Details
ActionRefund amounts at past and current rates.
| Field | Type |
|---|---|
Invoice IDRequired | text |
Payment Method IDRequired | text |
| Field | Type |
|---|---|
| Payment Amount Then | text |
| Payment Amount Now | text |
| Invoice Amount | text |
| Payment Currency | text |
| Payment Currency Divisibility | number |
| Invoice Currency Divisibility | number |
| Invoice Currency | text |
| Overpaid Payment Amount | text |
Get Lightning Balance History
ActionBalance over time for a node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Field | Type |
|---|---|
| Type | text |
| Balance | text |
| Series | array |
| Labels | array |
Get Notification Settings
ActionWhich alert types are currently enabled.
| Field | Type |
|---|---|
| Notifications | array |
Get Store Email Settings
ActionSMTP host and login used for store mail.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| From | text |
| Server | text |
| Port | number |
| Login | text |
| Disable Certificate Check | boolean |
| Password Set | boolean |
Get Store Rates
SearchLive conversion rates for chosen pairs.
| Field | Type |
|---|---|
StoreRequired | choice |
| Currency Pairs | array |
| Currency pair | text |
| Field | Type |
|---|---|
| Currency Pair | text |
| Errors | array |
| Rate | text |
Get the Current API Key
ActionInfo about the key in use.
| Field | Type |
|---|---|
| ID | text |
| API Key | text |
| Label | text |
| Created (Unix Seconds) | number |
| Permissions | array |
Get the Current User
ActionProfile of the account behind your key.
| Field | Type |
|---|---|
| ID | text |
| text | |
| Name | text |
| Image URL | text |
| Invitation URL | text |
| Email Confirmed | boolean |
| Requires Email Confirmation | boolean |
| Approved | boolean |
6other output fields
Get the Server Health
ActionWhether the server is fully synced.
| Field | Type |
|---|---|
| Synchronized | boolean |
Get the Server Info
ActionVersion and sync state of the server.
| Field | Type |
|---|---|
| Version | text |
| Onion | text |
| Supported Payment Methods | array |
| Fully Synched | boolean |
| Sync Status | array |
Get Wallet History
ActionWallet balance over time.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Field | Type |
|---|---|
| Type | text |
| Balance | text |
| Series | array |
| Labels | array |
List Apps
SearchApps across all your stores.
| Field | Type |
|---|---|
| Store | choice |
| Field | Type |
|---|---|
| ID | text |
| App Name | text |
| Store ID | text |
| Created (Unix Seconds) | number |
| App Type | text |
| Archived | boolean |
List Files
SearchUploaded files on the server.
| Field | Type |
|---|---|
| ID | text |
| User ID | text |
| URI | text |
| URL | text |
| Original Name | text |
| Storage Name | text |
| Created (Unix Seconds) | number |
List Invoice Payment Methods
SearchWays a customer can pay one invoice.
| Field | Type |
|---|---|
Invoice IDRequired | text |
| Field | Type |
|---|---|
| Payment Method ID | text |
| Currency | text |
| Destination | text |
| Payment Link | text |
| Rate | text |
| Payment Method Paid | text |
| Total Paid | text |
| Due | text |
5other output fields
List Invoices
SearchInvoices matching your filters.
| Field | Type |
|---|---|
StoreRequired | choice |
LimitRequired | number |
| Status | choice |
| Order IDs | array |
| Order ID | text |
| Search Text | text |
| Start Date | date |
| End Date | date |
| Include Payment Methods | boolean |
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
10other output fields
List Lightning Addresses
SearchReceiving addresses configured for a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Username | text |
| Currency Code | text |
| Min | text |
| Max | text |
| Invoice Metadata | text |
List Lightning Channels
SearchOpen channels on a node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Field | Type |
|---|---|
| Remote Node | text |
| Is Public | boolean |
| Is Active | boolean |
| Capacity | text |
| Local Balance | text |
| Channel Point | text |
List Lightning Invoices
SearchInvoices issued by a node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Pending Only | boolean |
| Offset Index | number |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| BOLT11 | text |
| Paid At (Unix Seconds) | number |
| Expires At (Unix Seconds) | number |
| Amount | text |
| Amount Received | text |
| Payment Hash | text |
2other output fields
List Lightning Payments
SearchPayments sent from a Lightning node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
| Include Pending | boolean |
| Offset Index | number |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| BOLT11 | text |
| Payment Hash | text |
| Preimage | text |
| Created At (Unix Seconds) | number |
| Total Amount | text |
| Fee Amount | text |
List Notifications
SearchInbox notifications with filters.
| Field | Type |
|---|---|
LimitRequired | number |
| Seen | choice |
| Store IDs | array |
| Store ID | text |
| Field | Type |
|---|---|
| ID | text |
| Identifier | text |
| Type | text |
| Body | text |
| Store ID | text |
| Link | text |
| Created Time | number |
| Seen | boolean |
List Offerings
SearchSubscription products in a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
List Payment Requests
SearchRequests for money made by a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Amount | text |
| Title | text |
| Currency | text |
| text | |
| Description | text |
| Expiry Date | number |
| Reference ID | text |
| Allow Custom Payment Amounts | boolean |
6other output fields
List Payout Processors
SearchAvailable automatic payout processors.
| Field | Type |
|---|---|
| Name | text |
| Friendly Name | text |
| Payout Methods | array |
List Pull Payment Payouts
SearchClaims made on a pull payment.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
| Include Cancelled | boolean |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
List Pull Payments
SearchClaimable budgets issued by a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Include Archived | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Currency | text |
| Amount | text |
| BOLT11 Expiration | text |
| Auto Approve Claims | boolean |
| Archived | boolean |
1other output field
List Rate Sources
SearchExchanges available for rates.
| Field | Type |
|---|---|
| ID | text |
| Name | text |
List Reports
SearchTypes of report a store supports.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Report | text |
List Roles
SearchRoles and the permissions they grant.
| Field | Type |
|---|---|
ScopeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| Permissions | array |
| Is Server Role | boolean |
List Store Invitations
SearchInvites still awaiting an answer.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Store ID | text |
| Store Name | text |
| User ID | text |
| User Email | text |
| Role ID | text |
| Invited By User ID | text |
| Created | date |
| Expires At | date |
2other output fields
List Store Payment Methods
SearchWays your store accepts payment.
| Field | Type |
|---|---|
StoreRequired | choice |
| Only Enabled | choice |
| Include Config | choice |
| Field | Type |
|---|---|
| Enabled | boolean |
| Payment Method ID | text |
| Config | object |
| Use Bech32 Scheme | boolean |
| Lud12 Enabled | boolean |
| Lud21 Enabled | boolean |
| Connection String | text |
| Derivation Scheme | text |
| Label | text |
| Account Key Path | text |
List Store Payout Processors
SearchAutomatic payout automation for a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Friendly Name | text |
| Payout Methods | array |
List Store Payouts
SearchOutgoing money from a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Include Cancelled | boolean |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
List Store Users
SearchPeople with store access.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Role ID | text |
List Stores
SearchYour BTCPay stores with their websites.
| Field | Type |
|---|---|
| Name | text |
| Website | text |
| Support URL | text |
| Logo URL | text |
| CSS URL | text |
| Payment Sound URL | text |
| Brand Color | text |
| Apply Brand Color To Backend | boolean |
32other output fields
List Users
SearchEveryone registered on this server.
| Field | Type |
|---|---|
| ID | text |
| text | |
| Name | text |
| Image URL | text |
| Invitation URL | text |
| Email Confirmed | boolean |
| Requires Email Confirmation | boolean |
| Approved | boolean |
6other output fields
List Wallet Coins
SearchSpendable coin outputs held in a wallet.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Field | Type |
|---|---|
| Comment | text |
| Amount | text |
| Link | text |
| Outpoint | text |
| Timestamp | number |
| Key Path | text |
| Address | text |
| Confirmations | number |
1other output field
List Wallet Transactions
SearchOn-chain wallet history with filters.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
LimitRequired | number |
| Status | choice |
| Label | text |
| Field | Type |
|---|---|
| Transaction Hash | text |
| Comment | text |
| Amount | text |
| Block Hash | text |
| Block Height | text |
| Confirmations | text |
| Timestamp | number |
| Status | text |
1other output field
List Webhook Deliveries
SearchLatest delivery attempts with outcomes.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| Count | number |
| Field | Type |
|---|---|
| ID | text |
| Timestamp | number |
| Delivery Time | number |
| Http Code | number |
| Error Message | text |
| Status | text |
List Webhooks
SearchEndpoints receiving store events.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Enabled | boolean |
| Automatic Redelivery | boolean |
| URL | text |
| Authorized Events | object |
| Everything | boolean |
| Specific Events | array |
| ID | text |
Preview a Rate Configuration
SearchDry run of rate settings.
| Field | Type |
|---|---|
StoreRequired | choice |
| Spread (%) | text |
| Preferred Source | choice |
| Custom Script | choice |
| Effective Script | text |
| Currency Pairs | array |
| Currency pair | text |
| Field | Type |
|---|---|
| Currency Pair | text |
| Errors | array |
| Rate | text |
Activate an Invoice Payment Method
ActionEnables a chosen payment option for an invoice.
| Field | Type |
|---|---|
Invoice IDRequired | text |
Payment Method IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Invoice ID | text |
| Payment Method ID | text |
Add a Store User
ActionAdds a person to a store with a role.
| Field | Type |
|---|---|
StoreRequired | choice |
User ID or EmailRequired | text |
RoleRequired | choice |
| Require Invitation | choice |
| Field | Type |
|---|---|
| Store Invitation | object |
| Token | text |
| Link | text |
Approve a Payout
ActionMoves a payout to approved.
| Field | Type |
|---|---|
Payout IDRequired | text |
| Revision | number |
| Rate Rule | text |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
Approve a User
ActionSets the approval state of a user.
| Field | Type |
|---|---|
User ID or EmailRequired | text |
ApprovedRequired | boolean |
| Field | Type |
|---|---|
| Success | boolean |
| User ID | text |
Archive a Payment Request
ActionPuts a finished payment request aside.
| Field | Type |
|---|---|
Payment Request IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Payment Request ID | text |
Archive a Pull Payment
ActionCloses a pull payment to new claims.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Pull Payment ID | text |
Archive an Invoice
ActionInvoice moved out of default lists.
| Field | Type |
|---|---|
Invoice IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Invoice ID | text |
Broadcast a Wallet Transaction
ActionPublishes a signed on-chain transaction.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
TransactionRequired | text |
| Field | Type |
|---|---|
| Transaction Hash | text |
| Comment | text |
| Amount | text |
| Block Hash | text |
| Block Height | text |
| Confirmations | text |
| Timestamp | number |
| Status | text |
1other output field
Cancel a Payout
ActionStops a payout before it goes out.
| Field | Type |
|---|---|
Payout IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Payout ID | text |
Cancel a Store Invitation
ActionWithdraws an invite to a store.
| Field | Type |
|---|---|
StoreRequired | choice |
User ID or EmailRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| User ID | text |
Connect to a Lightning Peer
ActionPeer link between two Lightning nodes.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
Node URIRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Node URI | text |
Create a Lightning Invoice
ActionReceives sats through a node invoice.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
Amount (millisats)Required | text |
| Description | text |
| Description Hash Only | choice |
| Expiry (seconds) | number |
| Private Route Hints | choice |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| BOLT11 | text |
| Paid At (Unix Seconds) | number |
| Expires At (Unix Seconds) | number |
| Amount | text |
| Amount Received | text |
| Payment Hash | text |
2other output fields
Create a Payment Request
ActionShareable request for a set sum.
| Field | Type |
|---|---|
StoreRequired | choice |
TitleRequired | text |
AmountRequired | text |
| Currency | text |
| text | |
| Description | text |
| Expiry Date | date |
| Reference ID | text |
1other input field
| Field | Type |
|---|---|
| Amount | text |
| Title | text |
| Currency | text |
| text | |
| Description | text |
| Expiry Date | number |
| Reference ID | text |
| Allow Custom Payment Amounts | boolean |
6other output fields
Create a Pull Payment
ActionBudget that recipients can claim from.
| Field | Type |
|---|---|
StoreRequired | choice |
AmountRequired | text |
CurrencyRequired | text |
Payout MethodsRequired | array |
| Payout method | text |
| Name | text |
| Description | text |
| BOLT11 Expiration (days) | text |
| Auto Approve Claims | boolean |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Currency | text |
| Amount | text |
| BOLT11 Expiration | text |
| Auto Approve Claims | boolean |
| Archived | boolean |
1other output field
Create a Pull Payment Payout
ActionClaims money from a pull payment.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
DestinationRequired | text |
Payout Method IDRequired | text |
| Amount | text |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
Create a Store
ActionNew BTCPay store with branding options.
| Field | Type |
|---|---|
NameRequired | text |
| Website | text |
| Support URL | text |
| Logo URL | text |
| CSS URL | text |
| Payment Sound URL | text |
| Brand Color | text |
| HTML Title | text |
20other input fields
| Field | Type |
|---|---|
| Name | text |
| Website | text |
| Support URL | text |
| Logo URL | text |
| CSS URL | text |
| Payment Sound URL | text |
| Brand Color | text |
| Apply Brand Color To Backend | boolean |
32other output fields
Create a Store Payout
ActionMoney sent from your store funds.
| Field | Type |
|---|---|
StoreRequired | choice |
DestinationRequired | text |
AmountRequired | text |
Payout Method IDRequired | text |
| Pull Payment ID | text |
| Approved | choice |
| Metadata | text |
| Field | Type |
|---|---|
| ID | text |
| Revision | number |
| Pull Payment ID | text |
| Date | text |
| Destination | text |
| Original Currency | text |
| Original Amount | text |
| Payout Currency | text |
5other output fields
Create a User
ActionNew BTCPay user account.
| Field | Type |
|---|---|
EmailRequired | text |
| Password | secret |
| Name | text |
| Is Administrator | choice |
| Send Invitation Email | choice |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Name | text |
| Image URL | text |
| Invitation URL | text |
| Email Confirmed | boolean |
| Requires Email Confirmation | boolean |
| Approved | boolean |
6other output fields
Create a Wallet Transaction
ActionOn-chain spend from a store wallet.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
DestinationsRequired | array |
| Destination | object |
| Fee Rate (sat/vB) | number |
| Broadcast | boolean |
| Sign With Seed | boolean |
| Use Payjoin | boolean |
| No Change | boolean |
3other input fields
| Field | Type |
|---|---|
| Transaction Hash | text |
| Comment | text |
| Amount | text |
| Block Hash | text |
| Block Height | text |
| Confirmations | text |
| Timestamp | number |
| Status | text |
3other output fields
Create a Webhook
ActionStore webhook for BTCPay events.
| Field | Type |
|---|---|
StoreRequired | choice |
Endpoint URLRequired | text |
| Enabled | boolean |
| Automatic Redelivery | boolean |
| Events | choice |
| Secret | secret |
| Field | Type |
|---|---|
| Enabled | boolean |
| Automatic Redelivery | boolean |
| URL | text |
| Authorized Events | object |
| Everything | boolean |
| Specific Events | array |
| ID | text |
| Secret | text |
Create an API Key
ActionFresh personal API key with limited scope.
| Field | Type |
|---|---|
| Label | text |
| Permissions | choice |
| Field | Type |
|---|---|
| ID | text |
| API Key | text |
| Label | text |
| Created (Unix Seconds) | number |
| Permissions | array |
Create an API Key for a User
ActionNew API key issued for another user.
| Field | Type |
|---|---|
User ID or EmailRequired | text |
| Label | text |
| Permissions | choice |
| Field | Type |
|---|---|
| ID | text |
| API Key | text |
| Label | text |
| Created (Unix Seconds) | number |
| Permissions | array |
Create an App
ActionAdds an app to your store.
| Field | Type |
|---|---|
StoreRequired | choice |
App NameRequired | text |
App TypeRequired | choice |
| Title | text |
| Description | text |
| Notification URL | text |
| Field | Type |
|---|---|
| ID | text |
| App Name | text |
| Store ID | text |
| Created (Unix Seconds) | number |
| App Type | text |
| Archived | boolean |
| Title | text |
| Description | text |
19other output fields
Create an Invoice
ActionPayment invoice with amount and buyer details.
| Field | Type |
|---|---|
StoreRequired | choice |
| Amount | text |
| Currency | text |
| Order ID | text |
| Item Description | text |
| Buyer Email | text |
| Metadata | text |
| Additional Search Terms | array |
| Search term | text |
10other input fields
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
9other output fields
Create an Offering
ActionSubscription product for a store.
| Field | Type |
|---|---|
StoreRequired | choice |
NameRequired | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | text |
| Field | Type |
|---|---|
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
Create an Offering Plan
ActionNew priced plan inside an offering.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
NameRequired | text |
PriceRequired | text |
CurrencyRequired | text |
| Recurring Type | choice |
| Trial Days | number |
| Grace Period Days | number |
5other input fields
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
6other output fields
Delete a File
ActionRemoves one uploaded document.
| Field | Type |
|---|---|
FileRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| File ID | text |
Delete a Notification
ActionClears a single inbox notification.
| Field | Type |
|---|---|
Notification IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Notification ID | text |
Delete a Store
ActionRemoves a whole store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
Delete a Store Payment Method
ActionUnlinks one way of paying your store.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| Payment Method ID | text |
Delete a Subscriber
ActionSubscriber gone from an offering.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| Offering ID | text |
| Customer Selector | text |
Delete a User
ActionRemoves a user account from the server.
| Field | Type |
|---|---|
User ID or EmailRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| User ID | text |
Delete a Webhook
ActionStops a store webhook.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Webhook ID | text |
Delete an App
ActionApp gone from BTCPay Server.
| Field | Type |
|---|---|
AppRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| App ID | text |
Delete the Current User
ActionDeletes your own account.
| Field | Type |
|---|---|
Confirm DeletionRequired | boolean |
| Field | Type |
|---|---|
| Success | boolean |
Link a Boltcard
ActionPairs a Boltcard with a pull payment.
| Field | Type |
|---|---|
Pull Payment IDRequired | text |
Card UIDRequired | text |
| If Already Linked | choice |
| Field | Type |
|---|---|
| LNURLW | text |
| Version | number |
| K0 | text |
| K1 | text |
| K2 | text |
| K3 | text |
| K4 | text |
Lock a User
ActionLocks or unlocks an account.
| Field | Type |
|---|---|
User ID or EmailRequired | text |
LockedRequired | boolean |
| Field | Type |
|---|---|
| Success | boolean |
| User ID | text |
Make an API Call
universalYour own BTCPay Server REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status code | number |
Mark a Payout
ActionRecords payout progress with proof.
| Field | Type |
|---|---|
Payout IDRequired | text |
StateRequired | choice |
| Payment Proof | text |
| Field | Type |
|---|---|
| Success | boolean |
| Payout ID | text |
| State | text |
Mark a Payout as Paid
ActionRecords an external payout as paid.
| Field | Type |
|---|---|
Payout IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| Payout ID | text |
Mark an Invoice Status
ActionManually overrides an invoice state.
| Field | Type |
|---|---|
Invoice IDRequired | text |
StatusRequired | choice |
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
9other output fields
Open a Lightning Channel
ActionOpens a funded channel with a peer.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
Node URIRequired | text |
Channel Amount (sats)Required | text |
| Fee Rate (sat/vB) | number |
| Field | Type |
|---|---|
| Success | boolean |
| Node URI | text |
Pay a Lightning Invoice
ActionSends a payment from your node.
| Field | Type |
|---|---|
NodeRequired | choice |
Crypto CodeRequired | text |
BOLT11 InvoiceRequired | text |
| Amount (millisats) | text |
| Max Fee (%) | text |
| Max Fee (flat) | text |
| Send Timeout (seconds) | number |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| BOLT11 | text |
| Payment Hash | text |
| Preimage | text |
| Created At (Unix Seconds) | number |
| Total Amount | text |
| Fee Amount | text |
Pay a Payment Request
ActionStarts a payment against a request.
| Field | Type |
|---|---|
Payment Request IDRequired | text |
| Amount | text |
| Allow Pending Invoice Reuse | choice |
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
9other output fields
Redeliver a Webhook Delivery
ActionResends one failed event call.
| Field | Type |
|---|---|
Webhook IDRequired | text |
Delivery IDRequired | text |
| Field | Type |
|---|---|
| Delivery ID | text |
Refund an Invoice
ActionRefund an invoice through a pull payment.
| Field | Type |
|---|---|
Invoice IDRequired | text |
Refund VariantRequired | choice |
| Payout Methods | array |
| Payout method | text |
| Name | text |
| Description | text |
| Subtract Percentage | text |
| Custom Amount | text |
| Custom Currency | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Currency | text |
| Amount | text |
| BOLT11 Expiration | text |
| Auto Approve Claims | boolean |
| Archived | boolean |
1other output field
Release a Wallet Receive Address
ActionFrees a reserved wallet address.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| Payment Method ID | text |
Remove a Lightning Address
ActionDeletes a store payment alias.
| Field | Type |
|---|---|
StoreRequired | choice |
UsernameRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| Username | text |
Remove a Store User
ActionEnds store access for one person.
| Field | Type |
|---|---|
StoreRequired | choice |
UserRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| User ID | text |
Resend a Store Invitation
ActionRe-sends a pending invite.
| Field | Type |
|---|---|
StoreRequired | choice |
User ID or EmailRequired | text |
| Field | Type |
|---|---|
| Token | text |
| Link | text |
Revoke an API Key
ActionDisables a single API key by id.
| Field | Type |
|---|---|
API Key IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| API Key ID | text |
Revoke an API Key of a User
ActionDisables the API key of someone else.
| Field | Type |
|---|---|
User ID or EmailRequired | text |
API Key IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| User ID | text |
| API Key ID | text |
Revoke the Current API Key
ActionDisables the key currently in use.
| Field | Type |
|---|---|
Confirm RevocationRequired | boolean |
| Field | Type |
|---|---|
| ID | text |
| API Key | text |
| Label | text |
| Created (Unix Seconds) | number |
| Permissions | array |
Run a Report
ActionReport rows for a store.
| Field | Type |
|---|---|
StoreRequired | choice |
SearchRequired | text |
| Field | Type |
|---|---|
| Report Name | text |
| Time Zone | text |
| From | number |
| To | number |
| Fields | array |
| Data | array |
Save a Lightning Address
ActionSets up a receiving address on a store.
| Field | Type |
|---|---|
StoreRequired | choice |
UsernameRequired | text |
| Currency Code | text |
| Minimum | text |
| Maximum | text |
| Invoice Metadata | text |
| Field | Type |
|---|---|
| Username | text |
| Currency Code | text |
| Min | text |
| Max | text |
| Invoice Metadata | text |
Send a Store Email
ActionMails a customer from a store.
| Field | Type |
|---|---|
StoreRequired | choice |
ToRequired | text |
SubjectRequired | text |
BodyRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| text |
Suspend a Subscriber
ActionPauses a customer subscription.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
| Reason | text |
| Field | Type |
|---|---|
| Created (Unix Seconds) | number |
| Customer | object |
| Store ID | text |
| ID | text |
| External ID | text |
| Identities | text |
| Metadata | text |
| Offering | object |
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
| Plan | object |
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
| Description | text |
| Member Count | number |
| Period End (Unix Seconds) | number |
| Trial End (Unix Seconds) | number |
| Grace Period End (Unix Seconds) | number |
| Is Active | boolean |
9other output fields
Unarchive an Invoice
ActionRestores an archived invoice.
| Field | Type |
|---|---|
Invoice IDRequired | text |
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
9other output fields
Unsuspend a Subscriber
ActionResumes a suspended subscription.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
| Field | Type |
|---|---|
| Created (Unix Seconds) | number |
| Customer | object |
| Store ID | text |
| ID | text |
| External ID | text |
| Identities | text |
| Metadata | text |
| Offering | object |
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
| Plan | object |
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
| Description | text |
| Member Count | number |
| Period End (Unix Seconds) | number |
| Trial End (Unix Seconds) | number |
| Grace Period End (Unix Seconds) | number |
| Is Active | boolean |
9other output fields
Update a Notification
ActionMarks a notification seen.
| Field | Type |
|---|---|
Notification IDRequired | text |
SeenRequired | boolean |
| Field | Type |
|---|---|
| ID | text |
| Identifier | text |
| Type | text |
| Body | text |
| Store ID | text |
| Link | text |
| Created Time | number |
| Seen | boolean |
Update a Payment Request
ActionRetitles or reprices a payment request.
| Field | Type |
|---|---|
Payment Request IDRequired | text |
| Title | text |
| Amount | text |
| Currency | text |
| text | |
| Description | text |
| Expiry Date | date |
| Reference ID | text |
2other input fields
| Field | Type |
|---|---|
| Amount | text |
| Title | text |
| Currency | text |
| text | |
| Description | text |
| Expiry Date | number |
| Reference ID | text |
| Allow Custom Payment Amounts | boolean |
6other output fields
Update a Rate Configuration
ActionSets how a store prices rates.
| Field | Type |
|---|---|
StoreRequired | choice |
Rate SourceRequired | choice |
| Spread (%) | text |
| Preferred Source | choice |
| Custom Script | choice |
| Effective Script | text |
| Field | Type |
|---|---|
| Spread | text |
| Preferred Source | text |
| Is Custom Script | boolean |
| Effective Script | text |
Update a Store
ActionRebrands or renames a store.
| Field | Type |
|---|---|
StoreRequired | choice |
| Name | text |
| Website | text |
| Support URL | text |
| Logo URL | text |
| CSS URL | text |
| Payment Sound URL | text |
| Brand Color | text |
22other input fields
| Field | Type |
|---|---|
| Name | text |
| Website | text |
| Support URL | text |
| Logo URL | text |
| CSS URL | text |
| Payment Sound URL | text |
| Brand Color | text |
| Apply Brand Color To Backend | boolean |
32other output fields
Update a Store Payment Method
ActionSwitches or configures a payment option.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
| Enabled | choice |
| Config | text |
| Field | Type |
|---|---|
| Enabled | boolean |
| Payment Method ID | text |
| Config | object |
| Use Bech32 Scheme | boolean |
| Lud12 Enabled | boolean |
| Lud21 Enabled | boolean |
| Connection String | text |
| Derivation Scheme | text |
| Label | text |
| Account Key Path | text |
Update a Store User
ActionChanges what a store user may do.
| Field | Type |
|---|---|
StoreRequired | choice |
UserRequired | choice |
RoleRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Store ID | text |
| User ID | text |
Update a Subscriber Credit
ActionAdjusts the credit balance of a subscriber.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
CurrencyRequired | text |
| Credit | text |
| Charge | text |
| Description | text |
| Allow Overdraft | boolean |
| Field | Type |
|---|---|
| Currency | text |
| Value | text |
Update a Wallet Transaction
ActionAnnotates a transaction with notes.
| Field | Type |
|---|---|
StoreRequired | choice |
Payment MethodRequired | choice |
Transaction IDRequired | text |
| Comment | text |
| Labels | array |
| Label | text |
| Field | Type |
|---|---|
| Transaction Hash | text |
| Comment | text |
| Amount | text |
| Block Hash | text |
| Block Height | text |
| Confirmations | text |
| Timestamp | number |
| Status | text |
1other output field
Update a Webhook
ActionMoves or toggles a webhook endpoint.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| Endpoint URL | text |
| Enabled | choice |
| Automatic Redelivery | choice |
| Receive All Events | choice |
| Events | choice |
| Secret | secret |
| Field | Type |
|---|---|
| Enabled | boolean |
| Automatic Redelivery | boolean |
| URL | text |
| Authorized Events | object |
| Everything | boolean |
| Specific Events | array |
| ID | text |
Update an App
ActionRenames an app and edits its description.
| Field | Type |
|---|---|
AppRequired | choice |
App TypeRequired | choice |
| App Name | text |
| Title | text |
| Description | text |
| Notification URL | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| App Name | text |
| Store ID | text |
| Created (Unix Seconds) | number |
| App Type | text |
| Archived | boolean |
| Title | text |
| Description | text |
19other output fields
Update an Invoice
ActionRewrites custom data on an invoice.
| Field | Type |
|---|---|
Invoice IDRequired | text |
MetadataRequired | text |
| Merge With Stored Metadata | boolean |
| Field | Type |
|---|---|
| Metadata | object |
| Buyer Name | text |
| Buyer Email | text |
| Buyer Country | text |
| Buyer Zip | text |
| Buyer State | text |
| Buyer City | text |
| Buyer Address1 | text |
| Buyer Address2 | text |
| Buyer Phone | text |
| Item Desc | text |
| Checkout | object |
| Speed Policy | text |
| Payment Methods | array |
| Default Payment Method | text |
| Lazy Payment Methods | boolean |
| Expiration Minutes | number |
| Monitoring Minutes | number |
| Payment Tolerance | number |
| Redirect URL | text |
| Redirect Automatically | boolean |
| Default Language | text |
| Receipt | object |
| Enabled | boolean |
| Show QR | boolean |
| Show Payments | boolean |
| ID | text |
| Store ID | text |
| Amount | text |
| Paid Amount | text |
| Currency | text |
9other output fields
Update an Offering
ActionEdits a subscription product.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
| Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
Update an Offering Plan
ActionReprices or retimes a plan.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
PlanRequired | choice |
| Name | text |
| Price | text |
| Currency | text |
| Recurring Type | choice |
| Trial Days | number |
7other input fields
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
6other output fields
Update Notification Settings
ActionChooses which alerts you receive.
| Field | Type |
|---|---|
| Turn Off | array |
| Identifier | text |
| Turn On | array |
| Identifier | text |
| Field | Type |
|---|---|
| Notifications | array |
Update Store Email Settings
ActionSets up store email delivery.
| Field | Type |
|---|---|
StoreRequired | choice |
| SMTP Server | text |
| Port | number |
| Login | text |
| Password | secret |
| From Address | text |
| Disable Certificate Check | choice |
| Field | Type |
|---|---|
| From | text |
| Server | text |
| Port | number |
| Login | text |
| Disable Certificate Check | boolean |
| Password Set | boolean |
Update Subscriber Dates
ActionShifts subscription start and end dates.
| Field | Type |
|---|---|
StoreRequired | choice |
OfferingRequired | choice |
Customer SelectorRequired | text |
| Start Date | date |
| Expiration Date | date |
| Field | Type |
|---|---|
| Created (Unix Seconds) | number |
| Customer | object |
| Store ID | text |
| ID | text |
| External ID | text |
| Identities | text |
| Metadata | text |
| Offering | object |
| App Name | text |
| Success Redirect URL | text |
| Metadata | text |
| Features | array |
| ID | text |
| Store ID | text |
| App ID | text |
| Plans | array |
| Plan | object |
| ID | text |
| Name | text |
| Status | text |
| Price | text |
| Currency | text |
| Recurring Type | text |
| Grace Period Days | number |
| Trial Days | number |
| Description | text |
| Member Count | number |
| Period End (Unix Seconds) | number |
| Trial End (Unix Seconds) | number |
| Grace Period End (Unix Seconds) | number |
| Is Active | boolean |
9other output fields
Update the Current User
ActionEdits the profile behind your key.
| Field | Type |
|---|---|
| text | |
| Name | text |
| Image URL | text |
| Current Password | secret |
| New Password | secret |
| Allow Basic Auth for API | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Name | text |
| Image URL | text |
| Invitation URL | text |
| Email Confirmed | boolean |
| Requires Email Confirmation | boolean |
| Approved | boolean |
6other output fields
Templates
Look for BTCPay Server templates in the WEXTL template library.
Browse templates →Other finance integrations on WEXTL
Chargebee[2]Subscription billing for customers, plans, invoices, and payments.
CommasCreator commerce for checkouts, subscriptions, customers, and payouts.
AdyenGlobal payment platform for online, in-person, and unified commerce transactions.
AltovizManage customers, suppliers, products, quotes, invoices, credits and payments in Altoviz.
ClientaryManage clients, estimates, invoices, retainers, projects, time and payments in Clientary.
References
- WEXTL® BTCPay Server Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for BTCPay Server.
- 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.





























