- Category: payment processing
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 16
- Triggers: 0
- Slug:
BTCPAY_SERVER - Version: 20261101_00
Tools
Create Payment Request
Create Payment Request
Slug:
BTCPAY_SERVER_CREATE_PAYMENT_REQUESTCreates a new payment request in a BTCPay Server store. Payment requests are shareable pages where customers can create invoices to pay the requested amount. Unlike direct invoices, payment requests can be reused and allow customers to initiate payments themselves. Use this after obtaining a valid store ID from the create_store or get_store actions.Input Parameters
ISO 4217 currency code (e.g., USD, EUR, BTC). If not specified, uses the store’s default currency.
When the payment request expires. Pass as ISO 8601 datetime; will be converted to Unix timestamp for the API.
If true, allows the customer to enter a custom payment amount when creating invoices from this request
Output
Create Store
Create Store
Slug:
BTCPAY_SERVER_CREATE_STORETool to create a new store in BTCPay Server. Use when you need to provision a new store before processing transactions.Input Parameters
The name of the store to be created. This will be displayed in the BTCPay Server UI and on invoices.
Confirmation speed policy for on-chain payments. ‘HighSpeed’ = 0 confirmations (instant), ‘MediumSpeed’ = 1 confirmation, ‘LowMediumSpeed’ = 2 confirmations, ‘LowSpeed’ = 6 confirmations.
ISO 4217 currency code (e.g., ‘USD’, ‘EUR’) or cryptocurrency code (e.g., ‘BTC’, ‘SATS’) to use as default for invoices. Defaults to ‘USD’ if not specified.
Output
Create BTCPay Server User
Create BTCPay Server User
Register a Webhook
Register a Webhook
Slug:
BTCPAY_SERVER_CREATE_WEBHOOKRegisters a new webhook for a BTCPay store to receive real-time notifications when store events occur (e.g., invoice created, payment received, invoice settled). The webhook endpoint receives POST requests with event payloads signed using an HMAC secret for verification.Input Parameters
Optional HMAC secret used to sign webhook payloads for verification. If not provided, the server auto-generates one.
Specifies which store events should trigger this webhook. Set ‘everything’ to true for all events, or provide a list of specific event types.
If true, automatically retry delivery when the webhook endpoint fails to respond. Default is true.
Output
Delete API Key
Delete API Key
Slug:
BTCPAY_SERVER_DELETE_API_KEYRevoke a specific API key to immediately prevent its use for authentication. Use this tool when you need to disable an API key, such as when rotating credentials or when a key may have been compromised. The revocation takes effect immediately. Note: This action requires authentication with an API key that has user management permissions.Input Parameters
The API key string to revoke. This is the actual key value, not an ID. Once revoked, the API key can no longer be used for authentication. You can find API keys using the Get API Keys action.
Output
Delete Payment Request
Delete Payment Request
Slug:
BTCPAY_SERVER_DELETE_PAYMENT_REQUESTDeletes (archives) a specific payment request from a BTCPay Server store. Use this tool when you need to remove or archive an existing payment request. The payment request will be marked as archived and will no longer be active. This operation requires the ‘btcpay.store.canmodifypaymentrequests’ API permission. Note: This is a destructive operation - once deleted, the payment request cannot be restored.Input Parameters
The unique identifier of the BTCPay Server store that contains the payment request to delete.
The unique identifier of the payment request to delete/archive. This ID is returned when creating a payment request.
Output
Cancel Store Payout
Cancel Store Payout
Slug:
BTCPAY_SERVER_DELETE_PAYOUTCancels (deletes) a specific payout from a BTCPay Server store. Use this tool when you need to cancel a pending payout that is no longer needed. Only payouts in ‘AwaitingApproval’ or ‘AwaitingPayment’ state can be canceled. Payouts that have already been processed or completed cannot be canceled. Requires the ‘btcpay.store.canmanagepayouts’ permission on the API key.Input Parameters
The unique identifier of the payout to cancel. Payouts can only be canceled if they are in ‘AwaitingApproval’ or ‘AwaitingPayment’ state
Output
Get Current API Key
Get Current API Key
Slug:
BTCPAY_SERVER_GET_API_KEYSRetrieve information about the current API key. Returns details including the API key string, its label, and the permissions it has been granted. Use this to verify authentication is working and to check what permissions the current API key has. Note: BTCPay Server only provides access to the current API key, not all API keys associated with the user account. This tool is read-only; it cannot create, modify, or delete API keys.Output
Get Payment Requests
Get Payment Requests
Get BTCPay Server Info
Get BTCPay Server Info
Get Store
Get Store
Slug:
BTCPAY_SERVER_GET_STORERetrieves configuration and settings for a specific BTCPay Server store by ID, including currency, invoice, checkout, and branding settings.Input Parameters
The unique identifier (ID) of the store to retrieve. This is a string value that can be obtained from creating a store or listing stores. Example format: alphanumeric string like ‘9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776’.
Output
Get BTCPay Server User
Get BTCPay Server User
Slug:
BTCPAY_SERVER_GET_USERRetrieve information about a BTCPay Server user by ID or email. Use ‘me’ as the id_or_email parameter to get the currently authenticated user’s profile. Alternatively, provide a specific user ID (UUID) or email address to retrieve another user’s information. Requires API key with ‘btcpay.user.canviewprofile’ permission scope. Note: Viewing other users’ profiles requires server administrator privileges.Input Parameters
The ID or email of the user to retrieve. Use ‘me’ to get the current authenticated user’s information.
Output
Get Store Webhook
Get Store Webhook
List Store Webhooks
List Store Webhooks
List Apps
List Apps
Slug:
BTCPAY_SERVER_LIST_APPSRetrieve all apps (Point of Sale, Crowdfund, etc.) associated with a specific BTCPay Server store. Returns basic metadata for each app including its ID, name, type, creation timestamp, and archived status. Use this tool when you need to enumerate or discover apps configured within a store.Input Parameters
The unique identifier of the store to list apps for. This is typically a 52-character alphanumeric string.
Output
Update BTCPay Server User
Update BTCPay Server User
Slug:
BTCPAY_SERVER_UPDATE_USERUpdate the profile of the currently authenticated BTCPay Server user. Use this tool to modify user profile settings like display name, email, profile picture, or password. All fields are optional - only provide fields you want to change. Requires API key with ‘btcpay.user.canmodifyprofile’ permission scope. Note: Password changes require both currentPassword and newPassword to be provided. Email changes may require re-verification depending on server configuration.Input Parameters
Current password - required only when changing to a new password. Must be provided together with newPassword.