Todas as APIs do CreditallPay foram desenvolvidas seguindo os atuais padrões técnicos de mercado. Tudo isso para que a experiência na hora da integração seja a mais fácil possível. Todas as URLs são amigáveis e orientadas a recursos e utilizam os padrões do protocolo HTTP como autenticação, verbos e códigos de retorno. Isso permite que APIs possam ser utilizadas por clientes HTTP já existentes. Todas as respostas são retornadas no formato JSON.
Atenção: Todos os testes devem ser realizados na área de "homologação", teste realizado na área "Produção" pode prejudicar a operação ou causando divergências com a operações verdadeiras executadas dentro do sistema.
Method Envio: post
Ambiente | URL |
---|---|
Homologação | http://dev.siscredit.com.br/apiwebv2h/ |
Produção | https://www.siscredit.com.br/apiwebv2/ |
Parâmetro | Descrição |
---|---|
token * | A chave de acesso informada pela Creditall ao solicitar integração. |
login * | Código de acesso ao sistema Creditall . |
cpfcnpj* | Informar CPF ou CNPJ ex(cpf->12312312300 cnpj->99000999000901) | cep | Cep do documento consultado |
referencia | Numero de pedido/controle para o seu controle interno ex(Ped12345) |
produto * | Informe tipo 1-Compras a Crédito 2-Compras com Cheque |
codconsulta * | Código da Consulta a ser realizada 1- MOSAICO PERFIL+ 2- MOSAICO PERFIL FULL 3- MOSAICO PADRAO 4- MOSAICO COMPLETO 5- MOSAICO FULL 6- MOSAICO MAX |
cmc7 | CMC7 do Cheque. Informar quando tipo produto for (2-Compras com Cheque) |
clientedesde | Data Cliente Desde do Cheque. Informar quando tipo produto for (2-Compras com Cheque) |
Retorno: Json
{
"resultado": {
"success": "true",
"referencia": "Ped12345",
"cpfcnpj": "12312312300",
"situacao": "REGULAR",
"data_situacao": "11/03/2020",
"nome": "JOAO PEDRO GOMES RIBEIRO FILHO",
"mae": "MARIA DO ROSARIO RIBEIRO",
"data_nascimento": "REGULAR",
"linkviewer": "https://www.siscredit.com.br/apiwebv2/?ref=mosaico&cod=2c59B54697HX665a"
},
"composicao": {
"perfil": "ALTÍSSIMA PROBABILIDADE DE RESTRIÇÃO. HÁ MENOS DE 30 DIAS",
"classificacao_risco": "BAIXÍSSIMO RISCO",
"risco": "9.87",
"probabilidade_endividamento": "BAIXÍSSIMO RISCO",
"anotacao_restritiva": "520 a 180 dias",
"situacao": "APROVADO",
"limite_maximo": "1195,43",
"limite_parcela": "239,09",
"limite_segmento": "8000,00"
},
"debitos": [
{
"origem": "SP",
"data_inclusao": "02/09/2020",
"data_atraso": "02/09/2020",
"valor": "325,57",
"documento": "FAT555559 ",
"razao_social": "ADMTOP CARTOES SA ",
"cidade": " SCPC SAO PAULO "
},
{
"origem": "SP",
"data_inclusao": "21/06/2019",
"data_atraso": "21/06/2019",
"valor": "182,14",
"documento": "d8299990000CT ",
"razao_social": "BANCO BRADESCO S/A ",
"cidade": " SCPC SAO PAULO "
}
]
}
retorno com Sucesso
{
"resultado": {
"success": "false",
},
"aviso": [
{
"mensagem": "TOKEN INVALIDO ",
}
]
}
retorno com Alerta