Autenticação

Aqui você encontrará tudo que precisa para ter sua melhor integração possível com as nossas APIs.
Venha conosco e conduza seu negócio ao próximo nível!

Token

Utilizamos Token Bearer para validar todas as transações. Exemplo de como solicitar e retorno.

URL:

v1/{ambiente}/token

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/token \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"client_system": "Caixa1",
"client_id": "5as8d7sa8475dfg4f5gf332.homologacao.peghcaopi.v1",
"grant_type": "MTkuNTMxLjQxNi8wdasd5d9sa78d784ggTctMDgtNDI=",
"client_secret": "878s7d8a7sd8as7d8as7d8as7d8as7dsa54g5f45g78"
}
'

JSON:

{"client_system": "Caixa1", "client_id": "5as8d7sa8475dfg4f5gf332.homologacao.peghcaopi.v1", "grant_type": "MTkuNTMxLjQxNi8wdasd5d9sa78d784ggTctMDgtNDI=","client_secret": "878s7d8a7sd8as7d8as7d8as7d8as7dsa54g5f45g78"}

Resposta:

Se tudo tiver correto você receberá:

{"access_token":"VmpCa2QySlhWbFZYYTNCcVVsVndVMXBITVZkaFJYaHhVbTE0YUZZd1dr cFpiWGh1WlZVd2QxcEZPVkJXVlhBd1ZHMTBWMVpHVm5WWGJYUlBaV3hKZDFaRVNrdGtNVkpZWVVad1 ZsZEhUak5YYWs1eVRrWk9XVlJ0Um1sU1dGSjRWR3hTV21ReVVraFhiVFZhVlZRd09RPT0","expires_in": 2400, "token_type": "bearer"}

Se preencheu alguma coisa errada você vai receber:

{"error": true,"mensagem": "Informacoes Invalidas"}

Boletos

Utilize nossa api de Boletos e integre tudo dentro do seu ERP.

Novo Boleto

Em nome deve ser preenchido o nome do cliente já cadastrado.

{"error": true, "mensagem": "confira o json enviado"}

URL:

v1/{ambiente}/boletos/novoboleto

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/novoapp \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"Total":6,"Faturas":
[
{"nome":"Joao C S F","datavencimento":"22/08/2026","valor":"15.00","multa":"0","juros":"0.00","parcela":"1", "desconto":"0,00","mensagem1":"Teste Via API","mensagem2":"mensagem"}
]
}
'

JSON:

{"nome":"Joao C S F","datavencimento":"22/08/2026","valor":"15.00","multa":"0","juros":"0.00","parcela":"1", "desconto":"0,00","mensagem1":"Teste Via API","mensagem2":"mensagem"}

Informações
Campo Uso Informação
Tipo de Pessoa 01 Pessoa Física
Tipo de Pessoa 02 Pessoa Jurídica
Resposta:

Se tudo tiver correto você receberá:

{"error": false, "total":"1", "autenticacao":"AUT-***--PAG--53"}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "confira o json enviado"}

Faturas Pagas

Utilize para buscar os boletos pagos no dia.

URL:

v1/{ambiente}/boletos/faturaspagas

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/faturaspagas \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"Data":"2023-07-11"}
'

JSON:

{"Data":"2023-07-11"}

Resposta:

Se tudo tiver correto você receberá:

[{"datavencimento":"2023-07-10","datapagamento":"2023-07-11","nossonumero":"0019901205","valor":"199.99",
"valorpago":"199.99","desconto":"","multa":"","juros":"0.00"},
{"datavencimento":"2023-07-10","datapagamento":"2023-07-11","nossonumero":"0019901206","valor":"199.99",
"valorpago":"199.99","desconto":"","multa":"","juros":"0.00"}]

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao existem boletos"}

Faturas em Aberto

Utilize para buscar os boletos em aberto no dia.

URL:

v1/{ambiente}/boletos/faturasabertas

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/faturasabertas \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"Data":"2023-07-11"}
'

JSON:

{"Data":"2023-07-11"}

Resposta:

Se tudo tiver correto você receberá:

[{"datavencimento":"2023-07-10","nossonumero":"0019901205","valor":"199.99", "desconto":"0.00","multa":"5","juros":"0.33"},
{"datavencimento":"2023-07-10","nossonumero":"0019901206","valor":"199.99", "desconto":"0.00","multa":"5","juros":"0.33"}]

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao existem boletos"}

Baixar Fatura

Utilize para baixar o boleto em aberto como cliente pagou, vai sair do DDA.

