v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Devoluções - Cliente

Devolução - Solicitar

Pré-requisitos:

  • Um pix recebido nos ultimos 90 dias.
  • A consulta de recebimentos pode ser realizada na rota Recebimentos - Consultar

Características:

  • Solicita uma operação de devolução para o valor recebido.
  • A devolução desse valor pode ser parcial.
  • A devolução pode ser realizada N vezes até que o valor total devolvido seja igual ao recebido.
  • O status da devolução pode ser consultado em Devolução - Consultar
  • Uma devolução pode ser recusada caso não exista saldo na conta ou o contraparte rejeita a operação.
put/pix/direto/forintegration/v1/pix/{e2eid}/devolucao/{idExterno}

Path parameters

e2eidstring required

EndToEndId - Numero do protocolo do recebimento.

EndToEndId - Numero do protocolo do recebimento.

idExternostring required

Id transacional gerado pelo cliente para fins de conciliação.

Id transacional gerado pelo cliente para fins de conciliação.

Request body

valornumber double required

Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix.

Response

Solicitação de devolução criada com sucesso.

idstring nullable

Id gerado pelo cliente para representar unicamente uma devolução.

rtrIdstring nullable

ReturnIdentification que transita na PACS004.

valornumber double

Valor a devolver.

status'EM_PROCESSAMENTO' | 'DEVOLVIDO' | 'NAO_REALIZADO'

Os status de uma devolução são:

TipoComentário
EM_PROCESSAMENTOO pedido de devolução esta em fase de processamento.
DEVOLVIDODevolução realizada com sucesso.
NAO_REALIZADODevolução foi impedida de ser realizada.