List Refund Requests

If the Indirect Participant requests a listing of Refund Requests, they can do so through the route below.

IMPORTANT

The Central Bank of Brazil requires that, within a period of 1 day from the receipt of the Refund Request by the Indirect Participant, the Refund must be closed.

If there is a delay on the part of the Indirect Participant, QI Tech will close the Refund Request with the status of totally_accepted to ensure the institution is not penalized by the Central Bank of Brazil.

Request

ENDPOINT

/pix/refund_requests

METHOD

GET

Query Params

Field	Type	Description	Characters
refund_request_status	enum	Status of the Infraction Report.	Enumerators refund_request_status
refund_request_type	enum	Type of the Infraction Report.	Enumerators refund_request_type
initial_date	string	Start search date.	Date format
final_date	string	End search date.	Date format
page_number	integer	Current page being queried.	-
page_size	integer	Number of results per page.	-

Enumerators refund_request_status

Field	Type	Description	Characters
open	string	Refund Request was created and is open at BACEN.	4
cancelled	string	Refund Request is cancelled at BACEN.	9
closed	string	Refund Request is closed at BACEN.	6

Enumerators refund_request_type

Field	Type	Description	Characters
fraud	string	Refund Request originating from fraud.	5
operational_flaw	string	Refund Request originating from an internal error.	16

Date format

Field	Type	Description	Characters
initial_date	string	Start search date, in the format "%Y-%m-%d". Example: "2023-10-09".	10
final_date	string	End search date, in the format "%Y-%m-%d". Example: "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

Field	Type	Description	Characters
pix_transfer_key*	string	Unique identifier of the PIX transaction.	36
refund_request_key*	string	Unique identifier of the refund request.	36
infraction_report_key*	string	Unique identifier of the infraction related to the refund. Only when the type is FRAUD	36
refund_request_type	enum	Type of refund request.	Enumerators refund_request_type
requested_amount*	float	Refund amount	-
refund_request_status*	enum	Status.	Enumerators refund_request_status
contested_participant*	string	ISPB of the Credited Participant (Contested).	8
requesting_participant*	string	ISPB of the Debited Participant (Requesting, who is requesting the refund).	8
refund_request_details*	string	Details about the refund request.	-
analysis_result*	enum	Result of the refund closure analysis.	Enumerators analysis_result
analysis_details*	string	Details of the refund closure analysis.	-
reject_reason*	string	Reason for rejecting the refund, if it is closed with REJECTED.	Enumerators reject_reason
refund_transfer_key*	string	pix_transfer_key of the refund transaction, if it is closed with acceptance.	-
refunded_amount*	float	Amount refunded in the refund transaction.	-
refund_events*	object	Object for refund request events.	Objects refund_events
refund_request_direction*	string	Direction of the refund request.	Enumerators refund_request_direction
created_at *	string	Refund Request creation date	24

Enumerators refund_request_status

Field	Description
open	Refund Request was created and is open at BACEN.
cancelled	Refund Request is cancelled at BACEN
closed	Refund Request is closed at BACEN

Enumerators refund_request_type

Field	Description
fraud	Refund Request originating from fraud.
operational_flaw	Refund Request originating from an internal error.

Enumerators analysis_result

Field	Description
totally_accepted	Refund Request was fully accepted.
partially_accepted	Refund Request was partially accepted.
rejected	Refund Request was rejected.

Enumerators reject_reason

Field	Description
no_balance	Account does not have sufficient balance for the refund.
account_closure	Account is closed, so the refund cannot be processed
other	Other reason

Enumerators refund_request_direction

Field	Description
outgoing	Participant is the originator of the refund request.
incoming	Participant is the target of the refund request

Objects refund_events

Field	Description
event_type	Type of the refund event change. Enumerators refund_request_status
event_details	Details about the event.
created_at	Event creation date.