Actions6
- Payment Intent Actions
- Portal Actions
- Transaction Actions
Overview
This node integrates with the Bayarcash API to manage payment intents, portals, and transactions. Specifically, for the Payment Intent - Delete operation, it allows users to delete an existing payment intent by its ID. This is useful in scenarios where a payment intent was created but needs to be canceled or removed before completion, such as when an order is canceled or a payment attempt is invalidated.
Practical example:
- An e-commerce platform creates a payment intent for a customer’s order but later the customer cancels the order. The node can be used to delete the corresponding payment intent from Bayarcash to avoid unnecessary payment processing.
Properties
| Name | Meaning |
|---|---|
| Payment Intent ID | The unique identifier of the payment intent to delete (e.g., pi_zByPm9). This is required. |
Additionally, a notice property is shown informing that this delete endpoint is only available in Bayarcash API v3.
Output
The output is a JSON object representing the response from the Bayarcash API after attempting to delete the specified payment intent. It typically contains confirmation of deletion or relevant status information returned by the API.
If the API returns binary data (not applicable here), it would be summarized accordingly, but this operation deals with JSON responses only.
Dependencies
- Requires an API key credential for authenticating with the Bayarcash API.
- The node expects the Bayarcash API URL and a personal access token (PAT) configured in the credentials.
- The delete operation specifically requires Bayarcash API version 3 support.
Troubleshooting
- Authentication failed: If the API returns a 401 error, it indicates an invalid or expired API token. Verify and update the API key credentials.
- Validation error (422): The request parameters may be incorrect or incomplete. Ensure the Payment Intent ID is valid and correctly formatted.
- Bad request (400): The request might be malformed. Double-check the input parameters.
- Forbidden (403): The user does not have permission to delete the payment intent or the payment channel is not enabled. Check account permissions and API access rights.
- Not found (404): The specified payment intent ID does not exist. Confirm the ID is correct.
- Server error (5xx): Temporary issues on Bayarcash server side. Retry after some time.
If the node is set to continue on failure, errors will be returned as JSON objects containing the error message, HTTP status code, and timestamp.
Links and References
- Bayarcash API Documentation (for detailed API usage and endpoints)
- n8n Documentation (for general node usage and credential setup)