Pular para o conteúdo principal

Solicitar a devolução de um Pix recebido

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

Request

ENDPOINT
/account/ACCOUNT_KEY/pix_transfer/PIX_TRANSFER_KEY/reversal
MÉTODO
POST

Path Params

CampoTipoDescriçãoCaracteres
account_key *uuidv4Chave única de identificação da conta.36
pix_transfer_key *uuidv4Chave única de identificação da transferência Pix no sistema QI.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"
}

Request Body

CampoTipoDescriçãoCaracteres
request_control_key *uuidv4Chave de unicidade da requisição.36
reversal_amount *numberValor da devolução.11
reversal_reason *stringMotivo da devolução.Enumerador reversal_reason
reversal_messagestringMensagem da devolução.140

Enumerador reversal_reason

EnumeradorDescrição
client_requestCaso tenha sido requerido pelo dono da conta.
reconciliationPara reconciliação devido a erro operacional.

Response

STATUS
201
Response Body: Reversão Enviada
{
"reversal_status": "sent",
"transfer_amount": 147,
"pix_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48",
"request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
"created_at": "2021-10-22T20:30:23.459Z"
}
STATUS
202
Response Body: Reversão Pendente
{
"reversal_status": "pending",
"transfer_amount": 147,
"pix_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48",
"request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
"created_at": "2021-10-22T20:30:23.459Z"
}
Informação

Caso seja retornado HTTP Status 202 com o campo pix_transfer_status com valor 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

CampoTipoDescriçãoCaracteres
reversal_statusenumeratorEnumerador de status da transação de devolução.Enumerador reversal_status
transfer_amountnumberValor da transferência de devolução.11
pix_transfer_keyuuidv4Chave da transação pix executada na devolução.36
request_control_keyuuidv4Chave única de identificação da request utilizada pelo cliente.36
created_atstringData e hora da devolução.10

Enumerador reversal_status

EnumeradorDescrição
sentTransferência Pix realizada com sucesso.
pendingTransferência Pix pendente.
rejectedTransferência Pix rejeitada.
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",
"pix_transfer_status": "rejected",
"created_at": "2021-10-22T20:30:23.459Z"
}
}
}
Informação

Além dos erros anteriormente listados para transferência Pix, a devolução de um Pix também pode retornar os erros listados abaixo.

Código HTTP
status
Código QI
code
Título
title
Descrição (eng)
description
Descrição (ptbr)
translation
400QIT000001Bad RequestSchema ErrorErro de Schema
404PXT000018Reversal Original Transfer not FoundReversal original pix transfer not found.Transferência original da devolução não foi encontrada.
400PXT000017Reversal Too GreatReversal 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.
400PXT000015Reversal date expiredReversal original transaction is older than 90 daysA data de criação da transação original é mais antiga que 90 dias
400PXT0000127Invalid Reversal ReasonReversal reason {reversal_reason} is not validRazão de reversão {reversal_reason} não é válida