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.*.
string
Identificador único do refund. Usa o prefixo
re_*.string
Sempre
"refund".integer
Valor devolvido ao comprador, em centavos. É sempre positivo no objeto refund.
No extrato, o movimento correspondente usa o mesmo valor com sinal negativo.
string | null
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.string
ID da charge capturada que está sendo reembolsada (
ch_*). Sempre presente.string
Data de criação do refund em ISO 8601.
string
Moeda em código de três letras minúsculas, como
brl.string | null
Customer relacionado à charge (
cus_*), quando houver.string | null
Descrição legível do refund, quando disponível.
object | null
Informações não sensíveis sobre o destino da devolução, quando disponíveis. O
formato depende do meio de pagamento.
string | null
ID do movimento financeiro associado a uma falha de devolução, quando
aplicável.
string | null
Motivo normalizado quando
status é failed; null nos demais estados.string | null
E-mail usado para instruções adicionais de devolução, quando esse fluxo for
necessário.
boolean
true em produção e false em modo de teste.object
Pares chave-valor livres enviados por você. Retorna
{} quando vazio.
Atualizar metadata não altera valor, charge ou status do refund.object | null
Próxima ação necessária quando
status = requires_action. null quando
nenhuma ação adicional é necessária.string | null
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.string | null
Explica por que o refund ainda está pendente.
string | null
Motivo informado na criação do refund.
Disputa de cartão é outro fluxo financeiro e não aparece como
reason.string | null
Número de comprovante da devolução, quando disponível.
string | null
Referência da reversão de repasse que originou o refund, quando aplicável.
string
Estado atual da devolução.
string | null
Referência da reversão de repasse criada pelo refund, quando aplicável.
string | null
Data da última atualização em ISO 8601.