Sign in

v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB
API de Webhook

Webhook de retorno com processamento de um lote solicitado.

post/v2/webhook/lote-finalizado

Request body

idstring required

Código de identificação do lote

status'PROCESSANDO' | 'PROCESSADO' | 'REJEITADO' | 'ERRO' required

Status do lote

tipo'CADASTRO_SACADOR' | 'CADASTRO_SACADO' | 'ATUALIZACAO_CADASTRO_SACADOR' | 'ESCRITURACAO_DUPLICATA_FATURA' | 'ESCRITURACAO_DUPLICATA_CHAVE' | 'ESCRITURACAO_DUPLICATA_XML' | 'ALTERACAO_DUPLICATA' | 'MANUTENCAO_DOCUMENTO_FISCAL' | 'MANUTENCAO_INSTRUMENTO_PAGAMENTO' | 'INATIVACAO_DUPLICATA' | 'PAGAMENTO_DUPLICATA' | 'OPTIN_AGENDA_ORIGINADOR' | 'OPTIN_AGENDA_TITULAR' | 'OPTOUT_AGENDA' | 'MANIFESTACAO_SACADO - CRIACAO_CONTRATO' | 'ATUALIZACAO_CONTRATO' | 'ENCERRAMENTO_CONTRATO' required

Tipo de Lote de Processamento.

total_itens_recebidosinteger required

Total de itens recebidos no lote

total_itens_processadosinteger required

Total de itens processados no lote

total_itens_invalidosinteger required

Total de itens inválidos no lote

data_finalizacaostring date-time

Data de finalização do lote

data_criacaostring date-time required

Data de criação do lote

Response

Finalização do lote recebida com sucesso pelo Participante.