Overview
This node integrates with the Cielo Payments API, enabling users to manage credit card payment transactions. It supports creating new payments, capturing authorized payments, canceling payments, and consulting payment details.
Typical use cases include:
- Processing a new credit card payment by providing card details and amount.
- Capturing a previously authorized payment partially or fully.
- Canceling (voiding) a payment transaction.
- Retrieving the status and details of an existing payment.
For example, an e-commerce workflow can use this node to create a payment when a customer places an order, then capture the payment once the order is ready to ship, or cancel it if the order is canceled.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform: "Criar Pagamento" (Create Payment), "Capturar Pagamento" (Capture Payment), "Cancelar Pagamento" (Cancel Payment), or "Consultar Pagamento" (Consult Payment). |
| Merchant Order ID | Identifier for the merchant's order (required for creating a payment). |
| Valor (em centavos) | Amount in cents (integer). Required for creating, capturing, or canceling payments. |
| Número do Cartão | Credit card number (required for creating a payment). |
| Nome no Cartão | Cardholder's name (optional for creating a payment). |
| Data de Validade (MM/YYYY) | Card expiration date in MM/YYYY format (optional for creating a payment). |
| CVV | Card security code (optional for creating a payment). |
| Bandeira | Card brand, options include Visa, Mastercard, Amex, Elo, Diners, Discover, Hipercard (default Visa). |
| Payment ID | Identifier of the payment transaction (required for capture, cancel, and consult operations). |
Output
The node outputs JSON data representing the response from the Cielo Payments API for the performed operation. This includes detailed information about the payment transaction such as status, amounts, authorization codes, and other metadata returned by the API.
No binary data output is produced.
Dependencies
- Requires an API key credential for authenticating with the Cielo Payments API.
- The API base URL defaults to the Cielo sandbox environment but can be configured via credentials.
- HTTP requests are made to the Cielo API endpoints for sales management.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect payment IDs or amounts may result in errors from the API.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Errors are prefixed with "Erro na operação Cielo:" followed by the specific message from the API or internal error.
- To resolve, verify that all required parameters are correctly set, ensure valid credentials, and check network access.
Links and References
- Cielo Payments API Documentation (official API docs)
- n8n HTTP Request Node Documentation (for understanding HTTP request usage)