Incluir Marcacao de Fraude

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente utiliza essa API para iniciar um processo de Marcacao de Fraude .

As marcações de fraude são utilizadas para fins de segurança do Pix, sensibilizando contadores de estatísticas que podem ser obtidos por pessoa (CPF/CNPJ) ou por chave.

Sempre que identificada uma transação fraudulenta que possua chave Pix, a mesma deve ser indicada na requisição desta API, para também receber a marcação de fraude, além do CPF ou CNPJ da transação.

Como utilizar?

Requisição de exemplo

Marcar Chave PIX como Fraude

post

Endpoint para marcar uma chave PIX como fraudulenta

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ispbstringRequired

ISPB da instituição financeira

Example: 11165756

personTypestring · enumRequired

Tipo de pessoa

Example: FISICAPossible values:

cpfCnpjnumberRequired

CPF ou CNPJ do titular da chave

Example: 12345678901

keystringOptional

Chave PIX a ser marcada como fraude (opcional)

Example: 12345678901

fraudTypestring · enumRequired

Tipo de fraude identificada

Example: CONTA_FRAUDADORPossible values:

Responses

200

Chave marcada como fraude com sucesso

No content

401

Falha de autorização

422

Falha de validação

500

Erro desconhecido no servidor

post

/internal/api/v1/keys/markFraud

HTTPcURLJavaScriptPython

POST /internal/api/v1/keys/markFraud HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "ispb": "11165756",
  "personType": "FISICA",
  "cpfCnpj": 12345678901,
  "key": "12345678901",
  "fraudType": "CONTA_FRAUDADOR"
}

No content

JSON Retorno Sucesso