URL:

v1/{ambiente}/boletos/baixa

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/baixa \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero":"0019922169"}
'

JSON:

{"NossoNumero":"0019922169"}

Resposta:

Se tudo tiver correto você receberá:

[{"datavencimento":"2023-07-10","nossonumero":"0019901205","valor":"199.99", "desconto":"0.00","multa":"5","juros":"0.33"},
{"datavencimento":"2023-07-10","nossonumero":"0019901206","valor":"199.99", "desconto":"0.00","multa":"5","juros":"0.33"}]

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao existem boletos"}

Alterar Vencimento

Utilize para alterar o vencimento do boleto em aberto.

URL:

v1/{ambiente}/boletos/alterarvencimento

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/alterarvencimento \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero": "0020022442", "NovoVencimento": "2023-07-20"}
'

JSON:

{"NossoNumero": "0020022442", "NovoVencimento": "2023-07-20"}

Resposta:

Se tudo tiver correto você receberá:

{"error": false, "mensagem": "Vencimento alterado com sucesso"}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao consegui alterar o vencimento"}

Abatimento

Utilize para efetuar abatimento no valor final do boleto em aberto.

URL:

v1/{ambiente}/boletos/abatimento

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/abatimento \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero": "0010022230", "Abatimento": "1.00"}
'

JSON:

{"NossoNumero": "0010022230", "Abatimento": "1.00"}

Resposta:

Se tudo tiver correto você receberá:

{"error": false, "mensagem": "Abatimento efetuado com sucesso"}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao consegui aplicar o abatimento"}

Alterar Multa / Juros

Utilize para alterar a multa e o juros no boleto em aberto.

URL:

v1/{ambiente}/boletos/alterar

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/alterar \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero": "0010022230", "Multa": "5", "Juros": "0.22"}
'

JSON:

{"NossoNumero": "0010022230", "Multa": "5", "Juros": "0.22"}

Resposta:

Se tudo tiver correto você receberá:

{"error": false, "mensagem": "Multa / Juros alterado com sucesso"}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao consegui aplicar o abatimento"}

Informações do Boleto

Utilize para saber todas as informações do boleto.

URL:

v1/{ambiente}/boletos/informacoes

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/informacoes \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero": "0010023001"}
'

JSON:

{"NossoNumero": "0010023001"}

Resposta:

Se tudo tiver correto você receberá:

{"datavencimento":"2023-07-22","remessa":"205","valor":"15.00","multa":"5","juros":"0.33","desconto":"0.00",
"datacarencia":"2023-07-22","mensagem1":"Teste Via API","mensagem2":"Obrigado por utilizar nossos servicos",
"controle2":"","devolucao1":"0010023001","devolucao2":"","banco":"Santander","status":"0"}

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao localizei o boleto"}

Remessas

Utilize para visualizar as informações de todos os cliente.

URL:

v1/{ambiente}/boletos/remessas

CURL:

curl --request GET \
--url https://urlmaster/v1/{ambiente}/boletos/remessas \

Resposta:

Se tudo tiver correto você receberá:

[{"data":"2018-01-23","numero":"33","quantidade":"1","tarifa":"2.20", "valortotal":"2.20","tipo":"Importada", "banco":"Bradesco", "autenticacao":"AUT|2||PAG||33"},{"data":"2018-01-31", "numero":"34","quantidade":"33","tarifa":"2.20","valortotal":"72.60", "tipo":"Importada","banco":"Bradesco","autenticacao":"AUT|2||PAG||34"}]

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao existem remessas"}

Lista de Boletos da Remessa

Utilize para visualizar todos os boletos da remessa.

URL:

v1/{ambiente}/boletos/listagem

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/listagem \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"autenticacao":"AUT|2||PAG||355"}
'

JSON:

{"autenticacao":"AUT|2||PAG||355"}

Resposta:

Se tudo tiver correto você receberá:

[{"datavencimento":"2023-07-10","remessa":"355","valor":"40.00","multa":"10","juros":"0.33", "desconto":"0.00","datacarencia":"2023-07-10","mensagem1":"", "mensagem2":"Obrigado por utilizar nossos servicos","controle2":"","devolucao1":"20022279", "devolucao2":"","banco":"Bradesco","status":"1"},{"datavencimento":"2023-07-27","remessa":"355", "valor":"140.00","multa":"5","juros":"0.22","desconto":"1.00","datacarencia":"2023-07-27", "mensagem1":"","mensagem2":"Obrigado por utilizar nossos servicos","controle2":"Abatimento", "devolucao1":"20022230","devolucao2":"","banco":"Bradesco","status":"1"}]

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao existem remessas"}

