PaymentRequest → Create
AI-generatedOverview
This node creates a new payment request in a specified BTCPay store. It is useful for automating the generation of payment requests for transactions, such as orders or invoices, where you need to specify an amount and a title for the payment. Additional custom fields can be added to tailor the payment request to specific needs, such as setting a currency or other payment details.
Use Case Examples
- Creating a payment request for an order with a specific amount and title.
- Adding custom fields like currency to the payment request to support different payment options.
Properties
| Name | Meaning |
|---|---|
| Store Name or ID | The identifier of the BTCPay store where the payment request will be created. Can be selected from a list or specified via an expression. |
| Amount | The amount for the payment request. Must be greater than 0 and uses the store's default currency unless overridden by a custom field. |
| Title | The title of the payment request, such as an order number or description. |
| Additional Fields | Optional custom fields to include in the payment request, such as 'currency' or other parameters supported by the BTCPay API. |
Output
JSON
amount- The amount specified in the payment request.title- The title of the payment request.id- The unique identifier of the created payment request.status- The current status of the payment request.additionalFields- Any additional fields included in the payment request response.
Dependencies
- BTCPay API key credential for authentication
Troubleshooting
- Ensure the API key used has the permission 'btcpay.store.canviewstoresettings' to access store information.
- If no stores are listed, verify the API key permissions and that the store ID is correctly specified.
- Errors during creation typically indicate issues with the API request body or authentication; check the error message for details.
Links
- BTCPay API Documentation - Create Payment Request - Official API documentation for creating payment requests in BTCPay Server.