No PlugBoleto, quando a opção de carteira escritural estiver marcada, significa que o campo nossoNumero
será controlado pela instituição bancária. Esse campo será enviado via arquivo de retorno e conciliado no PlugBoleto juntamente com o nossoNumero
recebido.
Atualmente, recebemos diversos arquivos de retorno que contêm apenas o movimento de registro, porém sem a informação do nossoNumero
. Como resultado, o título é alterado para a situação de registrado, mas sem o nossoNúmero.
Para oferecer mais controle aos usuários, implementamos uma nova funcionalidade que permite definir se desejam conciliar retornos que não possuam o nossoNumero
. Agora é possível escolher se deseja ou não conciliar esses retornos. Ao optar por não conciliar um retorno sem o nossoNumero
informado pelo banco, o PlugBoleto não realizará a conciliação e o identificará como "Não Conciliado" na lista com o idIntegracao
.
No entanto, se você desejar conciliar um retorno que não possui o nossoNumero
informado pelo banco, basta habilitar a opção "Conciliar retorno sem nosso número". Por padrão, todos os convênios criados têm essa opção habilitada para conciliação sem o nossoNumero
. Portanto, é importante desmarcar essa opção caso não deseje conciliar retornos sem o nossoNumero
.
Configuração via GUI (interface do usuário):
Configuração via API:
PUT
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/contas/convenios/:id
Produção:
https://plugboleto.com.br/api/v1/cedentes/contas/convenios/:id
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 |
Body
Campo | Tipo | Descrição |
ConvenioNossoNumeroBanco | boolean | true (verdadeiro) ou false (falso). Define se o Nosso Numero será controlado pelo banco. (Carteira Escritural) |
ConvenioNossoNumeroConciliarBanco | boolean |
true (verdadeiro) ou false (falso). Define a forma como os retornos serão conciliados de acordo com o preenchimento do TituloNossoNumero no arquivo de retorno. Ex: Se o retorno não contiver o TituloNossoNumero informado pelo banco, você pode desabilitar a conciliação configurando a opção "ConvenioNossoNumeroConciliarBanco" como false ou desabilitando-a por meio da
interface do PlugBoleto. |
Exemplo de Json
{
"ConvenioNossoNumeroBanco": true,<br>
"ConvenioNossoNumeroConciliarBanco": false<br>
}
Response de Sucesso:
{
"_status": "sucesso",
"_dados": {
"id": 18336,
"numero_convenio": "474856",
"descricao_convenio": "Teste",
"carteira": "02",
"especie": "R$",
"id_conta": 21934,
"criado": "2024-01-04T12:34:55.000Z",
"atualizado": "2024-10-30T18:25:20.000Z",
"padraoCNAB": "400",
"utiliza_van": false,
"numero_remessa": 0,
"densidade_remessa": null,
"codigo_cobranca": null,
"reiniciar_diariamente": false,
"registro_automatico": false,
"numero_remessa_manual": null,
"estacao": null,
"ativo": true,
"nossonumero_controle_banco": true,
"tipo_webservice": null,
"carteira_codigo": null,
"versao_layout": "001",
"numero_contrato": null,
"codigo_identificador": "2a71f841cd1072d36c28ac54a082b40f",
"consultaws": true,
"alteracao_webservice": null,
"certificado_s3_key": null,
"certificado": null,
"dtvencimentocertificado": null,
"nossonumero_conciliar_banco": false,
"bolecode": false,
"pix_chave": null,
"pix_client_id": null,
"pix_client_secret": null,
"pix_certificado_s3_key": null,
"pix_certificado": null,
"pix_dtvencimentocertificado": null,
"consulta_francesa": false,
"hex_primary_cef": false,
"ocultar_endereco_impressao_sicoob": null,
"webhook_inter_v3": false,
"token_ailos": null,
"senha_ailos": null
}
}
Response de Erro:
{
"_status": "erro",
"_mensagem": "Convenio não encontrado."
}
Comentários
0 comentário
Por favor, entre para comentar.