Overview
This node integrates with the Cielo Payments API, enabling users to manage payment transactions directly within their workflows. It supports creating new payments, capturing authorized payments, canceling payments, and consulting payment details.
A common use case is automating e-commerce payment processing: for example, creating a payment when an order is placed, capturing it once the order ships, or canceling it if the order is canceled. Consulting payment status can be used for reconciliation or customer support.
For the Consultar Pagamento (Consult Payment) operation specifically, the node retrieves detailed information about a payment using its unique Payment ID. This is useful for checking the current status or details of a transaction.
Properties
| Name | Meaning |
|---|---|
| Payment ID | The unique identifier of the payment to consult. Required for capture, cancel, and consult operations. |
Output
The node outputs a JSON object containing the response from the Cielo Payments API corresponding to the requested operation.
For the Consultar Pagamento operation, the output JSON includes detailed payment information such as status, amount, payment method, timestamps, and other metadata returned by the API.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Cielo Payments API.
- The node uses the Cielo sandbox API endpoint by default but can be configured via credentials.
- Network access to the Cielo API endpoints is necessary.
Troubleshooting
Common issues:
- Invalid or missing Payment ID will cause the API request to fail.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity problems may prevent successful API calls.
Error messages:
- Errors are prefixed with "Erro na operação Cielo:" followed by the specific message.
- If the error is not a standard Error object, the raw response is stringified and included.
Resolution tips:
- Verify that the Payment ID is correct and corresponds to an existing payment.
- Ensure API credentials are valid and have the required permissions.
- Check network connectivity and firewall settings.
- Review the Cielo API documentation for error codes and meanings.
Links and References
- Cielo Payments API Documentation
- n8n Documentation on HTTP Request Node (for understanding underlying HTTP requests)