Overview

This node interacts with the CHIP Collect API to manage purchases, specifically supporting operations such as creating, retrieving, charging, capturing, canceling, and refunding purchases. The 'Cancel' operation allows users to cancel an existing purchase by providing its Purchase ID. This node is useful for automating payment workflows, managing purchase lifecycles, and integrating payment processing into business applications.

Use Case Examples

1. Cancel a purchase by providing its Purchase ID to stop further processing or payment collection.
2. Retrieve purchase details before deciding to cancel.
3. Charge or capture payments for purchases, then cancel if necessary.

Properties

Output

JSON

• json - The JSON response from the CHIP Collect API after attempting to cancel the purchase, containing details about the canceled purchase or error information.

Dependencies

• Requires an API key credential for CHIP Collect API authentication.

Troubleshooting

• Ensure the Purchase ID is valid and corresponds to an existing purchase; otherwise, the API may return an error.
• Verify that the API key credential is correctly configured and has the necessary permissions to cancel purchases.
• Check network connectivity and API endpoint availability to avoid request failures.
• If the purchase cannot be canceled (e.g., already completed or refunded), the API will return an error message indicating the reason.

Links

• CHIP Collect API Documentation - Official API documentation for CHIP Collect, detailing endpoints and operations including purchase cancellation.