Estados e resultados | Documentação da Raims

Interprete os estados de cobranças, estornos e contestações sem confundir andamento e resultado financeiro.

Um estado informa o andamento de um recurso. Um motivo explica uma condição registrada, e um resultado descreve a conclusão de uma análise. Confira qual desses campos está sendo apresentado: eles não são intercambiáveis.

Estados da cobrança

Na API, status da cobrança usa os códigos abaixo. O histórico também pode conter estados de meios que não estão disponíveis para novas cobranças.

Código ou valor	Significado	Como interpretar
`0`	Criada	Cobrança cadastrada, sem pagamento confirmado. Poder pagar depende do vencimento, dos meios habilitados e dos dados de pagamento disponíveis.
`1`	Aguardando pagamento	Cobrança que aguarda confirmação do pagamento. Ter aberto o checkout ou emitido Pix ou boleto não confirma o recebimento.
`2`	Autorizada	Pagamento autorizado, ainda sem confirmação de conclusão. Não entregue o produto nem considere o valor recebido apenas com base neste estado.
`3`	Em processamento	Pagamento em processamento, ainda sem resultado final. Acompanhe a cobrança existente antes de solicitar outro pagamento.
`4`	Paga	Pagamento da cobrança confirmado. Tarifas, bloqueios e devoluções são informações separadas e podem afetar o valor disponível para movimentação.
`5`	Parcialmente devolvida	Parte do valor recebido foi devolvida. Consulte o histórico e a elegibilidade de estorno para conhecer o valor restante que pode ser solicitado.
`6`	Devolvida	O valor recebido foi devolvido integralmente. A devolução pode resultar de mais de um lançamento; consulte os vínculos e o histórico para conciliá-la.
`7`	Cancelada	Cobrança cancelada para novos pagamentos. Cancelar uma cobrança não é o mesmo que devolver um pagamento recebido.
`8`	Expirada	O prazo de pagamento terminou. Esse estado não comprova baixa bancária: confira a cobrança e o boleto antes de concluir que houve cancelamento.
`9`	Com falha	A cobrança ou seu pagamento terminou com falha. Confira os detalhes disponíveis antes de solicitar outra cobrança; este estado não confirma recebimento.
`10`	Contestada	O pagamento está associado a uma contestação. Consulte o caso para conhecer a etapa, os valores e as informações disponíveis.
`11`	Contestação em análise	A contestação está sendo analisada. O resultado e o eventual efeito financeiro ainda precisam ser consultados no caso e no extrato.
`12`	Contestação perdida	A contestação teve resultado desfavorável à empresa. Consulte os valores informados no caso e os lançamentos relacionados para apurar o efeito financeiro.
`13`	Contestação ganha	A decisão foi favorável à empresa. Confira saldo e lançamentos: este estado não informa quando o valor bloqueado ficou disponível.

Autorização, emissão de dados de pagamento e processamento não confirmam que a cobrança está paga. Uma cobrança expirada não comprova que um boleto emitido foi cancelado. Consulte Cobranças para as ações disponíveis e as condições de cada requisição.

Estados do estorno

status de um estorno na API é um texto. Ele não usa a numeração do estado da cobrança. Acompanhe o mesmo identificador rf_ para saber o resultado.

Código ou valor	Significado	Como interpretar
`reserved`	Solicitada	A solicitação de estorno foi registrada, mas a devolução ainda não foi confirmada. Acompanhe esse mesmo estorno antes de fazer outro pedido.
`accepted`	Aceita para processamento	O pedido foi aceito e aguarda o resultado final. O aceite não confirma que o dinheiro voltou ao pagador.
`completed`	Concluída	A devolução foi confirmada. Confira o valor do estorno e os lançamentos relacionados para conciliá-la.
`failed`	Com falha	A falha do estorno foi confirmada. Consulte o motivo, os demais estornos da cobrança e a elegibilidade antes de uma nova solicitação.
`unknown`	Aguardando confirmação	O resultado da devolução ainda não foi confirmado. Continue consultando a mesma solicitação; este estado não deve ser tratado como falha nem como devolução concluída.

Uma falha de conexão não significa que o pedido falhou. Confira a solicitação e o histórico da cobrança antes de tentar novamente. No Sandbox, uma devolução confirmada corresponde à simulação; ela não movimenta dinheiro real.

