Pix Refund

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

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer/PIX_TRANSFER_KEY/reversal

METHOD

POST

Request Path Params

Field	Type	Description	Characters
account_key	string	Unique account key (UUIDv4)	36
alias_key	string	Unique alias key (UUIDv4)	36
pix_transfer_key	string	Unique identification key of the Pix transfer in the QI system (UUIDv4)	36

Request Body

{
  "request_control_key": "303393bf-8f2e-4ff0-b326-ee7ad612e8ca",
  "reversal_amount": 147.00,
  "reversal_reason": "client_request",
  "reversal_message": "Mensagem Pix da Devolução"
}

Request Body

Field	Type	Description	Characters
request_control_key *	string	Uniqueness key for the request (UUIDv4)	36
reversal_amount *	number	Refund amount	11
reversal_reason *	string	Reason for the refund	Enumerator reversal_reason
reversal_message	string	Refund message	140

Enumerator reversal_reason

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

Response

Response Body

Field	Type	Description	Characters
reversal_status	string	Enumerator for the reversal transaction status. Can be 'pending', 'sent', or 'rejected'	36
transfer_amount	number	Refund transfer amount	11
pix_transfer_key	string	Key of the executed Pix transaction for the refund (UUIDv4)	36
end_to_end_id	string	Idempotency key of a Pix transaction within the SPI (Instant Payment System)	32
request_control_key	string	Unique identification key for the client's request (UUIDv4)	36
created_at	string	Date and time of the refund	---

STATUS

201 created

Response Body: Reversão Enviada

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

STATUS

202

Information

If a pix_transfer_status is returned in the pending state, the Pix request should not be retried. This transfer will be reprocessed. It is necessary to check the transfer status through the pix transfer query.

Response Body: Reversal pending

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

STATUS

4XX

Response Body: Reversal rejected

{
  "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": "E32402502202407112211Id9JbxoaiTf",
      "pix_transfer_status": "rejected",
      "created_at": "2021-10-22T20:30:23.459Z"
    }
  }
}

STATUS

400

Information

In addition to the errors listed below, the Pix refund may encounter other errors established in Pix Transaction.

HTTP Code	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