Farol de Crédito

API Farol de Crédito

A API Farol de Crédito tem como objetivo possibilitar que o fornecedor integrado consulte informações presentes no Farol de Crédito do portal Blu via API.

Orientações

• Para ter acesso aos dados, é necessário um token

Esse token é disponibilizado pelo time de Integração da Blu, quando solicitado pelo executivo de contas.

API Farol de Crédito

GET https://api.blu.com.br/b2b/credit_light

Objetivo

Possibilitar aos nossos fornecedores acessar as informações relativas ao Farol de Crédito

Fique atento! para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.

Query Parameters

Name	Type	Description
cpfCnpj*	string	Obrigatório. Deve ser preenchido com CNPJ ou CPF do varejista que deseja ser consultado.

Headers

Name	Type	Description
Authorization*	string	Token de operação.

200: OK

```json
[
    {
        "charged_blu_client": true,
        "charged_cpf_cnpj": "00.000.000/0000-00",
        "charged_name": "Nome do Lojista",
        "charged_type": "xxxxxxxx",
        "status_bms": "xxxxxxxx",
        "charged_network_monthly_sales": "R$ 00",
        "charged_monthly_sales_estimate": {
            "minimum": "R$ 00",
            "maximum": "R$ 00"
        },
        "charged_collateral_quality": "xxxxxxxxxxxxxx"
    },
    ...
]

422: CPF/CNPJ inválido

{
    "message": "CPF/CNPJ inválido"
}

401: Token inválido

{
    "message": {
        "token": [
            "Usuário não encontrado."
        ]
    }
}

O retorno da Opções de Recebimento PagBlu Flex é um arquivo JSON, contendo as informações sobre as opções de recebimento cadastradas no portal Blu. Abaixo vemos todos os campos que serão retornados:

Campo	Tipo	Valores	Descrição
charged_blu_client	boolean	true/false	Retorna se o cliente é Blu
charged_cpf_cnpj	string	“00.000.000/0000-00“	CPF/CNPJ do lojista
charged_name	string		Nome fantasia do lojista
charged_type	string	branch/headquarter	Informa se o lojista é filial(branch) ou matriz(headquarter)
status_bms	string	indicar/pendente/ativo/ em desativação/ inativo	Status de indicação se o lojista usa o Boleto Mais Seguro
charged_network_monthly_sales	string		Média da rede de lojas
charged_monthly_sales_estimate	objeto	minimum maximum	Mínimo e Máximo da loja em especifica
charged_collateral_quality	string	Sem potencial/ Baixo potencial /Alto potencial	Identifica qual o nível de potencial de pagamento do lojista

O cURL para executar a consulta é o exibido abaixo:

cURL

curl --location 'https://api.blu.com.br/b2b/credit_light?cpfCnpj=############' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json'

NodeJs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.blu.com.br/b2b/credit_light?cpfCnpj=############',
  'headers': {
    'Authorization': 'Bearer XXXXXXXXXXXXXXXXXXXXXXX'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

572B

API Farol de Crédito.postman_collection.zip

archive

572B

API Farol de Crédito.postman_collection.zip

archive