Overview
This node integrates with BTCPay Server to manage payment requests within a specified store. Specifically, the Get PaymentRequest operation fetches details of an existing payment request by its ID from a chosen store.
Common scenarios where this node is useful include:
- Retrieving the status or details of a specific payment request for order tracking.
- Integrating payment verification into workflows that depend on payment completion.
- Auditing or reporting on individual payment requests programmatically.
For example, you might use this node in an e-commerce automation workflow to check if a customer’s payment request has been completed before fulfilling an order.
Properties
| Name | Meaning |
|---|---|
| Store Name or ID | Select the store from which to retrieve the payment request. Can be chosen from a list or set via expression. Requires API key permission to view stores. |
| Payment ID | The unique identifier of the payment request to fetch. |
Output
The node outputs a JSON object representing the payment request details as returned by the BTCPay Server API. This includes all standard fields of a payment request such as amount, title, status, and any additional metadata associated with it.
No binary data output is produced by this operation.
Dependencies
- Requires a valid API key credential with permissions to access the selected store and read payment requests.
- The API key must have at least the permission to view store settings and payment requests.
- The node depends on the BTCPay Server API endpoint
/api/v1/stores/{storeId}/payment-requests/{paymentRequestId}.
Troubleshooting
- Permission Issues: If no stores appear in the "Store Name or ID" dropdown, ensure your API key has the required permission to view store settings.
- Invalid Payment ID: Providing a non-existent or malformed payment request ID will result in an error from the API. Verify the ID is correct.
- API Errors: Network issues or incorrect API credentials will cause errors. Check connectivity and credential validity.
- Unsupported Resource/Operation: Attempting to use unsupported resources or operations will throw explicit errors indicating the unsupported action.