A geração de remessa manual permite que informe no momento da requisição, qual o sequencial desejado para que o arquivo seja gerado
Para fazer essa geração, vamos precisar apenas do IdIntegracao do boleto que você deseja gerar na remessa.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/remessas/lote/:manualRemittanceNumber/sequencial
Produção:
https://plugboleto.com.br/api/v1/remessas/lote/:manualRemittanceNumber/sequencial
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.
Exemplo de JSON:
["IdIntegracao1","IdIntegracao2","IdIntegracao3"]
Apenas as situações EMITIDO, REGISTRADO permitem a geração da remessa.
Retorno
Exemplo de retorno:
{
"_status":"sucesso",
"_dados": {
"_sucesso": [
{
"uniqueId":"MGLR01O33",
"CedenteContaCodigoBanco":"341",
"CedenteContaNumero":"12345",
"CedenteConvenioNumero":"1234",
"arquivo":"COB_341_123456_021019_25426.rem",
"situacao":"GERADA",
"transmissaoAutomatica":false,
"remessa":"[base64 contendo o arquivo de remessa]",
"mensagem":"Remessa gerada com sucesso",
"numero":25426,
"titulos": [
{
"idintegracao":"QRJYQIMW3"
}
]
}
],
"_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.
A numeração informada para o sequencial, ficará disponível no campo "numero"
Outro detalhe é que, caso os idIntegracao fornecidos no 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
Exemplos:
Dois boletos do mesmo convênio
{
"_status":"sucesso",
"_dados": {
"_sucesso": [
{
"uniqueId":"MGLR01O33",
"CedenteContaCodigoBanco":"341",
"CedenteContaNumero":"12345",
"CedenteConvenioNumero":"1234",
"arquivo":"COB_341_123456_021019_25426.rem",
"situacao":"GERADA",
"transmissaoAutomatica":false,
"remessa":"[base64 contendo o arquivo de remessa]",
"mensagem":"Remessa gerada com sucesso",
"numero":25426,
"titulos": [
{
"idintegracao":"QRJYQIMW3"
},
{
"idintegracao": "K9ZJT6M6M"
}
]
}
],
"_falha": []
}
}
Convênios diferentes:
{
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"uniqueId": "JC3BDTXO0",
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "12567",
"CedenteConvenioNumero": "1256125671",
"arquivo": "COB_341_125671_230323_01885.rem",
"situacao": "GERADA",
"transmissaoAutomatica": false,
"remessa": "[base64 contendo o arquivo de remessa]",
"mensagem": "Remessa gerada com sucesso",
"numero": 1885,
"titulos": [
{
"idintegracao": "B13ZK2MWR"
}
]
},
{
"uniqueId": "036BUHOD3",
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "12567",
"CedenteConvenioNumero": "15285",
"arquivo": "COB_341_125671_230323_01885.rem",
"situacao": "GERADA",
"transmissaoAutomatica": false,
"remessa": "[base64 contendo o arquivo de remessa]",
"mensagem": "Remessa gerada com sucesso",
"numero": 1885,
"titulos": [
{
"idintegracao": "F0QN7BTJP"
}
]
}
],
"_falha": []
}
}
Exemplo de retorno com erro:
Boleto não encontrado 404
{
"_status": "sucesso",
"_dados" : {
"_sucesso": []
"_falha": [
"idintegracao": "IdIntegracao4",
"_erro": "Boleto não encontrado.",
"_status_http": "404",
],
}
}
Sequencial precisa ser um valor numérico 400
{
"_status": "erro",
"_mensagem": "Sequencial da remessa precisa ser um número"
}
Convênio não possui a opção ConvenioNumeroRemessaManual habilitada 400
{
"_status": "erro",
"_mensagem": "Para a geração de remessas com controle manual do sequencial, a opção ConvenioNumeroRemessaManual deve estar habilitada.",
"_idconvenios": [
"15, 12"
]
}
Sequencial já existe para o convênio 400
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "sequencialRemessa",
"_erro": "Sequencial da remessa já existe para o convênio"
}
]
}
Comentários
1 comentário
Qual é o motivo do retorno "ACESSO NÃO AUTORIZADO" ?
Por favor, entre para comentar.