Consulta recuperação de valores

Quando tiver 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.

Consulta detalhes de uma recuperação de valores

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

[GET] funds-recovery/(fundsRecoveryId)

Para fazer a consulta basta chamar o endpoint e informar como parâmetro o identificador único da recuperação de valor

Exemplo de sucesso

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

Response de erro

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

Tabela de apoio

campo	obrigatoriedade	tipo	padrão / Enum / Detalhes	descrição
flowType	Obrigatório	string	Enum: "AUTOMATED"	Tipo de fluxo de trabalho.
rootEndToEnd	Obrigatório	string	(32 caracteres alfanuméricos)	Transação Raiz reportada como fraudulenta.
situationType	Obrigatório	string	Enum: "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN"	Tipo de situação que deu origem à Recuperação de Valores.
reportDetails	Opcional	string	Max. 2000 caracteres. Obrigatório se situationType = "OTHER".	Detalhes para ajudar na análise do PSP contraparte.
contactInformation	Obrigatório	object	-	Informações de contato do PSP participante criador do registro.
trackingGraphParameters	Opcional	object	Não deve ser preenchido se FlowType = "INTERACTIVE".	Parâmetros de geração do Grafo de Rastreamento.

contactInformation

campo	obrigatoriedade	tipo	Restrições/Detalhes
email	Obrigatório	string	Deve seguir um padrão de e-mail. E-mail para contato.
phone	Obrigatório	string	Padrão: (Ex: +5511987654321). Telefone para contato.

TrackingGraphParameters

campo	tipo	padrão (Default)	descrição
minTransactionAmount	number	Default: "200.00"	Valor mínimo da transação para ser considerada e incluída no grafo de rastreamento.
maxTransactions	integer	Default: 500	Número máximo de transações que o sistema deve rastrear.
hopWindow	string	Default: "PT24H"	Janela de tempo (duração) máxima permitida entre a entrada de um valor em uma conta e sua saída para ser considerada como parte do fluxo fraudulento. (PT24H = 24 horas).
maxHops	integer	Max: 10 / Default: 5	Profundidade máxima do grafo de rastreamento, ou seja, quantas "camadas" de contas o dinheiro pode passar a partir da transação raiz.

Updated 24 days ago