Request the return of a received Pix

A Pix refund can be made up to 90 days from its receipt.

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer/PIX_TRANSFER_KEY/reversal

METHOD

POST

Path Params

Field	Type	Description	Characters
account_key *	uuidv4	Unique account identification key.	36
pix_transfer_key *	uuidv4	Unique identification key for the Pix transfer in the QI system.	36

Request Body

{
  "request_control_key": "303393bf-8f2e-4ff0-b326-ee7ad612e8ca",
  "reversal_amount": 147,
  "reversal_reason": "client_request",
  "reversal_message": "Mensagem Pix da Devolução",
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

Request Params

Field	Type	Description	Characters
request_control_key *	uuidv4	Uniqueness key for the request.	36
reversal_amount *	number	Refund amount.	11
reversal_reason *	string	Reason for the refund.	Enumerator reversal_reason
reversal_message	string	Refund message.	140
tfa_info *	Object	Object containing the document of the account approver and the means of contact.	Object tfa_info

Enumerator reversal_reason

Enumerator	Description
client_request	If requested by the account owner.
reconciliation	For reconciliation due to operational error.

Object tfa_info

Field	Type	Description	Characters
approver_document_number *	string	Document number of the account approver.	11
contact_type *	string	Means of contact with the account approver, can be sms or email

Response

STATUS

202

Response Body: Reversal Requested

{
  "reversal_status": "pending_2fa_approval",
  "end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
  "pix_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48",
  "request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
  "created_at": "2021-10-22T20:30:23.459Z"
}

Response Body

Field	Type	Description	Characters
reversal_status	enumerator	Enumerator for the reversal transaction status.	Enumerator reversal_status
transfer_amount	number	Amount of the reversal transfer.	11
pix_transfer_key	uuidv4	Key of the executed pix transaction for the reversal.	36
request_control_key	uuidv4	Unique identification key for the request used by the client.	36
created_at	string	Date and time of the reversal.	10

Enumerator reversal_status

Enumerator	Description
sent	Pix transfer successfully executed.
pending	Pix transfer pending.
pending_2fa_approval	Pix transfer pending two-factor approval.
rejected	Pix transfer rejected.

STATUS

4xx

Response Body: Reversão Rejeitada

{
  "title": "titulo",
  "description": "description in English",
  "translation": "description in portuguese",
  "code": "codigo",
  "extra_fields": {
    "pix_transfer_data": {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
      "pix_transfer_status": "rejected",
      "created_at": "2021-10-22T20:30:23.459Z"
    }
  }
}

Information

In addition to the errors previously listed for Pix transfer, a Pix refund can also return the errors listed below.

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Erro de Schema
404	PXT000018	Reversal Original Transfer not Found	Reversal original pix transfer not found.	Transferência original da devolução não foi encontrada.
400	PXT000017	Reversal Too Great	Reversal transfers sum amount surpasses that of original pix transfer.	A soma das transferências de devolução ultrapassam o valor da transferência pix original.
400	PXT000015	Reversal date expired	Reversal original transaction is older than 90 days	A data de criação da transação original é mais antiga que 90 dias
400	PXT0000127	Invalid Reversal Reason	Reversal reason {reversal_reason} is not valid	Razão de reversão {reversal_reason} não é válida