Fatura A4 do Boleto

Utilize para gerar o PDF do boleto.

URL:

v1/{ambiente}/boletos/fatura

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/fatura \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero": "0010023001"}
'

JSON:

{"NossoNumero": "0010023001"}

Resposta:

Se tudo tiver correto você receberá:

{"error": false, "link": "http://pdf.pegcobranca.com.br/?id=878646&tipo=UnicoSantander"}

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao existem pagamentos"}

Remessa Carnê

Utilize para gerar o PDF do carne ou remessa enviada.

URL:

v1/{ambiente}/boletos/remessa

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/boletos/fatura \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"NossoNumero": "0010023001"}
'

JSON:

{"NossoNumero": "0010023001"}

Resposta:

Se tudo tiver correto você receberá:

{"error": false, "link": "http://pdf.pegcobranca.com.br/?id=205&tipo=CarneSantander&autenticacao=AUT-1--PAG--205"}

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao localizei a remessa"}

Clientes

Utilize nossa api de Clientes e integre tudo dentro do seu ERP.

Novo Cliente

Utilize nossa api de Cliente e agilize tudo dentro do seu ERP.

URL:

v1/{ambiente}/clientes/novo

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/clientes/novo \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"Nome":"Jose S Ferreira","TipoDocumento":"01","Documento":"31239678830",
"Endereco":"Av Farmaceutico","Numero":"158","Bairro":"Centro","Cidade":"Uba",
"Estado":"MG","Cep":"36505002"}
'

JSON:

{"Nome":"Jose S Ferreira","TipoDocumento":"01","Documento":"31239678830","Endereco":"Av Farmaceutico","Numero":"158","Bairro":"Centro","Cidade":"Uba","Estado":"MG","Cep":"36505002"}

Informações
Campo Uso Informação
Tipo de Pessoa 01 Pessoa Física
Tipo de Pessoa 02 Pessoa Jurídica
Resposta:

Se tudo tiver correto você receberá:

{"error": false, "mensagem": "cliente cadastrado"}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "cliente ja cadastrado"}

Todos Cliente

Utilize para visualizar as informações de todos os cliente.

URL:

v1/{ambiente}/clientes/listar

CURL:

curl --request GET \
--url https://urlmaster/v1/{ambiente}/clientes/listar \

Resposta:

Se tudo tiver correto você receberá:

[{"data":"2020-12-03","nome":"Clínica Teste Grossi","endereco":"Rua 13 de Maio, 95","numero":"","cep":"36500061","bairro":"Centro","cidade":"Ubá","estado":"MG","cidade":"Ubá","telefone":"","tipodocumento":"Pessoa Jurídica","documento":"13.886.008/0001-34","dataalteracao":"2020-12-04"}]

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "cliente nao localizado"}

Alterar Cliente

Utilize para alterar as informações do cliente.

URL:

v1/{ambiente}/clientes/alterarcliente

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/clientes/alterarcliente \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"Nome":"Jose S Ferreira","TipoDocumento":"01","Documento":"31239678830",
"Endereco":"Av Farmaceutico","Numero":"158","Bairro":"Centro","Cidade":"Uba",
"Estado":"MG","Cep":"36505002"}
'

JSON:

{"Nome":"Jose S Ferreira","TipoDocumento":"01","Documento":"31239678830","Endereco":"Av Farmaceutico","Numero":"158","Bairro":"Centro","Cidade":"Uba","Estado":"MG","Cep":"36505002"}

Resposta:

Se tudo tiver correto você receberá:

{"error": false, "mensagem": "cliente alterado com sucesso"}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "cliente nao localizado"}

Informações do Cliente

Utilize para saber todas as informações do cliente.

URL:

v1/{ambiente}/clientes/informacoes

CURL:

curl --request POST \
--url https://urlmaster/v1/{ambiente}/clientes/informacoes \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"Documento":"31239678830"}
'

JSON:

{"Documento":"31239678830"}

Resposta:

Se tudo tiver correto você receberá:

{"Nome":"Jose S Ferreira","Endereco":"Av Farmaceutico","Numero":"158","Cep":"36505002","Bairro":"Centro","Cidade":"Uba","Documento":"31239678830""TipoDocumento":"01""Estado":"MG"}

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao localizei o boleto"}