1. Credenciais de acesso OAUTH2.
O cliente deverá solicitar a credenciais de acesso (client_id e client_secret) junto a assessoria de cobrança.
2. Requisição para obter token de acesso
Após o passo 1 as credenciais client_id e client_secret serão enviados para a empresa que solicitou o cadastro. Com
posse dessas informações uma requisição ao domínio da assessoria de cobrança deverá ser realizada para obtenção
do token de acesso seguindo as informações abaixo.
Estabelecer uma conexão com a URL: [Link] enviando uma requisição
(request) com as seguintes características:
- HTTP method = POST
- Content-type = application/x-www-form-urlencoded
Headers da requisição:
- Authorization = Basic encodeBase64(client_id:client_secret)
Exemplo:
Authorization = Basic
ZWI4MTkxNmYtOxrq23fvghvhntgWRQ0Yi00YjQ5LTk4ODEtM2M0OTJjYmM0YTk5OjcxY2VkNDljLTkxM
GEtNDg2MS04YjgxLWYzNmM5MWEyNmE3Yw==
Parâmetros/Body da requisição:
- grant_type = client_credentials (obrigatório)
O resultado da requisição possuirá os valores:
- access_token = Token de acesso contento as informações necessárias para validação do acesso
- token_type = bearer (token de portador)
- expires_in = Tempo para expiração do Token (em segundos)
Com estas informações já será possível realizar requisições para os endpoints de integração.
Exemplo usando a ferramenta Postman:
3. Endpoints da API de integração
Em posse das informações produzidas acima, deverá ser informado o token de acesso junto com o token_type em
um campo Authorization no cabeçalho de qualquer requisição para os endpoints referentes aos serviços.
Criar uma requisição para API:
- HTTP method: GET|POST [Link]
Headers da requisição:
- Authorization: Bearer <access_token>
- Parâmetros/Body da requisição: Informações necessárias para execução do serviço API
POST – Remessa: [Link]
Endpoint para cadastro de documentos/títulos para cobrança:
Descrição do Campo Tipo Observação
cnpjCpfDevedor Texto CNPJ/CPF do devedor
nomeDevedor Texto Nome do devedor
codigoDevedor Texto Código de interno no cliente
endereco Texto Endereço do devedor
bairro Texto Bairro do devedor
cidade Texto Cidade do devedor
uf Texto Estado do devedor
cep Número CEP do devedor (sem formatação)
telefones Objeto Objeto contendo uma lista de telefones
[Link] Texto Nome do contato
[Link] Texto DDD do Telefone
[Link] Texto Telefone do Contato
emails Objeto Objeto contendo uma lista de e-mails
[Link] Texto Nome do Contato
[Link] Texto E-mail do Contato
documento Texto Número do documento/título
parcela Texto Número da parcela do documento/título
especie Texto Espécie do documento/título (exemplo: DP, CH, NF)
dataEmissao Data Data de emissão do documento/título (formato: AAAA-MM-DD)
dataVencimento Data Data de vencimento do documento/ título (formato: AAAA-MM-DD)
valorDocumento Número Valor do documento/título
valorProtesto Número Valor do protesto do documento/título
observacao Texto Observação para o documento/título (opcional)
nomeRepresentante Texto Nome do Representante (opcional)
telefoneRepresentante Texto Fone do Representante (opcional)
dadosAdicionais Texto Texto livre (limite de 3000 caracteres) para controle do cliente, essa informação
não é validada pelo sistema e será retornado em todos os endpoints
relacionados a documentos/títulos
Retorno Tipo Todos os campos acimas serão retornados adicionados dos campos abaixo
situacao Texto Retorno da remessa (“ok”, “erro”)
descricao Número do processo gerado quando a situação estiver “ok”, ou no caso de erro
Texto
irá retornar à descrição do erro.
Exemplo: (status = 200, application/json):
Entrada
[
{
"cnpjCpfDevedor": "00000000000000",
"nomeDevedor": "Devedor para teste",
"codigoDevedor": "1234",
"endereco": "Rua endereço, 149",
"bairro": "Nome do Bairro",
"cidade": "Nome da Cidade",
"uf": "SC",
"cep": "89200000",
"telefones": [
{
"nomeContato": "Nome do Contato",
"ddd": "47",
"telefone": "999999999"
},
{
"nomeContato": "Nome do Contato",
"ddd": "47",
"telefone": "988888888"
}
],
"emails": [
{
"nomeContato": "Nome do Contato",
"email": "email@[Link]"
}
],
"documento": "123456",
"parcela": "01",
"especie": "DP",
"dataEmissao": "2022-01-01",
"dataVencimento": "2022-02-01",
"valorDocumento": 100.0,
"valorProtesto": 0.0,
"observacao": "Teste de Observação",
"nomeDoRepresentante": "Nome do Representante",
"telefoneDoRepresentante": "Telefone Representante",
"dadosAdicionais": "Dados Adicionais"
}
]
Saída
[
{
"cnpjCpfDevedor": "00000000000000",
"nomeDevedor": "Devedor para teste",
"codigoDevedor": "1234",
"endereco": "Rua endereço, 149",
"bairro": "Nome do Bairro",
"cidade": "Nome da Cidade",
"uf": "SC",
"cep": "89200000",
"telefones": [
{
"nomeContato": "Nome do Contato",
"ddd": "47",
"telefone": "999999999"
},
{
"nomeContato": "Nome do Contato",
"ddd": "47",
"telefone": "988888888"
}
],
"emails": [
{
"nomeContato": "Nome do Contato",
"email": "email@[Link]"
}
],
"documento": "123456",
"parcela": "01",
"especie": "DP",
"dataEmissao": "2022-01-01",
"dataVencimento": "2022-02-01",
"valorDocumento": 100.0,
"valorProtesto": 0.0,
"observacao": "Teste de Observação",
"nomeDoRepresentante": "Nome do Representante",
"telefoneDoRepresentante": "Telefone Representante",
"dadosAdicionais": "Dados Adicionais",
"situacao": "ok",
"descricao": "2200000001",
}
]
POST – PagamentoDireto: [Link]
Endpoint para recebimento de títulos/documento para cobrança:
Descrição do Campo Tipo Observação
cnpjCpfDevedor Texto CNPJ do devedor
documento Texto Número do documento/título
parcela Texto Número da parcela do documento/título
valorPagamento Valor que deverá ser baixado do documento/título, no caso de o valor ser maior
Número que o valor cadastrado no documento/título a diferença será lançada
automaticamente como juros
dataPagamento Data Data de pagamento do documento/título (formato: AAAA-MM-DD)
Retorno Todos os campos acimas serão retornados adicionados dos campos abaixo
dadosAdicionais Texto Informação enviado na remessa de documentos/títulos
situacao Texto Retorno da remessa (“ok”, “erro”)
descricao Texto Descrição do erro
Exemplo: (status = 200, application/json):
Entrada
[
{
"cnpjCpfDevedor": "00000000000000",
"documento": "123456",
"parcela": "01",
"valorPagamento": 100.0,
"dataPagamento": "2022-06-10"
}
]
Saída
[
{
"cnpjCpfDevedor": "00000000000000",
"documento": "123456",
"parcela": "01",
"valorPagamento": 100.0,
"dataPagamento": "2022-06-10",
"dadosAdicionais": "Dados Adicionais",
"situacao": "ok",
"descricao": "",
}
]
GET – Devolucao: [Link]
[Link]
Endpoint para registro das devoluções efetuadas ao cliente, o período é opcional, caso não seja informado o sistema
irá retornar apenas as devoluções realizadas no dia.
Descrição do Campo Tipo Observação
cnpjCliente Texto CNPJ do Cliente
nomeCliente Texto Nome do Cliente
processo Texto Número do processo na assessoria de cobrança
documento Texto Número do documento/título
parcela Texto Número da parcela do documento/título
especie Texto Espécie do documento/título (exemplo: DP, CH, NF)
cnpjCpfDevedor Texto CNPJ/CPF do devedor
codigoDevedor Texto Código de interno no cliente
nomeDevedor Texto Nome do devedor
cidade Texto Cidade do devedor
uf Texto Estado do devedor
valorDocumento Número Valor do documento/título
valorSaldoDocumento Número Valor do saldo de capital do documento/título
dataCadastroDocumento Data Data de cadastro do documento/título na assessoria (formato: AAAA-MM-DD)
dataVencimento Data Data de vencimento do documento/ título (formato: AAAA-MM-DD)
dataDevolucao Data Data da devolução do documento/título (formato: AAAA-MM-DD)
motivoDevolucao Texto Motivo da devolução do documento/título
descricaoDevolucao Texto Descrição completa da devolução do documento/título
nomeRepresentante Texto Nome do Representante enviado na remessa do documento/título
dadosAdicionais Texto Informação enviado na remessa de documentos/títulos
Exemplo: (status = 200, application/json):
Saída
[
{
"cnpjCliente": "11111111111111",
"nomeCliente": "CLIENTE DE TESTE",
"processo": "2200000001",
"documento": "123456",
"parcela": "01",
"especie": "DP",
"cnpjCpfDevedor": "00000000000000",
"codigoDevedor": "1234",
"nomeDevedor": "Devedor para teste",
"cidade": "Nome da Cidade",
"uf": "SC",
"valorDocumento": 100.0,
"valorSaldoDocumento": 100.0,
"dataCadastroDocumento": "2022-06-01",
"dataVencimento": "2022-02-01",
"dataDevolucao": "2022-06-20",
"motivoDevolucao": "Solicitação do Credor",
"descricaoDevolucao": "Finalizadas as tratativas extrajudiciais para a negociação do débito, nos termos da
regulamentação contida no artigo 8º, da Lei nº 13.097, de 19 de janeiro de 2015, que alterou o artigo 9º da Lei nº
9.430, de 27 de dezembro de 1996, informamos que os títulos relacionados nesse documento poderão ser lançados
em perdas no recebimento de créditos para a determinação do lucro real e da base de cálculo da contribuição social
sobre o lucro líquido (cf. [Link]
"nomeRepresentante": "Nome do Representante",
"dadosAdicionais": "Dados Adicionais"
}
]
GET – PrestacaoContas: [Link]
[Link]
Endpoint para registro das prestações de contas (repasse) ao cliente, o período é opcional, caso não seja informado
o sistema irá retornar apenas as prestações de contas pagas (repassadas) realizadas no dia.
Descrição do Campo Tipo Observação
cnpjCliente Texto CNPJ do Cliente
nomeCliente Texto Nome do Cliente
numeroPrestacaoContas Texto Número da prestação de contas
tipoPrestacaoContas Texto Tipo (Ex: “Pagamento Efetuado a Assessoria”, “Pagamento direto ao credor”)
processo Texto Número do processo na assessoria de cobrança
cnpjCpfDevedor Texto CNPJ/CPF do devedor
codigoDevedor Texto Código de interno no cliente
nomeDevedor Texto Nome do devedor
cidade Texto Cidade do devedor
uf Texto Estado do devedor
documento Texto Número do documento/título
parcela Texto Número da parcela do documento/título
especie Texto Espécie do documento/título (exemplo: DP, CH, NF)
valorDocumento Número Valor do documento/título
valorDesconto Número Valor do desconto efetuado
valorSaldoDocumento Número Valor do saldo de capital do documento/título
dataCadastroDocumento Data Data de cadastro do documento/título na assessoria (formato: AAAA-MM-DD)
dataVencimento Data Data de vencimento do documento/ título (formato: AAAA-MM-DD)
diasVencido Número Quantidade de dias vencidos no lançamento dos valores
valorCapital Número Valor recebido do principal do documento/título
valorJuros Número Valor recebido de juros do documento/título
valorMulta Número Valor recebido de multa do documento/título
valorProtesto Número Valor recebido de protesto do documento/título
valorRepasse Número Valor de repasse ao cliente referente ao documento/título
valorTaxaContrato Número Valor cobrado de taxa de contrato referente ao documento/título
dataRepasse Data Data de pagamento/repasse ao cliente (formato: AAAA-MM-DD)
tipoRepasse Texto Tipo de repasse referente ao documento/título (“Parcial” ou “Quitação”)
observacao Texto Observação sobre o repasse do documento/título
dadosAdicionais Texto Informação enviado na remessa de documentos/títulos
Exemplo: (status = 200, application/json):
Saída
[
{
"cnpjCliente": "11111111111111",
"nomeCliente": "CLIENTE DE TESTE",
"numeroPrestacaoContas": "1",
"tipoPrestacaoContas": "Pagamento Efetuado a Assessoria",
"processo": "2200000001",
"cnpjCpfDevedor": "00000000000000",
"codigoDevedor": "1234",
"nomeDevedor": "Devedor para teste",
"cidade": "Nome da Cidade",
"uf": "SC",
"documento": "123456",
"parcela": "01",
"especie": "DP",
"valorDocumento": 100.0,
"valorDesconto": 0.0,
"valorSaldoDocumento": 0.0,
"dataCadastroDocumento": "2022-06-01",
"dataVencimento": "2022-02-01",
"diasVencido": 139,
"valorCapital": 100.0,
"valorJuros": 16.72,
"valorMulta": 0.0,
"valorProtesto": 0.0,
"valorRepasse": 116.72,
"valorTaxaContrato": 16.72,
"dataRepasse": "2022-06-20",
"tipoRepasse": "Quitação",
"observacao": "",
"dadosAdicionais": Dados Adicionais"
}
]
GET – HistoricoProcesso: [Link]
[Link]
Endpoint para registro das ocorrências/acionamento dos processos, o período é opcional, caso não seja informado
o sistema irá retornar apenas os históricos/ocorrências realizadas no dia.
Descrição do Campo Tipo Observação
cnpjCliente Texto CNPJ do Cliente
nomeCliente Texto Nome do Cliente
processo Texto Número do processo na assessoria de cobrança
cnpjCpfDevedor Texto CNPJ/CPF do devedor
codigoDevedor Texto Código de interno no cliente
nomeDevedor Texto Nome do devedor
dataHistorico Data Data de histórico/ocorrência (formato: AAAA-MM-DD)
ocorrencia Texto Tipo de ocorrência
historico Texto Descrição do histórico/ocorrência
Exemplo: (status = 200, application/json):
Saída
[
{
"cnpjCliente": "11111111111111",
"nomeCliente": "CLIENTE DE TESTE",
"processo": "2200000001",
"cnpjCpfDevedor": "00000000000000",
"codigoDevedor": "1234",
"nomeDevedor": "Devedor para teste",
"dataHistorico": " 2022-06-15T14:30:47.000Z",
"ocorrencia": "Tipo de Ocorrência",
"historico": "Descrição detalhada da ocorrência"
}
]