Actions8
Refund / Cancel Charge
AI-generatedSummary
Refund a charge or order transaction by specifying its ID, optionally providing a partial refund amount in cents; supports resolving order IDs to charge IDs when necessary.
Inputs
- Charge / Order ID (required) — Specify the PagBank charge ID (prefixed with CHAR_ or pb_ord_) or order ID (prefixed with ORDE_); the node resolves order IDs to charge IDs automatically. For Vindi, use pb_ord_ or partner charge/bill ID.
- Refund Amount (cents, optional) — Provide a refund amount in cents for partial refunds (e.g., 100 for R$ 1,00). Leave zero or empty to refund the full charge amount.
Output shape
a JSON object containing the result of the refund operation, typically including details about the refunded charge or order.
The output reflects the API response from PagBank or Vindi after attempting the refund. Errors are raised if the charge/order ID is invalid or refund processing fails.
Examples
Example 1: Refund entire charge
Charge / Order ID = 'CHAR_123456789', Refund Amount (cents) = 0 or empty; triggers a full refund of the specified charge.
Example 2: Partial refund by cents
Charge / Order ID = 'pb_ord_987654321', Refund Amount (cents) = 500; refunds R$5,00 partial amount from the charge/order.