Cancel Refund Request

The Indirect Participant can cancel a refund request if necessary.

Only the Participant (Direct or Indirect) who created the refund request can cancel it.

To cancel, the status must be OPEN

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_request/REFUND_REQUEST_KEY

METHOD

PATCH

Request Body

{
    "refund_request_status": "cancelled",
    "request_control_key": "e09aba97-0051-4c18-b645-1cb3c2581c34"
}

Path Params

Field	Type	Description	Characters
refund_request_key *	string	UUID4 of the already created refund.	36

Body Params

Field	Type	Description	Characters
refund_request_status *	string	Status of the refund update.	36
request_control_key *	uuidv4	UUID4 for querying about the made request.	36

Response

STATUS

200

Response Body

{
  "refund_request_key": "47633091-7d44-4d10-9d00-1f937104e537",
  "pix_transfer_key": "2bcbfd65-8660-4cb0-8ae4-4c4b327b32be",
  "end_to_end_id": "E73856642202407011350E8cnA3Ae7r3",
  "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-07-01T13:50:30Z"
}

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_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.