PaymentRequest → Get
AI-generatedOverview
This node retrieves an existing payment request from a specified BTCPay store using the payment request ID. It is useful for scenarios where you need to fetch details of a particular payment request, such as checking its status or retrieving payment information for further processing or reporting.
Use Case Examples
- Fetch a payment request by its ID to verify payment status before fulfilling an order.
- Retrieve payment request details to display transaction information in a dashboard.
Properties
| Name | Meaning |
|---|---|
| Store Name or ID | The identifier of the BTCPay store from which to fetch the payment request. Can be selected from a list or specified via an expression. |
| Payment ID | The unique ID of the payment request to fetch from the specified store. |
Output
JSON
id- The unique identifier of the payment request.amount- The amount specified in the payment request.title- The title or description of the payment request.status- The current status of the payment request.createdAt- Timestamp when the payment request was created.additionalFields- Any additional fields or metadata associated with the payment request.
Dependencies
- Requires an API key credential with permission to view store settings and payment requests on BTCPay server.
Troubleshooting
- Ensure the API key used has the 'btcpay.store.canviewstoresettings' permission enabled to access store information.
- If the payment request ID is invalid or does not exist, the node will throw an error indicating the resource was not found.
- Network or authentication errors may occur if the API key is incorrect or the BTCPay server is unreachable. Verify credentials and server availability.
Links
- BTCPay API Documentation - Get Payment Request - Official API documentation for retrieving a payment request from BTCPay server.