Assim como a conta, o cadastro do convênio vai fornecer informações para outros fluxos da aplicação. É nele que vamos configurar os dados como Carteira, CNAB, etc. Lembre-se que vamos precisar do campo id que foi retornado na requisição anterior. Isso acontece pois um cedente pode ter várias contas, e é através desse ID que vinculamos esse novo convênio à conta correta.
POST
Homologação:
http://homologacao.plugboleto.com.br/api/v1/cedentes/contas/convenios
Produção:
https://plugboleto.com.br/api/v1/cedentes/contas/convenios
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 |
| ConvenioNumero | string | Número do convênio |
| ConvenioDescricao | string | Descrição do convênio |
| ConvenioCarteira | string | Código da carteira |
| ConvenioEspecie | string | Espécie do convênio |
| ConvenioPadraoCNAB | string | Padrão CNAB. Informar 240 ou 400 |
| ConvenioNumeroRemessa | string | Número atual da remessa. Campo obrigatório para Sicredi |
| ConvenioUtilizaVan | boolean | Define se o convênio irá ou não utilizar a transmissão automática de remessa e retorno. Informar 1 para marcar essa opção como ativa. Por padrão, utiliza o valor 0. Transmissão automática disponível apenas para o ambiente de produção. |
| Conta | integer | Identificador da conta na nossa base de dados |
Exemplo:
{
"ConvenioNumero": "7889604745",
"ConvenioDescricao": "Convenio da tecnospeed",
"ConvenioCarteira": "109",
"ConvenioEspecie": "R$",
"ConvenioPadraoCNAB": "400",
"ConvenioNumeroRemessa": "1",
"Conta": 168
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"id": 154,
"numero_convenio": "7889604745",
"descricao_convenio": "Convenio da tecnospeed",
"carteira": "109",
"especie": "Boleto",
"id_conta": 168,
"criado": "2017-03-30T18:01:19.000Z",
"atualizado": "2017-03-30T18:01:19.000Z",
"padraoCNAB": "400",
"utiliza_van": false,
"numero_remessa": 1
}
}
Obs.: É importantíssimo persistir em seu banco de dados o ID do Convênio retornado na resposta da requisição. Ele será usado caso seja preciso fazer alterações no cadastro do convênio futuramente.
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Acesso negado.",
"_dados": [
{
"_erro": "Conta do Cedente não encontrada"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.