As notificações de agendamento, são notificações disparadas todos os dias em torno das 9:00 AM, para notificar os sacados (pagadores) que os boletos emitidos contra eles estão preste a vencer ou já venceram, funcionando como um processo automatizado de notificações de cobrança.Estas notificações podem ser enviadas via E-mail ou SMS. Porém existe a possibilidade de cancelar a notificações para os boletos.
PATCH
Homologação:
https://homologacao.plugboleto.com.br/api/v1/notificacoes/agendamentos/inativar
Produção:
https://plugboleto.com.br/api/v1/notificacoes/agendamentos/inativar
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 |
Objeto
Para o inativação da notificação de agendamento para um boleto o objeto JSON pode ter o seguinte campo:
Campo | Tipo | Descrição |
Boletos | Array | Campo array no qual devem ser passados todos os boletos que serão inativados. |
Body
Essa rota recebe no (body) da requisição apenas os boletos que devem ser inativados.
Exemplo de JSON:
{
"Boletos": [
"ABCD12345",
"ABCD54321",
"DCBA12345"
]
}
Retorno
Exemplo de retorno caso todos os boletos falhem ao inativar:
{
"_status": "sucesso",
"sucesso": [],
"falha": [
{
"mensagem": "Falha ao inativar notificações de vencimento. Verifique se os IDs de integração estão corretos",
"boletos": [
"ABCD12345",
"ABCD54321"
]
}
]
}
Exemplo de retorno caso alguns boletos falhem e outros inativem com sucesso:
{
"_status":"sucesso",
"sucesso":[
{
"mensagem":"Notificações de vencimento inativadas com sucesso",
"boletos":[
"ABCD12345",
"ABCD54321"
]
}
],
"falha":[
{
"mensagem":"Falha ao inativar notificações de vencimento. Verifique se os IDs de integração estão corretos",
"boletos":[
"DCBA12345",
"DCBA54321"
]
}
]
}
Exemplo de retorno caso todos boletos sejam inativados com sucesso:
{
"_status": "sucesso",
"sucesso": [
{
"mensagem": "Notificações de vencimento inativadas com sucesso",
"boletos": [
"ABCD12345",
"ABCD54321",
"DCBA12345"
]
}
],
"falha": []
}
Comentários
0 comentário
Por favor, entre para comentar.