Listar Solicitações de Devolução

Caso o Participante Indireto solicite a listagem de Solicitações de Devolução, pode fazê-lo por meio da rota abaixo.

IMPORTANTE

O Banco Central do Brasil define que, dentro de um período de 1 dia do recebimento da Solicitação de Devolução pelo Participante Indireto, a Devolução precisa ser fechada.

Caso haja atraso por parte do Participante Indireto, a QI Tech irá fechar a Solicitação de Devolução, com o status de totally_accepted, a fim de que a instituição não seja penalizada pelo Banco Central do Brasil.

Request

ENDPOINT

/pix/refund_requests

MÉTODO

GET

Query Params

Campo	Tipo	Descrição	Caracteres
refund_request_status	enum	Status do Relato de Infração.	Enumeradores refund_request_status
refund_request_type	enum	Tipo do Relato de Infração.	Enumeradores refund_request_type
initial_date	string	Data inicial de busca.	Formato de data
final_date	string	Data final de busca.	Formato de data
page_number	integer	Página atual que está sendo consultada.	-
page_size	integer	Quantidade de resultados por página.	-

Enumeradores refund_request_status

Campo	Tipo	Descrição	Caracteres
open	string	Solicitação de Devolução foi criada e está aberto no BACEN.	4
cancelled	string	Solicitação de Devolução está cancelada no BACEN.	9
closed	string	Solicitação de Devolução está fechada no BACEN.	6

Enumeradores refund_request_type

Campo	Tipo	Descrição	Caracteres
fraud	string	Solicitação de Devolução originada de uma fraude.	5
operational_flaw	string	Solicitação de Devolução originada de um erro interno.	16

Formato de data

Campo	Tipo	Descrição	Caracteres
initial_date	string	Data de inicio para a procura, em formato "%Y-%m-%d. Exemplo: "2023-10-09".	10
final_date	string	Data final para a procura, em formato "%Y-%m-%d. Exemplo: "2023-10-11".	10

Response

STATUS

200

Response Body

{
  "data": [
    {
      "refund_request_key": "817c9331-fe1d-4178-aff2-8bed87ce3099",
      "pix_transfer_key": "029efb4e-ad3b-4ba5-a73c-c724f0d9c02b",
      "end_to_end_id": "E73856642202406282112pEBgwN7kkqD",
      "requested_amount": 10,
      "refund_request_status": "cancelled",
      "refund_request_type": "operational_flaw",
      "infraction_report_key": null,
      "refund_request_details": "Foi identificada uma fraude na transação.",
      "requesting_participant": "73856642",
      "contested_participant": "99999999",
      "analysis_result": null,
      "analysis_details": null,
      "reject_reason": null,
      "refund_transfer_key": null,
      "refunded_amount": 0.00,
      "refund_request_direction": "outgoing",
      "created_at": "2024-06-28T21:25:20Z",
      "refund_events": [
        {
          "event_type": "open",
          "event_details": "Solicitação de Devolução criada pelo participante indireto",
          "created_at": "2024-06-28T21:25:20Z"
        },
        {
          "event_type": "cancelled",
          "event_details": "Solicitação de Devolução cancelada pelo participante indireto",
          "created_at": "2024-06-28T21:27:19Z"
        }
      ]
    },
    {
      "refund_request_key": "5d174097-3d5c-41a2-a548-b24c41eecfb4",
      "pix_transfer_key": "d5856a5f-378f-43ed-818b-df33b9fae703",
      "end_to_end_id": "E60701190202406281828JCBxFsqssCf",
      "requested_amount": 10,
      "refund_request_status": "closed",
      "refund_request_type": "operational_flaw",
      "infraction_report_key": null,
      "refund_request_details": "Foi identificada uma fraude na transação.",
      "requesting_participant": "99999999",
      "contested_participant": "73856642",
      "analysis_result": "rejected",
      "analysis_details": null,
      "reject_reason": "no_balance",
      "refund_transfer_key": null,
      "refunded_amount": 0.00,
      "refund_request_direction": "incoming",
      "created_at": "2024-07-01T12:47:41Z",
      "refund_events": [
        {
          "event_type": "open",
          "event_details": "Solicitação de Devolução criada por outra instituição financeira",
          "created_at": "2024-07-01T12:47:41Z"
        }
      ]
    }
  ]
}

Body Params

Campo	Tipo	Descrição	Caracteres
pix_transfer_key*	string	Identificador único da transação PIX.	36
refund_request_key*	string	Identificador único da devolução.	36
infraction_report_key*	string	Identificador único da infração relacionada à devolução. Somente quando o tipo for FRAUDE	36
refund_request_type	enum	Tipo de solicitação de devolução.	Enumeradores refund_request_type
requested_amount*	float	Valor da devolução	-
refund_request_status*	enum	Status .	Enumeradores refund_request_status
contested_participant*	string	ISPB do Participante Creditado (Contestado).	8
requesting_participant*	string	ISPB do Participante Debitado (Requisitante, o qual está pedindo a devolução).	8
refund_request_details*	string	Detalhes da devolução.	-
analysis_result*	enum	Resultado da análise de fechamento da devolução.	Enumeradores analysis_result
analysis_details*	string	Detalhes da análise de fechamento da devolução.	-
reject_reason*	string	Motivo da rejeição da devolução, caso seja fechada com REJECTED.	Enumeradores reject_reason
refund_transfer_key*	string	pix_transfer_key da transação de devolução, caso seja fechada com aceite.	-
refunded_amount*	float	Valor devolvido na transação de devolução.	-
refund_events*	object	Objeto eventos de pedido de devolução.	Objeto refund_events
refund_request_direction*	string	Direção da solicitação de devolução.	Enumeradores refund_request_direction
created_at *	string	Data de criação da Solicitação de Devolução	24

Enumeradores refund_request_status

Campo	Descrição
open	Solicitação de Devolução foi criada e está aberta no BACEN.
cancelled	Solicitação de Devolução está cancelada no BACEN
closed	Solicitação de Devolução está fechada no BACEN

Enumeradores refund_request_type

Campo	Descrição
fraud	Solicitação de Devolução originada de uma fraude.
operational_flaw	Solicitação de Devolução originada de um erro interno.

Enumeradores analysis_result

Campo	Descrição
totally_accepted	Solicitação de Devolução foi totalmente aceita.
partially_accepted	Solicitação de Devolução foi parcialmente aceita;
rejected	Solicitação de Devolução foi rejeitada.

Enumeradores reject_reason

Campo	Descrição
no_balance	Conta não possui saldo para realizar a devolução.
account_closure	Conta se encontra fechada e, portanto, não é possível realizar a devolução
other	Outro motivo

Enumeradores refund_request_direction

Campo	Descrição
outgoing	Participante é originador do pedido de devolução.
incoming	Participante é o alvo do pedido de devolução

Objetos refund_events

Campo	Descrição
event_type	Tipo do evento de mudança da devolução. Enumeradores refund_request_status
event_details	Detalhes acerca do evento.
created_at	Data de criação do evento.