Close Refund Request

The Indirect Participant can close a refund request if the Participant is the Contested Participant. To close the request, 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

{
    "request_control_key":"xpjae07e-1dc7-4df0-8472-233624706e08",
    "refund_request_status": "closed",
    "analysis_result": "totally_accepted",
    "analysis_details": "Valor bloqueado. Para mais informações, contatar central antifraude em 11 3000-45012, informando ID 0000.",
    "refund_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48"
}

Path Params

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

Body Params

Field	Type	Description	Characters
request_control_key *	uuidv4	UUID4 for querying about the made request.	36
request_request_status *	enum	Status	Enumerators refund_request_status
analysis_result *	enum	Result of the analysis	Enumerators analysis_result
analysis_details	string	Comment on the analysis	Less or 2000
refund_transfer_key	string	UUID4 of the refund transaction sent via the "reversal" route. Should be used when the "analysis_result" is acceptance.	36
reject_reason	enum	Reason for rejecting the refund. Should be used when the 'analysis_result' is 'rejected'.	Enumerators reject_reason

Response

STATUS

200

Response Body - Rejected

{
  "refund_request_key": "2e42116f-4bdb-4f07-931f-c4dc7a78ed99",
  "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": "Conta sem saldo.",
  "reject_reason": "no_balance",
  "refund_transfer_key": null,
  "refunded_amount": 0.00,
  "refund_request_direction": "incoming",
  "created_at": "2024-07-01T15:46:18Z"
}

Response Body - Agreed

{
  "refund_request_key": "2e42116f-4bdb-4f07-931f-c4dc7a78ed99",
  "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": "totally_accepted",
  "analysis_details": "Valor devolvido.",
  "reject_reason": null,
  "refund_transfer_key": "ab1189d8-5a87-4e5b-b49c-d05776bd8efe",
  "refunded_amount": 10.00,
  "refund_request_direction": "incoming",
  "created_at": "2024-07-01T15:46:18Z"
}

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.