O arquivo de remessa é um dos pontos mais importantes do nosso processo. É ele que será importado no site do banco, para que o mesmo processe e registre o boleto gerado.
E também é através deste método de geração de remessa que, caso você utilize a Transmissão Automática, os boletos serão encaminhados ao banco. Neste tipo de transmissão, a rota de geração de remessa funciona como um gatilho para que a Tecnospeed saiba quais boletos você deseja que sejam enviados ao banco.
Para fazer essa geração, vamos precisar apenas do IdIntegracao do boleto que você deseja incluir na remessa. Recomendamos que sejam informados no máximo 700 a 800 boletos por remessa. Vale destacar que quanto maior o número de boletos na remessa, mais tempo será necessário para a geração do arquivo.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/remessas/lote
Produção:
https://plugboleto.com.br/api/v1/remessas/lote
Headers
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-cedente | CNPJ do Cedente | 01001001000113 |
cnpj-sh | CNPJ da Software House | 01001001000113 |
token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
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
Esta rota recebe um array no corpo (body) de IdIntegracao, separados por vírgula. Você irá passar neste body os IdIntegracao dos boletos que se deseja obter remessa.
Exemplo de JSON:
["IdIntegracao1","IdIntegracao2","IdIntegracao3"]
Apenas as situações EMITIDO, REGISTRADO, LIQUIDADO e BAIXADO permitem a geração da remessa. Ah, lembre-se que, para gerar remessa para mais de um Id, você deve informar a vírgula como separador. Limite de 1000 boletos por remessa.
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "12345",
"CedenteConvenioNumero": "1234",
"arquivo": "COB_341_123456_021019_00001.rem",
"situacao": "GERADA",
"transmissaoAutomatica": false,
"remessa": "[base64 contendo o arquivo de remessa]",
"mensagem": "Remessa gerada com sucesso",
"numero": 1,
"titulos": [
{
"idintegracao": "eAcvWSIfw"
}
]
}
],
"_falha": []
}
}
Neste JSON de resposta, dentro do objeto "remessa" você receberá o conteúdo da remessa encodado em base64. O próximo passo que seu sistema deve fazer é capturar este base64 e "decodar", para formato texto comum. Depois disso, você já pode salvar em arquivo e encaminhar ao banco. Vale ressaltar que, o controle do padrão de nomenclatura do arquivo é responsabilidade do cliente na modalidade de envio manual e as definições de padrão de nomenclatura estão presentes nos manuais bancários.
Outro detalhe é que, caso os idIntegracao fornecidos JSON de solicitação da remessa pertençam ao mesmo convênio, será gerada uma única remessa contendo todos os boletos solicitados. Caso contrário, será gerada uma remessa por convênio (como no exemplo acima, em que existem 2 remessas).
Exemplo de retorno usando Transmissão Automática:
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "12345",
"CedenteConvenioNumero": "1234",
"arquivo": "COB_341_123456_021019_00001.rem",
"situacao": "GERADA",
"transmissaoAutomatica": true,
"remessa": "",
"mensagem": "Arquivo de remessa enviado ao banco",
"numero": 1,
"titulos": [
{
"idintegracao": "eAweWSIfw"
}
]
}
],
"_falha": []
}
}
Exemplo de retorno com erro:
{
"_status": "sucesso",
"_dados" : {
"_sucesso": []
"_falha": [
"idintegracao": "IdIntegracao4",
"_erro": "Boleto não encontrado.",
"_status_http": "404",
],
}
}
Utilizar rota de emissão do sequencial na forma manual 400
{
"_status": "erro",
"_mensagem": "Para a geração de remessas com controle manual do sequencial, utilize a rota /api/v1/remessas/lote/:manualRemittanceNumber/sequencial"
}
Com o arquivo de remessa em mãos, podemos fazer a importação no site do banco. Além da remessa para o registro do boleto, podemos também gerar outros tipos de remessa (como alteração da data de vencimento, valor e baixa). Com isso, nosso próximo passo é gerar a remessa de alteração.
Comentários
0 comentário
Por favor, entre para comentar.