Cria solicitação de agenda online

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

O que informar

  • opt_in_id, calendar_scope e drawer são obrigatórios.
  • calendar_scope define a abrangência da agenda solicitada: open (duplicatas em aberto) ou historical (duplicatas do histórico). O valor all existe no opt-in e nas consultas de agenda, mas não é aceito aqui e retorna 400.
  • drawer identifica o Sacador do opt-in.
  • name é opcional. Sem ele, a agenda recebe um nome gerado automaticamente.
  • terms_accepted registra 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, buyer e cnpj_base_indicator são obrigatórios.
  • Campos não previstos no corpo da requisição são ignorados.

Processamento assíncrono

  1. A resposta 202 traz apenas o process_id. Ela confirma que a solicitação foi recebida, não que a agenda já existe.
  2. Consulte Retorna o status do processamento assíncrono com esse process_id até o processo sair de pending ou processing. O processamento depende da registradora e pode levar alguns minutos; consulte em intervalos.
  3. Com o processo em finished, a agenda é sincronizada e passa a aparecer na agenda resumida e na agenda detalhada. Use o filtro opt_in_id para localizá-la.
Status do processoSignificado
pendingSolicitação recebida, aguardando envio à registradora.
processingSolicitação enviada à registradora, aguardando a conclusão.
finishedAgenda criada na registradora. Os dados ficam disponíveis nas consultas de agenda.
errorA 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.reasonSignificado
opt_in_not_foundO 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_ownedO 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

StatusQuando acontece
400Campo 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.
401Token ausente, inválido ou expirado. Obtenha um novo token em Atualizar o Token de Acesso.
Body Params

Solicitação de criação de uma Agenda Online para um Sacador na B3.

uuid
required

Identificador do opt-in (consentimento) do Sacador na Shipay.

Nome da agenda a ser criada.

string
enum
required

Abrangência da agenda solicitada.

ValorDescrição
openDuplicatas ativas/em aberto.
historicalDuplicatas do histórico.

A B3 não aceita all na criação de agenda online.

Allowed:
drawer
object
required

Identificação do Sacador.

boolean
Defaults to false

Aceite dos termos e condições da B3 pelo Agente Financiador. Quando ausente, a agenda é criada sem o aceite.

ScheduleOnlineQueryParams | null

Parâmetros de consulta opcionais.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json