Reembolsar Pagamento

PATCH https://sandbox.tbanks.com.br/pix/payment-order/return

Nota

Para buscar um reembolso é necessário usar o endpoint de consulta de ordem de pagamentos

Corpo do Request

Campo	Tipo	Obrigatório	Descrição
endToEnd	String	Não	EndToEnd do pagamento
value	Number	Não	valor a ser reembolsado
description	String	Não	Descrição do reembolso
reason	Enum	Não	Razão do reembolso

Possíveis reasons

Campo	Descrição
DUPLICATED	Ordem de pagamento em duplicidade.
DIVERGENT	Devolução devido ao valor recebido não estar de acordo com o esperado.
PSP_ERROR	Devolução devido a um erro do PSP.
TECHNICAL_PROBLEMS	Devolução após problemas técnicos, resultando em transação incorreta.
TRANSACTION_CANCELLED	Devolução após solicitação de cancelamento da transação.
FRAUD	Devolução devido a fraude no pagamento.
ORIGINAL_RECEIVER_REQUEST	Devolução solicitado pelo usuário recebedor do pagamento original.
OTHER	Código de erro genérico que somente deve ser utilizado caso o motivo de devolução seja diverso e não esteja previsto na tabela de domínio.
INVESTIGATING	Devolução após a solicitação de investigação.
USER_NOT_IN_WHITELIST	Usuário do recebedor não faz parte da lista de pessoas autorizadas a transacionar recursos (Whitelist) com o usuário do pagador.
USER_IN_BLACKLIST	Usuário do recebedor incluída na lista impeditiva (Blacklist) do usuário do pagador.
UNKNOWN_PAYMENT	Ordem de pagamento não justificada.

Corpo do Response

Campo	Tipo	Descrição
identifier	String	Identificador da ordem de reembolso
accountIdentifier	String	Identificador da conta associada a ordem
qrCodeReference	String	Referencia do qr code associado ao reembolso
status	Enum	Status do reembolso
returnedValue	Number	Valor retornado
type	String	tipo de reembolso
recipient	Object	Recebedor do reembolso
└── ispb	String	Ispb do recebedor
└── institution	String	Instituição financeira do recebedor
└── name	String	Nome do recebedor
└── documentNumber	String	Numero do documento do recebedor
└── branch	String	Numero da filial da instituição financeira do recebedor
└── number	String	Numero da conta do recebedor
└── type	Enum	Tipo da conta
└── key	String	Chave associada a conta
description	String	Descrição da ordem a ser reembolsada
value	Number	Valor da ordem
transactionDate	LocalDate	Data da transação da ordem
effectiveTransactionTime	LocalDate	Data efetiva da transação da ordem
origin	Enum	Origem da ordem
sender	Object	Remetente da ordem de pagamento
└── ispb	String	Ispb do remetente
└── institution	String	Instituição financeira do remetente
└── name	String	Nome do remetente
└── documentNumber	String	Numero do documento do remetente
└── branch	String	Filial da instituição financeira do remetente
└── number	String	Numero da conta do remetente
└── type	Enum	Tipo de conta
└── key	String	Chave associada a conta
isInternal	Boolean	Diferenciador de ordem interna para externa
scheduledTransfer	LocalDate	Data programada de transferencia
endToEnd	String	endToEnd da ordem em si
movementId	Number	Id do movimento
sentError	Enum	Possível erro no reembolso
taxValue	Number	Valor de taxa
transactionIdentifier	String	Identificador da transação

Possíveis Status

Campo	Descrição
PAID	Pago
SCHEDULED	Agendado
PENDING	Pendente
CANCELED	Cancelado
REQUESTED	Requisitado
RETURNED	Retornado
REJECTED	Rejeitado
ERROR	Erro

Possíveis tipos de conta

Campo	Descrição
CHECKING	Conta corrente
SALARY	Conta salário
SAVINGS	Conta poupança.
TRANSACTIONAL	Conta pagamento.

Possíveis tipos de origin

Campo	Descrição
BANK_ADDRESS	Permissão bancaria
QR_CODE	Qr code
KEY	Chave
REFUND	Reembolso
INIC_PAG	Inicio pagamento
INIC_PAG_QR_CODE	Inicio pagamento qr code
INIC_PAG_MANU	Inicio pagamento manual
INIC_PAG_CHAVE	Inicio pagamento com chave
DEVOLUCAO_ESPECIAL	Devolução especial