Pular para o conteúdo principal

Consultar Solicitação de Devolução

Caso o Participante Indireto queira consultar as informações de uma Solicitação de Devolução, a rota abaixo o permite.

IMPORTANTE

O Banco Central do Brasil define que, dentro de um período de 1 dia do recebimento da Solicitação de Devolução pelo Participante Indireto, a Devolução precisa ser fechada.

Caso haja atraso por parte do Participante Indireto, a QI Tech irá fechar a Solicitação de Devolução, com o status de totally_accepted, a fim de que a instituição não seja penalizada pelo Banco Central do Brasil.

Request

ENDPOINT
/pix/refund_request/REFUND_REQUEST_KEY
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
refund_request_keystringUUID4 da devolução.36

Response

STATUS
200
Response Body
{
"refund_request_key": "47633091-7d44-4d10-9d00-1f937104e537",
"pix_transfer_key": "2bcbfd65-8660-4cb0-8ae4-4c4b327b32be",
"end_to_end_id": "E73856642202407011350E8cnA3Ae7r3",
"requested_amount": 10,
"refund_request_status": "closed",
"refund_request_type": "operational_flaw",
"infraction_report_key": null,
"refund_request_details": "Foi identificada uma fraude na transação.",
"requesting_participant": "73856642",
"contested_participant": "99999999",
"analysis_result": "rejected",
"analysis_details": null,
"reject_reason": "account_closure",
"refund_transfer_key": null,
"refunded_amount": 0.00,
"refund_request_direction": "outgoing",
"created_at": "2024-07-01T13:50:30Z",
"refund_events": [
{
"event_type": "open",
"event_details": "Solicitação de Devolução criada pelo participante indireto",
"created_at": "2024-07-01T13:50:30Z"
},
{
"event_type": "closed",
"event_details": "Requisição de devolução fechado pela outra instituição financeira, com status REJEITADO",
"created_at": "2024-07-01T14:02:55Z"
}
]
}

Body Params

CampoTipoDescriçãoCaracteres
pix_transfer_key*stringIdentificador único da transação PIX.36
refund_request_key*stringIdentificador único da devolução.36
infraction_report_key*stringIdentificador único da infração relacionada à devolução. Somente quando o tipo for FRAUDE36
refund_request_typeenumTipo de solicitação de devolução.Enumeradores refund_request_type
requested_amount*floatValor da devolução-
refund_request_status*enumStatus .Enumeradores refund_request_status
contested_participant*stringISPB do Participante Creditado (Contestado).8
requesting_participant*stringISPB do Participante Debitado (Requisitante, o qual está pedindo a devolução).8
refund_request_details*stringDetalhes da devolução.-
analysis_result*enumResultado da análise de fechamento da devolução.Enumeradores analysis_result
analysis_details*stringDetalhes da análise de fechamento da devolução.-
reject_reason*stringMotivo da rejeição da devolução, caso seja fechada com REJECTED.Enumeradores reject_reason
refund_transfer_key*stringpix_transfer_key da transação de devolução, caso seja fechada com aceite.-
refunded_amount*floatValor devolvido na transação de devolução.-
refund_events*objectObjeto eventos de pedido de devolução.Objeto refund_events
refund_request_direction*stringDireção da solicitação de devolução.Enumeradores refund_request_direction
created_at *stringData de criação da Solicitação de Devolução24

Enumeradores refund_request_status

CampoDescrição
openSolicitação de Devolução foi criada e está aberta no BACEN.
cancelledSolicitação de Devolução está cancelada no BACEN
closedSolicitação de Devolução está fechada no BACEN

Enumeradores refund_request_type

CampoDescrição
fraudSolicitação de Devolução originada de uma fraude.
operational_flawSolicitação de Devolução originada de um erro interno.

Enumeradores analysis_result

CampoDescrição
totally_acceptedSolicitação de Devolução foi totalmente aceita.
partially_acceptedSolicitação de Devolução foi parcialmente aceita;
rejectedSolicitação de Devolução foi rejeitada.

Enumeradores reject_reason

CampoDescrição
no_balanceConta não possui saldo para realizar a devolução.
account_closureConta se encontra fechada e, portanto, não é possível realizar a devolução
otherOutro motivo

Enumeradores refund_request_direction

CampoDescrição
outgoingParticipante é originador do pedido de devolução.
incomingParticipante é o alvo do pedido de devolução

Objetos refund_events

CampoDescrição
event_typeTipo do evento de mudança da devolução. Enumeradores refund_request_status
event_detailsDetalhes acerca do evento.
created_atData de criação do evento.