Sumário
Cadastrando uma Conta
Os dados da conta serão usados como parâmetro em vários momentos: Geração e impressão de um boleto, geração do arquivo de remessa, etc. Dessa forma, precisamos fazer o pré-cadastro dela para que não seja necessário informá-la a todo momento. Para o nosso tutorial, vamos utilizar o id do cedente cadastrado anteriormente.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/contas
Produção:
https://plugboleto.com.br/api/v1/cedentes/contas
Headers
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
cnpj-cedente | CNPJ ou CPF do cedente | 01001001000113 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-cedente | CNPJ do Cedente | 01001001000113 |
token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Body
Campo | Tipo | Descrição |
ContaCodigoBanco | string | Código do banco (3 dígitos) |
ContaAgencia | string | Número da agência (sem DV) |
ContaAgenciaDV | string | Dígito verificador da agência |
ContaNumero | string | Número da conta (sem DV) |
ContaNumeroDV | string | Dígito verificador da conta |
ContaTipo | string |
Tipo da conta. Valores aceitos: "CORRENTE" ou "POUPANCA" |
ContaCodigoBeneficiario | string | Código do beneficiário |
ContaCodigoBancoCorrespondente | string | Código do banco correspondente, disponível para os bancos 756, 707 e 136 *não preencher caso não utilizado* |
ContaCodigoEmpresa | string | Código da empresa. Campo obrigatório para Bradesco e Daycoval. |
ContaValidacaoAtiva | boolean |
Segunda via atualizada do boleto |
ContaImpressaoAtualizada | boolean | |
ContaImpressaoAtualizadaAlteracao | boolean | Define se a impressão será atualizada com os dados de remessas de alterações gerado, mesmo que as alterações ainda não tenham sido confirmadas pelo banco. (Campo só pode ser utilizando quando o campo ContaImpressaoAtualizada for true) |
ContaImpressaoAtualizadaLiquidado |
boolean |
Define se a impressão será atualizada para boletos com a situação LIQUIDADO, realizando o cálculo mesmo após o pagamento. Caso seja desabilitado não haverá atualizações. (Campo só pode ser utilizando quando o campo ContaImpressaoAtualizada for true) Valor default: true |
Dica: Para auxiliar no cadastro da conta, possuímos uma seção de dicas, onde você encontra um detalhamento sobre as informações que devem ser preenchidas para cada banco.
Segue o link desta documentação: https://atendimento.tecnospeed.com.br/hc/pt-br/sections/360002897054-Dicas-para-cadastro-de-contas-e-conv%C3%AAnios
Exemplo:
{
"ContaCodigoBanco": "341",
"ContaAgencia": "1234",
"ContaAgenciaDV": "1",
"ContaNumero": "59698",
"ContaNumeroDV": "3",
"ContaTipo": "CORRENTE",
"ContaCodigoBeneficiario": "60473"
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"id": 168,
"codigo_banco": "341",
"agencia": "1234",
"agencia_dv": "1",
"conta": "59698",
"conta_dv": "3",
"tipo_conta": "CORRENTE",
"cod_beneficiario": "60473",
"id_cedente": 44,
"criado": "2017-03-30T16:53:48.000Z",
"atualizado": "2017-03-30T16:53:48.000Z",
"cod_empresa": null,
"convenios": []
}
}
Obs.: É importantíssimo persistir em seu banco de dados o ID da Conta retornado na resposta da requisição. Ele será usado caso seja preciso fazer alterações no cadastro da conta futuramente.
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "contanumero",
"_erro": "Agência 1234 e conta 59699 já cadastrada para este cedente."
}
]
}
Alterando uma Conta
Assim como na Alteração de um Cedente, a Alteração de uma Conta se resume em preenchermos um modelo de integração (JSON) com os dados da conta a serem alterados e enviarmos para o nosso servidor, dessa forma, reconhecendo a alteração desejada.
PUT
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/contas/:id
Produção:
https://plugboleto.com.br/api/v1/cedentes/contas/:id
*Deve ser informado o id da conta que deseja alterar na URL da requisição. É o mesmo ID retornado na rotina de cadastro da conta.
Headers
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
cnpj-cedente | CNPJ ou CPF do cedente | 01001001000113 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-cedente | CNPJ do Cedente | 01001001000113 |
token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Body
Campo | Tipo | Descrição |
ContaCodigoBanco* | string | Código do banco |
ContaAgencia* | string | Número da agência (sem DV) |
ContaAgenciaDV* | string | Dígito verificador da agência |
ContaNumero* | string | Número da conta (sem DV) |
ContaNumeroDV* | string | Dígito verificador da conta |
ContaTipo* | string | Tipo da conta |
ContaCodigoBeneficiario* | string | Código do beneficiário |
ContaCodigoEmpresa* | string | Código da empresa. Campo obrigatório para Bradesco |
ContaValidacaoAtiva | boolean | Segunda via atualizada do boleto |
ContaImpressaoAtualizada | boolean | |
ContaImpressaoAtualizadaAlteracao | boolean | Define se a impressão será atualizada com os dados de remessas de alterações gerado, mesmo que as alterações ainda não tenham sido confirmadas pelo banco. (Campo só pode ser utilizando quando o campo ContaImpressaoAtualizada for true) |
ContaImpressaoAtualizadaLiquidado |
boolean |
Define se a impressão será atualizada para boletos com a situação LIQUIDADO, realizando o cálculo mesmo após o pagamento. Caso seja desabilitado não haverá atualizações. (Campo só pode ser utilizando quando o campo ContaImpressaoAtualizada for true) Valor default: true |
*Obs: Após o registro de um boleto, os campos referenciados acima não poderão ser alterados diretamente
Exemplo:
{
"ContaCodigoBanco": "341",
"ContaAgencia": "1234",
"ContaAgenciaDV": "1",
"ContaNumero": "59698",
"ContaNumeroDV": "3",
"ContaTipo": "CORRENTE",
"ContaValidacaoAtiva": true,
"ContaImpressaoAtualizada": true,
"ContaImpressaoAtualizadaAlteracao": true,
"ContaImpressaoAtualizadaLiquidado": true
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"id": 168,
"codigo_banco": "341",
"agencia": "1234",
"agencia_dv": "1",
"conta": "59698",
"conta_dv": "3",
"tipo_conta": "CORRENTE",
"cod_beneficiario": "60473",
"id_cedente": 44,
"criado": "2017-03-30T16:53:48.000Z",
"atualizado": "2017-03-30T16:53:48.000Z",
"cod_empresa": null,
"convenios": []
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "contanumero",
"_erro": "Agência 1234 e conta 59699 já cadastrada para este cedente."
}
]
}
Consultando Contas
Para consultar contas, basta utilizar a mesma rota utilizada no cadastro (POST), alterando para GET e informando uma QueryString
para aplicar um filtro, abaixo temos exemplos de como realizar tais consultas:
Como base devem ser utilizada as seguintes URl's
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/contas
Produção:
https://plugboleto.com.br/api/v1/cedentes/contas
Para consultar uma conta por ID
utilizando com exemplo a url de homologação devemos utilizar a seguinte url:
https://homologacao.plugboleto.com.br/api/v1/cedentes/contas?id=091
No resultado desta busca será retornado, a conta que possui o ID igual á 091
.
Deletando Contas
Para deletar contas, basta utilizar a mesma rota utilizada no cadastro (POST), alterando para DELETE e adicionar o ID da conta.
✔ Deletando uma conta
Como base devem ser utilizada as seguintes URl's
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/contas/ID_CONTA
Produção:
https://plugboleto.com.br/api/v1/cedentes/contas/ID_CONTA
Exemplo de resposta:
Sucesso:
Falha:
Comentários
0 comentário
Por favor, entre para comentar.