Este serviço cria uma solicitação de agenda online: uma consulta sob demanda das duplicatas de um Sacador na registradora, sem esperar a próxima agenda recorrente do opt-in.
Agendas na Jornada do Financiador: Solicitar agenda online | Agenda resumida | Agenda detalhada | Acompanhar o processamento
Pré-requisitos
- Token de acesso obtido em Autenticação para acesso aos serviços da Jornada do Financiador, enviado no header
Authorization: Bearer <access_token>. - Um opt-in aprovado (
status: approved) do próprio Agente Financiador para o Sacador. Oopt_in_idé o retornado em Retorna uma lista de solicitações de opt-ins.
O que informar
opt_in_id,calendar_scopeedrawersão obrigatórios.calendar_scopedefine a abrangência da agenda solicitada:open(duplicatas em aberto) ouhistorical(duplicatas do histórico). O valorallexiste no opt-in e nas consultas de agenda, mas não é aceito aqui e retorna 400.draweridentifica o Sacador do opt-in.nameé opcional. Sem ele, a agenda recebe um nome gerado automaticamente.terms_acceptedregistra o aceite dos termos e condições da registradora. Quando ausente, a agenda é solicitada sem o aceite.query_paramsé opcional e restringe as duplicatas da agenda por período de vencimento, período de emissão, faixa de valor (em reais) e Sacado. Quando enviado,buyerecnpj_base_indicatorsão obrigatórios.- Campos não previstos no corpo da requisição são ignorados.
Processamento assíncrono
- A resposta 202 traz apenas o
process_id. Ela confirma que a solicitação foi recebida, não que a agenda já existe. - Consulte Retorna o status do processamento assíncrono com esse
process_idaté o processo sair dependingouprocessing. O processamento depende da registradora e pode levar alguns minutos; consulte em intervalos. - Com o processo em
finished, a agenda é sincronizada e passa a aparecer na agenda resumida e na agenda detalhada. Use o filtroopt_in_idpara localizá-la.
| Status do processo | Significado |
|---|---|
pending | Solicitação recebida, aguardando envio à registradora. |
processing | Solicitação enviada à registradora, aguardando a conclusão. |
finished | Agenda criada na registradora. Os dados ficam disponíveis nas consultas de agenda. |
error | A solicitação não foi concluída. |
O opt-in é verificado durante o processamento, não nesta chamada. Um opt_in_id inexistente, não aprovado ou de outro Agente Financiador é aceito com 202 e o processo termina em error, com o motivo em metadata.reason:
metadata.reason | Significado |
|---|---|
opt_in_not_found | O opt_in_id informado não existe. |
opt_in_not_active:<status> | O opt-in não está aprovado. O trecho após os dois pontos é o status atual dele, por exemplo opt_in_not_active:expired. |
opt_in_not_owned | O opt-in pertence a outro Agente Financiador. |
Com o processo em finished, metadata.schedule_id traz o identificador da agenda na registradora.
Agenda sem duplicatas
Uma agenda concluída pode não ter duplicatas, por exemplo quando o Sacador não possui duplicatas na abrangência ou nos filtros solicitados. Nesse caso as consultas retornam a agenda com os totais zerados e, na agenda detalhada, com portfolios vazio.
Erros
| Status | Quando acontece |
|---|---|
| 400 | Campo obrigatório ausente ou valor inválido. A resposta traz error: VALIDATION_ERROR e o campo detail lista cada campo recusado em field e o motivo em message. |
| 401 | Token ausente, inválido ou expirado. Obtenha um novo token em Atualizar o Token de Acesso. |

