First Payment DefaultBETA

Última atualização: 11 de Fevereiro de 2020

Introdução

O FPD Score é a combinação do mais completo score de fraude com o único score digital de crédito do mercado.

Autenticação

Todas as requisições submetidas à nossa API devem ser realizadas através de um token de 2048 caracteres.

O token é gerado através de um usuário e senha que devem ser fornecidos pela ClearSale.

Entre em contato com o seu consultor de vendas para maiores informações.

Na autenticação, além do token retornamos seu tempo de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nesse tempo de expiração.

Para o recebimento desse dado é necessário que reserve um espaço de 2048 caracteres. Só gere um novo token após a expiração do seu token atual.

Requisição
POST https://productsapi.clearsale.com.br/v1/authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}
POST https://hmlproductsapi.clearsale.com.br/v1/authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "Token": "{Valor do Token}",
    "ExpiresInSeconds": "{Tempo de Expiração do Token}"
}
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "errors": {
        "ExampleProperty": [
            "error description."
        ],
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "error title.",
    "status": 400,
    "traceId": "automatically generate id"
}
HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8
{
    "message": "Username or Password is incorrect"
}

Transação

Envio

Este método é utilizado para fazer o envio de uma transação no Score FPD.

Requisição
POST https://api.clearsale.com.br/products/v1/first-payment-default HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "OrderId": "1452291", (opcional)
    "Document": "12345678912", (obrigatório)
    "ReferenceDate": "2019-12-01", (opcional)
    "AreaCode": "11",  (obrigatório)
    "Phone":​ "123456789",  (obrigatório)
    "Email": "joao.silva@email.com.br", (obrigatório) 
    "SessionID": "SessionID123",  (opcional)
    "ZipCode": "00000000",  (obrigatório)
}
POST https://homologacao.clearsale.com.br/api/products/v1/first-payment-default HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "OrderId": "1452291", (opcional)
    "Document": "12345678912", (obrigatório)
    "ReferenceDate": "2019-12-01", (opcional)
    "AreaCode": "11",  (obrigatório)
    "Phone":​ "123456789",  (obrigatório)
    "Email": "joao.silva@email.com.br", (obrigatório) 
    "SessionID": "SessionID123",  (opcional)
    "ZipCode": "00000000",  (obrigatório)
}
Resposta

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "Id": 115446, //ID da transação
    "OrderId": "1452291", //código da transação do cliente
    "Document": "42371735088", //CPF
    "CreationDate": "2019-11-03", //data da consulta
    "AreaCode": "11", // DDD do telefone 
    "Phone": "123456789", // numero de telefone celular 
    "Email": "joao.silva@email.com.br", // e-mail 
    "SessionID": "SessionID123", // Device 
    "ZipCode" "00000000", // CEP 
    "Results":{
        "Level": "high",  // Matriz FPD
        "CreditScore": "800", // Score de crédito 
        "FraudScore": "100" // Score de fraude
    }
}

Consulta

Este método é utilizado para buscar informações de uma transação no FPD Score.

Requisição
GET https://api.clearsale.com.br/products/v1/first-payment-default/{transactionId} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
GET https://homologacao.clearsale.com.br/api/products/v1/first-payment-default/{transactionId} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "Id": 115446, //ID da transação
    "OrderId": 123932, //código da transação do cliente
    "Document": "42371735088", //CPF
    "CreationDate": "2019-11-03", //data da consulta
    "AreaCode": "11", // DDD do telefone 
    "Phone": "123456789", // numero de telefone celular 
    "Email": "joao.silva@email.com.br", // e-mail 
    "SessionID": "SessionID123", // Device 
    "ZipCode" "00000000", // CEP 
    "Results":{
        "Level": "high",  // Matriz FPD
        "CreditScore": "800", // Score de crédito 
        "FraudScore": "100" // Score de fraude
    }
}

Dicionário de variáveis

Transaction

Nome Descrição Tipo Tamanho Obrigatório
Document Cpf para consulta String 11 Sim
OrderId Código do pedido inserido pelo cliente para controle String 30 Não
ReferenceDate Data de referência para realizar consulta DateTime - Não
AreaCode Código de área do celular do cliente String 2 Sim
Phone Telefone celular String 9 Sim
Email Email do cliente String 320 Sim
SessionID Chave do device do cliente String 200 Não
ZipCode CEP String 8 Sim

Results

Nome Descrição Tipo Tamanho
Id Código da transação Int -
OrderId Código do pedido inserido pelo cliente para controle String 30
Document Cpf consultado String 11
ReferenceDate Data de referência consultada DateTime -
CreationDate Data de criação da transação DateTime -
AreaCode Código de área do celular do cliente String 2
Phone Telefone celular String 9
Email Email do cliente String 320
SessionID Chave do device do cliente String 200
ZipCode CEP String 8
Results Resultados da transação {Level,CreditScore,FraudScore} Object -
Level Nível de risco de FPD String "High", "Medium" ou "Low"
CreditScore Score de crédito int 4
FraudScore Score de fraude int 4

Matriz de FPD

Baixe o arquivo para visualizar a matriz de FPD

XLSX