These docs are for v2.1. Click to read the latest docs for v4.1.

devolucao

O objeto devolucao segue um padrão diferente dos demais recursos das APIs da Plataforma PagSeguro pois ela segue as especificações definidas pelo Banco Central do Brasil, para mais detalhes consulte o plataforma oficial do PIX aqui.

CampoTipoDescrição
e2eidString [A-Z0-9-]{1,35}O parâmetro, obrigatório, representa o ID fim a fim da transação que transita na PACS002, PACS004 e PACS008. O e2eid fica disponível após uma cobrança estar concluída e você pode encontrá-lo no response da consulta da cobrança get/cob
idString [A-Z0-9-]{1,35}ID que representa uma devolução e é único por CPF/CNPJ do usuário recebedor. O objetivo desse campo é ser um elemento que possibilite ao usuário recebedor a funcionalidade de conciliação de pagamentos. O ID é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade
rtrIdString (32 caracteres)ReturnIdentification que transita na PACS004
valorString \d{1,10}.\d{2}Valor a Devolver
horarioObjetoHorários em que uma devolução foi solicitada e se aplicável, liquidada
solicitacaoString [date-time]Horário no qual a devolução foi solicitada no PSP
liquidacaoString [date-time]Horário no qual a devolução foi liquidada no PSP
statusStringStatus da devolução: EM_PROCESSAMENTO, DEVOLVIDO e NAO_REALIZADO
motivoString (1-140 caracteres)Descrição do status da devolução. Exemplos:
REFUND_TRANS_INVALID_REFUND_VALUE_LESS_THAN_ALLOWED
REFUND_TRANS_INVALID_REFUND_VALUE_GREATER_THAN_ALLOWED
REFUND_TRANS_INVALID_INSUFFICIENT_BALANCE
REFUND_TRANS_UNKNOWN_TRANSACTION_EXCEPTION
REFUND_TRANS_PM_UNSUPPORTED
PARTIAL_REFUND_EXCEPTION
REFUND_TRANS_PIN_REPLACEMENT_EXCEPTION