Consultar recuperação de valores

Visão Geral

Quando houver uma recuperação de valores já criada e desejar obter detalhes e o status dela, poderá utilizar o endpoint de consulta de recuperação de valores.

Será possível consultar informações sobre os possíveis status:

CREATED- recuperação de valores criada.

TRACKED- grafo de rastreamento de transações criado.

AWAITING_ANALYSIS- notificações de infração geradas, análise pelos participantes recebedores em andamento.

ANALYSED- notificações de infração analisadas e fechadas.

REFUNDING- processo de devolução em andamento.

COMPLETED- recuperação de valores finalizada.

CANCELLED- recuperação de valores cancelada.

Além de informações da ultima atualização realizada na recuperação de valores e também detalhes do grafo de rastreio que foi criado.

📘

Quando uma solicitação encontra-se no estado "ANALYSED", significa que todas as análises já foram realizadas pelas Instituições financeiras do recebedor dessa recuperação de valores e que deve-se abrir uma solicitação de devolução em recuperação de valores, para recuperar algum valor da conta do fraudador e devolver para a vitima. Essa solicitação de devolução de valores em recuperação de valores, deve ser aberta em até 6h após a recuperação de valores estar no estado de ANALYSED, esse é o SLA é estabelecido pelo Banco Central.

Passos para Integrar

1. Consultar recuperação de valores - [API Reference]

Como realizar a consulta

É necessário ter o identificador da recuperação de valor que foi criada para conseguir fazer a consulta.

Dessa forma, basta chamar o endpoint [GET]
funds-recovery/(fundsRecoveryId) e informar como parâmetro o identificador único da recuperação de valor

Path Parameters

Exemplo de retorno

👍

Sucesso 200

{ 
  "status": 200,
  "version": "string",
  "body":{
    "fundsRecoveryId":"ca1b9c01-ff9e-4a58-90ab-d31512e15ce0",
    "status":"CREATED|TRACKED|AWAITING_ANALYSIS|ANALYSED|REFUNDING|COMPLETED|CANCELLED",
    "flowType":"AUTOMATED",
    "rootEndToEnd":"E9999901012341234123412345678900",
    "situationType":"SCAM",
    "reportDetails":"Transação feita através de QR Code falso em boleto",
    "contactInformation":{
      "email":"[email protected]",
      "phone":"+5561988887777"
    },
    "creationTime":"2020-01-17T10:00:00.000Z",
    "lastModified":"2020-01-17T10:00:00.000Z",
    "trackingGraph":{
      "minTransactionAmount":200.00,
      "maxTransactions":500,
      "hopWindow":"PT24H",
      "maxHops":10
    }
  }
}

Erros

❗

Error 400

{
  "status": 400,
  "version": "string",
  "error": {
    "errorCode": "string",
    "message": "string"
  }
}