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

Campo	Tipo	Descrição	Caracteres
`account_key` *	uuidv4	Chave única de identificação da conta.	36
`pix_transfer_key` *	uuidv4	Chave ú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",
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

Request Params

Campo	Tipo	Descrição	Caracteres
`request_control_key` *	uuidv4	Chave de unicidade da requisição.	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
`tfa_info`*	Object	Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato.	Objeto tfa_info

Enumerador reversal_reason

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

Objeto tfa_info

Campo	Tipo	Descrição	Caracteres
`approver_document_number`*	string	Número de documento da pessoa aprovadora da conta.	11
`contact_type`*	string	Forma de contato com a pessoa aprovadora da conta, podendo ser sms ou email

Response

STATUS

202

Response Body: Reversão Requisitada

{
  "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

Campo	Tipo	Descrição	Caracteres
`reversal_status`	enumerator	Enumerador de status da transação de devolução.	Enumerador reversal_status
`transfer_amount`	number	Valor da transferência de devolução.	11
`pix_transfer_key`	uuidv4	Chave da transação pix executada na devolução.	36
`request_control_key`	uuidv4	Chave única de identificação da request utilizada pelo cliente.	36
`created_at`	string	Data e hora da devolução.	10

Enumerador reversal_status

Enumerador	Descrição
sent	Transferência Pix realizada com sucesso.
pending	Transferência Pix pendente.
pending_2fa_approval	Transferência Pix pendente de aprovação por dois fatores
rejected	Transferê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",
      "end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
      "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`
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

Solicitar a devolução de um Pix recebido

Request​

Path Params​

Request Params​

Enumerador reversal_reason​

Objeto tfa_info​

Response​

Response Body​

Enumerador reversal_status​