refund representa uma devolução de valor já capturado. Ele é um objeto
novo, sempre ligado à charge de origem, e tem ciclo de vida próprio.
Criar um refund não apaga a cobrança anterior:
Use
refund.status para decidir se a devolução foi concluída. O status do
Payment Intent e o status da charge descrevem o pagamento original.Objeto refund
Este é o formato completo retornado na criação, na consulta, nos itens da listagem e emdata.object dos webhooks refund.*.
Valor devolvido ao comprador, na menor unidade da moeda (centavos em
brl). É sempre positivo no objeto refund.
No extrato, o movimento correspondente usa o mesmo valor com sinal negativo.Referência direta à
transaction
negativa criada para o refund.Sempre presente quando status é succeeded: o movimento no extrato e a
conclusão da devolução são gravados juntos, então um refund concluído nunca
aparece sem o movimento correspondente. Nos demais estados é null, porque
ainda não houve saída de valor.Informações não sensíveis sobre o destino da devolução, quando disponíveis. O
formato depende do meio de pagamento.
Preenchido quando
status é failed; null nos demais estados. Hoje a
Chargefy publica charge_for_pending_refund_disputed, declined (a venda
não aceita devolução automática), insufficient_funds (a conta não tinha
saldo para devolver) e unknown. Os demais valores fazem parte do contrato e
só aparecem quando esse sinal existir.E-mail usado para instruções adicionais de devolução, quando esse fluxo for
necessário.
Pares chave-valor livres enviados por você. Retorna
{} quando vazio.
Atualizar metadata não altera valor, charge ou status do refund.Próxima ação necessária quando
status = requires_action. null quando
nenhuma ação adicional é necessária.Payment Intent que originou a charge (
pi_*), quando houver.O intent continua succeeded depois do refund: ele registra que o pagamento
aconteceu. A devolução é representada pelo próprio refund.Motivo informado na criação do refund.
Disputa de cartão é outro fluxo financeiro e não aparece como
reason.
