Efetuar devolução de um Pix

A devolução de um Pix pode ser efetuada em até 90 dias a partir de seu recebimento.

Request

ENDPOINT

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

MÉTODO

POST

Request Path Params

Campo	Tipo	Descrição	Caracteres
account_key	string	Chave única da conta (UUIDv4)	36
alias_key	string	Chave única do alias (UUIDv4)	36
pix_transfer_key	string	chave de identificação da transferência Pix no sistema QI (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

Campo	Tipo	Descrição	Caracteres
request_control_key*	string	Chave de unicidade da requisição (UUIDv4)	36
reversal_amount*	number	Valor da devolução	11
reversal_reason*	string	Motivo da devolução	Enumerador reversal_reason
reversal_message	string	Mensagem da devolução	140

Enumerador reversal_reason

Enumerador	Descrição
client_request	Caso tenha sido requerido pelo dono da conta
reconciliation	Para reconciliação devido a erro operacional

Response

Response Body

Campo	Tipo	Descrição	Caracteres
reversal_status	string	Enumerador de status da transação de devolução. Pode ser 'pending', 'sent' e 'rejected'	36
transfer_amount	number	Valor da transferência de devolução	11
pix_transfer_key	string	Chave da transação pix executada na devolução (UUIDv4)	36
end_to_end_id	string	Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo)	32
request_control_key	string	Chave única de identificação da request utilizada pelo cliente (UUIDv4)	36
created_at	string	Data e hora da devolução	---

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

Informação

Caso seja retornado uma pix_transfer_status no estado de pending, a solicitação de Pix não deve ser retentada. Esta transferência será reprocessada. É necessário verificar o status da transferência por meio da consulta de transferência pix.

Response Body: Reversão Pendente

{
  "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: Reversão Rejeitada

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "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

Informação

Além dos erros discriminados abaixo, a devolução pix pode receber como erro os demais estabelecidos em Transação Pix

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (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