Motivos de falha do estorno

failure_reason.code informa uma causa pública de falha confirmada. Nos demais estados, failure_reason é null.

Código ou valor	Significado	Como interpretar
`REFUND_NOT_SUBMITTED`	Pedido não enviado	Esse estorno não foi enviado para processamento. Confira o histórico e a elegibilidade da cobrança antes de solicitar novamente.
`REFUND_REJECTED`	Pedido recusado	A solicitação de estorno foi recusada. Consulte os estornos da cobrança antes de uma nova tentativa.
`REFUND_PROCESSING_UNAVAILABLE`	Processamento indisponível	O processamento estava indisponível e esse estorno terminou com falha. Confira a cobrança e sua elegibilidade antes de outro pedido.
`REFUND_PROCESSING_FAILED`	Falha de processamento confirmada	A falha da devolução foi confirmada, sem um motivo mais detalhado. Consulte os estornos da cobrança antes de tentar novamente.
`REFUND_FAILURE_REASON_UNAVAILABLE`	Motivo não informado	Não há um motivo confirmado disponível para a falha desse estorno. Consulte o histórico e entre em contato com o atendimento se precisar esclarecer o resultado.

Use o código para tratar a resposta. A mensagem explica o problema e pode ser melhorada sem alterar o significado do código. A falta de causa detalhada não autoriza presumir recusa do banco ou solicitar outra devolução automaticamente.

Tipos de contestação

O campo kind é necessário para interpretar os motivos e resultados.

Código ou valor	Significado	Como interpretar
`chargeback`	Contestação de pagamento	Identifica o histórico de contestações classificado como chargeback. Interprete o motivo usando o catálogo dessa categoria; o nome não confirma que cartão está habilitado para novas cobranças.
`med`	Contestação Pix (MED)	Identifica um caso do Mecanismo Especial de Devolução do Pix. Consulte a etapa, o motivo e os resultados da análise; a existência do caso não confirma devolução nem fraude.

O nome chargeback não comprova que cartões estejam disponíveis para novas cobranças na Raims. Ele identifica a categoria do registro consultado.

Etapas da contestação

O campo público stage informa o acompanhamento da contestação:

Código ou valor	Significado	Como interpretar
`open`	Aberta	A contestação foi registrada e ainda não tem análise confirmada. Confira as informações e os prazos apresentados no caso.
`in_analysis`	Em análise	A contestação está em análise. Ainda não há, por essa etapa, confirmação de resultado ou devolução.
`refund_in_analysis`	Devolução em análise	A análise de uma possível devolução está em andamento. Consulte o resultado e o valor devolvido quando informados; essa etapa não comprova saída de dinheiro.
`closed`	Encerrada	O acompanhamento da análise foi encerrado. Leia os resultados e os valores informados no caso: encerramento, sozinho, não significa vitória, perda ou devolução.
`cancelled`	Cancelada	A contestação foi cancelada. A etapa não confirma uma devolução nem a liberação de saldo; confira os valores e o extrato.
`rejected`	Abertura rejeitada	A solicitação de abertura da contestação foi rejeitada. Confira os detalhes disponíveis; esse resultado não é uma devolução ao pagador.
`failed`	Com falha	O processamento da contestação não foi concluído devido a uma falha. Consulte o caso e o atendimento se precisar esclarecer o resultado.

closed informa encerramento da análise. Não significa, sozinho, decisão favorável à empresa ou devolução de dinheiro. Confira os resultados e valores disponíveis no detalhe da contestação.

Motivos relatados no MED

Quando kind é med, interprete reason_code por esta tabela. O motivo é o relato apresentado na contestação, não uma conclusão de fraude.

Código ou valor	Significado	Como interpretar
`1`	Relato de golpe	O reclamante relatou que o pagamento está ligado a um golpe. A categoria registra o motivo da contestação e não confirma que houve fraude.
`2`	Relato de conta invadida	O reclamante relatou uso da conta por outra pessoa sem autorização. A conclusão depende da análise do caso.
`3`	Relato de coação	O reclamante informou que fez o pagamento sob coação. Consulte os resultados da análise para conhecer a conclusão do caso.
`4`	Relato de acesso fraudulento	A contestação informa suspeita de acesso fraudulento relacionado ao pagamento. O motivo relatado não equivale a fraude comprovada.
`5`	Outro motivo	O motivo foi classificado fora das demais categorias. Consulte os detalhes da reclamação quando disponíveis.
`6`	Motivo não reconhecido	O motivo recebido não corresponde a uma categoria reconhecida neste catálogo. Não deduza a causa pelo código; consulte os detalhes disponíveis no caso.

Motivos de outras contestações

Quando kind é chargeback, reason_code usa esta outra tabela. O mesmo número pode ter outro significado em um caso MED.

Código ou valor	Significado	Como interpretar
`1`	Fraude alegada	A contestação foi registrada com alegação de fraude. O motivo não substitui o resultado da análise.
`2`	Compra não reconhecida	O reclamante informou que não reconhece a compra. Consulte os detalhes e o resultado do caso.
`3`	Serviço não reconhecido	O reclamante informou que não reconhece o serviço cobrado. A categoria registra a alegação e não define o resultado da contestação.
`4`	Produto ou serviço divergente	O reclamante relatou divergência no produto ou serviço. Consulte os detalhes do caso para entender a reclamação.
`5`	Cobrança indevida	O reclamante alegou cobrança indevida. A conclusão e o eventual efeito financeiro dependem do resultado informado no caso.
`6`	Outro motivo	A contestação usa um motivo fora das demais categorias. Consulte os detalhes disponíveis; não interprete esse valor como o motivo equivalente de um caso MED.

Um motivo null não está disponível para apresentação. Não preencha esse campo com uma causa deduzida pelo valor, pela data ou pelo tipo de pagamento.

Resultados de análise no MED

infraction_result informa o resultado da análise da infração:

Código ou valor	Significado	Como interpretar
`agreed`	Infração reconhecida	A análise reconheceu a infração relatada. Esse resultado não confirma devolução; consulte o resultado da análise de devolução e o valor efetivamente devolvido.
`disagreed`	Infração não reconhecida	A análise não reconheceu a infração relatada. Consulte os demais resultados e valores disponíveis para entender o desfecho do caso.

refund_result informa o resultado da análise do pedido de devolução:

Código ou valor	Significado	Como interpretar
`partially_accepted`	Devolução parcialmente aceita	A análise aceitou devolver parte do valor solicitado. Confira o valor efetivamente devolvido; o aceite não comprova, sozinho, a movimentação do dinheiro.
`totally_accepted`	Devolução integralmente aceita	A análise aceitou a devolução integral solicitada. Consulte o valor devolvido e o extrato para confirmar o efeito financeiro.
`rejected`	Devolução rejeitada	A análise rejeitou a devolução solicitada. Confira o caso e os lançamentos relacionados para conciliar os valores, inclusive eventuais bloqueios ou liberações.

O reconhecimento da infração e o aceite de um pedido não confirmam, sozinhos, que o dinheiro foi devolvido. refunded_amount_cents informa o total de devoluções confirmadas do caso quando esse dado está disponível. Um resultado null permanece diferente de uma recusa ou de um valor zero confirmado.

Motivos de perda da contestação

loss_reason_code, quando informado, descreve o motivo registrado para a decisão desfavorável. Uma observação pode complementar esse código.

Código ou valor	Significado	Como interpretar
`1`	Prazo de resposta encerrado	O motivo registrado para a perda foi o encerramento do prazo de resposta. Consulte as datas e o resultado do caso.
`2`	Evidências insuficientes	As evidências apresentadas foram consideradas insuficientes para a contestação. Consulte os detalhes disponíveis no caso.
`3`	Documentação inválida	A documentação apresentada não foi aceita na análise. Consulte os detalhes do caso para entender o resultado informado.
`4`	Decisão final	A perda foi registrada com base na decisão final da análise. Confira os valores do caso e o extrato para identificar o efeito financeiro.
`5`	Outro motivo de perda	A perda tem um motivo diferente das demais categorias. Consulte a observação do motivo quando disponível; a ausência de observação não permite inferir uma causa.

Esses motivos não substituem a leitura da etapa e do resultado do caso. Consulte Contestações para acompanhar os dados disponíveis sem confundir análise, decisão e movimentação financeira.