{"swagger":"2.0","basePath":"/cobranca/v1","tags":[{"name":"EXTRATO FINANCEIRO: Consultas de informações financeiras"},{"name":"FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."},{"name":"LIBERAÇÕES: Consulta a liberações"},{"name":"PING: verificação da disponibilidade das APIs do Portal de Cobrança do BNDES."},{"name":"SOLICITAÇÕES: Pesquisa e consulta de solicitações de processamento (inclusive por arquivos lote) no Portal de Cobrança."},{"name":"SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."}],"definitions":{"CategoriaEntidadeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"}}},"ConfiguracaoSolicitacaoProcessamentoDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"dataPrevistaPagamentoFatura":{"type":"string","format":"date"},"prazoLimitePagamentoFatura":{"type":"integer","format":"int32"}}},"EntidadeResumoDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"},"nomePrincipal":{"type":"string"},"cpfCnpj":{"type":"string"},"idEmpresa":{"type":"string"},"indicadorMatriz":{"type":"boolean"},"codigoBNDES":{"type":"integer","format":"int64"},"sigla":{"type":"string"},"categoria":{"$ref":"#/definitions/CategoriaEntidadeDTO"}}},"IdentificadorRegistroDTO":{"type":"object","properties":{"chave":{"type":"string"},"tipo":{"type":"string","enum":["CHAVE_NAO_DEFINIDA","SUBCONTRATO_ID","ORIGEM_COBRANCA_ID","ORIGEM_COBRANCA_CHAVE_N03","SOLICITACAO_ID","SOLICITACAO_NUMERO_ARQUIVO","SOLICITACAO_ARQUIVO_MODELO_ID","EVENTO_NEGOCIO_ID","SUBCREDITO_N03_ID","SUBCREDITO_N03_NUMERO","OPERACAO_N03_ID","OPERACAO_N03_NUMERO","LIBERACAO_N03_ID","LC_N03_ID","CONTRATO_SCC_NUMERO","CONTRATO_SCC_NUMERO_RAIZ","LANCAMENTO_FATURA_ID","ARQUIVO_ID","ARQUIVO_NOME","PROCESSAMENTO_AUTOMATICO_ID","OCORRENCIA_FUNCIONALIDADE_ID","COMUNICACAO_ALERTA_CHAVE","TIPO_PROCESSAMENTO_AUTOMATICO_CHAVE","BNDES_BASE_EXCEPTION_CODIGO","USERID","SOLICITACAO_N04_ID","PROVIDENCIA_N04_ID","COMPENSACAO_FINANCEIRA_SCC_CHAVE","MODIFICACAO_CONTRATUAL_N03_ID","MODIFICACAO_CONTRATUAL_SCA_ID","ENTIDADE_ID","DADO_REPLICACAO_SCC_ID","PROCESSAMENTO_FINANCEIRO_GRUPO_N03_ID_INTERNO"]}}},"SituacaoSolicitacaoProcessamentoDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"}}},"SolicitacaoProcessamentoDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"dataSolicitacao":{"type":"string","format":"date-time"},"dataRespostaSolicitacao":{"type":"string","format":"date-time"},"numeroArquivo":{"type":"integer","format":"int64"},"situacao":{"$ref":"#/definitions/SituacaoSolicitacaoProcessamentoDTO"},"tipo":{"$ref":"#/definitions/TipoSolicitacaoProcessamentoDTO"},"entidade":{"$ref":"#/definitions/EntidadeResumoDTO"},"descricao":{"type":"string"},"chaveOrigem":{"$ref":"#/definitions/IdentificadorRegistroDTO"},"configuracao":{"$ref":"#/definitions/ConfiguracaoSolicitacaoProcessamentoDTO"},"qtdItemTotal":{"type":"integer","format":"int32"},"qtdItemRejeitado":{"type":"integer","format":"int32"}}},"TipoSolicitacaoProcessamentoDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"}}},"SolicitacaoIdentificadorItemDTO":{"type":"object","properties":{"chave":{"type":"string"},"tipo":{"type":"string","enum":["CHAVE_NAO_DEFINIDA","SUBCONTRATO_ID","ORIGEM_COBRANCA_ID","ORIGEM_COBRANCA_CHAVE_N03","SOLICITACAO_ID","SOLICITACAO_NUMERO_ARQUIVO","SOLICITACAO_ARQUIVO_MODELO_ID","EVENTO_NEGOCIO_ID","SUBCREDITO_N03_ID","SUBCREDITO_N03_NUMERO","OPERACAO_N03_ID","OPERACAO_N03_NUMERO","LIBERACAO_N03_ID","LC_N03_ID","CONTRATO_SCC_NUMERO","CONTRATO_SCC_NUMERO_RAIZ","LANCAMENTO_FATURA_ID","ARQUIVO_ID","ARQUIVO_NOME","PROCESSAMENTO_AUTOMATICO_ID","OCORRENCIA_FUNCIONALIDADE_ID","COMUNICACAO_ALERTA_CHAVE","TIPO_PROCESSAMENTO_AUTOMATICO_CHAVE","BNDES_BASE_EXCEPTION_CODIGO","USERID","SOLICITACAO_N04_ID","PROVIDENCIA_N04_ID","COMPENSACAO_FINANCEIRA_SCC_CHAVE","MODIFICACAO_CONTRATUAL_N03_ID","MODIFICACAO_CONTRATUAL_SCA_ID","ENTIDADE_ID","DADO_REPLICACAO_SCC_ID","PROCESSAMENTO_FINANCEIRO_GRUPO_N03_ID_INTERNO"]}}},"SolicitacaoItemArquivoDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"identificador":{"$ref":"#/definitions/SolicitacaoIdentificadorItemDTO"},"codigoRetorno":{"type":"string"},"detalheErro":{"type":"string"},"sucesso":{"type":"boolean"},"notSucesso":{"type":"boolean"},"chaveIdentificador":{"type":"string"},"tipoIdentificador":{"type":"string","enum":["CHAVE_NAO_DEFINIDA","SUBCONTRATO_ID","ORIGEM_COBRANCA_ID","ORIGEM_COBRANCA_CHAVE_N03","SOLICITACAO_ID","SOLICITACAO_NUMERO_ARQUIVO","SOLICITACAO_ARQUIVO_MODELO_ID","EVENTO_NEGOCIO_ID","SUBCREDITO_N03_ID","SUBCREDITO_N03_NUMERO","OPERACAO_N03_ID","OPERACAO_N03_NUMERO","LIBERACAO_N03_ID","LC_N03_ID","CONTRATO_SCC_NUMERO","CONTRATO_SCC_NUMERO_RAIZ","LANCAMENTO_FATURA_ID","ARQUIVO_ID","ARQUIVO_NOME","PROCESSAMENTO_AUTOMATICO_ID","OCORRENCIA_FUNCIONALIDADE_ID","COMUNICACAO_ALERTA_CHAVE","TIPO_PROCESSAMENTO_AUTOMATICO_CHAVE","BNDES_BASE_EXCEPTION_CODIGO","USERID","SOLICITACAO_N04_ID","PROVIDENCIA_N04_ID","COMPENSACAO_FINANCEIRA_SCC_CHAVE","MODIFICACAO_CONTRATUAL_N03_ID","MODIFICACAO_CONTRATUAL_SCA_ID","ENTIDADE_ID","DADO_REPLICACAO_SCC_ID","PROCESSAMENTO_FINANCEIRO_GRUPO_N03_ID_INTERNO"]}}},"SolicitacaoEntradaArquivoDTO":{"type":"object","properties":{"itemSolicitacaoList":{"type":"array","items":{"$ref":"#/definitions/SolicitacaoItemArquivoDTO"}},"configuracao":{"$ref":"#/definitions/ConfiguracaoSolicitacaoProcessamentoDTO"},"chaveOrigem":{"$ref":"#/definitions/IdentificadorRegistroDTO"},"descricao":{"type":"string"},"dataSolicitacao":{"type":"string","format":"date-time"},"tipo":{"$ref":"#/definitions/TipoSolicitacaoProcessamentoDTO"},"entidade":{"$ref":"#/definitions/EntidadeResumoDTO"}}}},"paths":{"/extrato-financeiro/condicao-financeira/agente-financeiro/arquivo":{"get":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Relatório: Listar arquivos de condições financeiras disponíveis.","description":"Relatório com a lista de arquivos de condições financeiras disponíveis.","operationId":"listarArquivosDadoContratual","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"dataArquivoDe","in":"query","description":"Data inicial para pesquisa no formato AAAA-MM-DD","required":false,"type":"String"},{"name":"dataArquivoAte","in":"query","description":"Data final para pesquisa no formato AAAA-MM-DD","required":false,"type":"String"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/extrato-financeiro/condicao-financeira/agente-financeiro/arquivo/data/{dataExtrato}/gerar":{"post":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Relatório: Geração de arquivo de condições financeiras em determinada data.","description":"O arquivo passa a constar na listagem e pode ser feito download","operationId":"gerarNovoArquivoDadoContratual","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"dataExtrato","in":"path","description":"Data para geração do arquivo de condições financeiras, no formato AAAA-MM-DD","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/extrato-financeiro/condicao-financeira/agente-financeiro/arquivo/{idArquivo}/download":{"get":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Relatório: Download de arquivo de condições financeiras.","description":"Download de arquivo de condições financeiras.","operationId":"downloadArquivoDadoContratual","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idArquivo","in":"path","description":"Identificador do arquivo solicitado.","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/extrato-financeiro/numeros-contratos/agente-financeiro/download":{"get":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Listagem de contratos de um agente financeiro.","description":"","operationId":"listarNumerosContratos","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/extrato-financeiro/saldo-historico/agente-financeiro/arquivo":{"get":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Listagem de arquivos disponíveis com saldos históricos para datas no período solicitado.","description":"","operationId":"listarArquivosSaldoHistorico","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"dataArquivoDe","in":"query","description":"Data inicial para pesquisa no formato AAAA-MM-DD","required":false,"type":"String"},{"name":"dataArquivoAte","in":"query","description":"Data final para pesquisa no formato AAAA-MM-DD","required":false,"type":"String"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/extrato-financeiro/saldo-historico/agente-financeiro/arquivo/{data}/gerar":{"post":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Geração de arquivo de Saldo Histórico com a data informada.","description":"O arquivo passa a constar na listagem e pode ser feito download","operationId":"gerarPorData","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"data","in":"path","description":"Data para o saldo, no formato AAAA-MM-DD.","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/extrato-financeiro/saldo-historico/agente-financeiro/arquivo/{idArquivo}/download":{"get":{"tags":["EXTRATO FINANCEIRO: Consultas de informações financeiras"],"summary":"Download de arquivo com Saldos Históricos em uma data.","description":"Download de arquivo de Saldo Histórico.","operationId":"downloadArquivoSaldoHistorico","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idArquivo","in":"path","description":"Identificador do arquivo solicitado.","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/fatura/entidade-destinatario/aguardando-pagamento":{"get":{"tags":["FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."],"summary":"Pesquisar faturas aguardando pagamento","description":"Pesquisa faturas em aberto de acordo com os parâmetros passados. Retorna lista de faturas","operationId":"getLancamentoFaturaList","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/fatura/numero-documento-mcf/{numeroDocumentoMcf}":{"get":{"tags":["FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."],"summary":"Recupera dados de uma fatura por número do documento","description":"Recupera os dados de uma fatura","operationId":"getLancamentoFaturaPorNumeroDocumentoMcf","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"numeroDocumentoMcf","in":"path","description":"Número do documento da fatura solicitada","required":true,"type":"string"},{"name":"retInformacoesAdicionaisBoleto","in":"query","description":"Indica se deve retornar linha digitável e código de barras","required":false,"type":"boolean","default":false}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/fatura/numero-documento-mcf/{numeroDocumentoMcf}/arquivo-detalhe":{"get":{"tags":["FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."],"summary":"Recuperar arquivo de detalhes de uma fatura por identificador","description":"Recuperar arquivo de detalhes de uma fatura específica","operationId":"getLancamentoFaturaAnexoPorNumeroDocumentoMcf","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"numeroDocumentoMcf","in":"path","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/fatura/solicitacao/{idSolicitacao}":{"get":{"tags":["FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."],"summary":"Pesquisar faturas geradas por uma solicitação de processamento","description":"Pesquisa faturas geradas por uma solicitação de processamento. Retorna lista de faturas","operationId":"getLancamentoFaturaPorSolicitacaoProcessamentoList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","description":"Identificador da solicitação de processamento que gerou as faturas listadas","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/fatura/{idFatura}":{"get":{"tags":["FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."],"summary":"Recupera dados de uma fatura por identificador","description":"Recupera os dados de uma fatura","operationId":"getLancamentoFaturaPorIdentificador","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idFatura","in":"path","description":"Identificador da fatura solicitada","required":true,"type":"integer","pattern":"\\d+","format":"int64"},{"name":"retInformacoesAdicionaisBoleto","in":"query","description":"Indica se deve retornar linha digitável e código de barras","required":false,"type":"boolean","default":false}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/fatura/{idFatura}/arquivo-detalhe":{"get":{"tags":["FATURAS: Consulta a faturas emitidas que se encontrem disponíveis para pagamento no Portal de Cobrança."],"summary":"Recuperar arquivo de detalhes de uma fatura por identificador","description":"Recuperar arquivo de detalhes de uma fatura específica","operationId":"downloadArquivoEntradaSolicitacao","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idFatura","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/liberacao/arquivo-extrato":{"get":{"tags":["LIBERAÇÕES: Consulta a liberações"],"summary":"Arquivo com a listagem de liberações no período solicitado.","description":"Todos os parâmetros são obrigatórios, O período máximo para solicitação é de 180 dias","operationId":"downloadArquivoAvisoCredito","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"dataLiberacaoDe","in":"query","description":"Data inicial para o relatório, no formato AAAA-MM-DD.","required":true,"type":"string"},{"name":"dataLiberacaoAte","in":"query","description":"Data final para o relatório, no formato AAAA-MM-DD.","required":true,"type":"string"},{"name":"somenteContratosMCF","in":"query","description":"Retornar somente contratos MCF. Default false","required":false,"type":"boolean","default":true}],"responses":{"default":{"description":"successful operation"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/sistema/ping":{"get":{"tags":["PING: verificação da disponibilidade das APIs do Portal de Cobrança do BNDES."],"summary":"Realizar ping","description":"Verifica disponibilidade das APIS do sistema de cobrança. Retorna a data e hora do servidor.","operationId":"ping","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Sistema disponível"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/solicitacao":{"get":{"tags":["SOLICITAÇÕES: Pesquisa e consulta de solicitações de processamento (inclusive por arquivos lote) no Portal de Cobrança."],"summary":"Pesquisar solicitação","description":"Pesquisa solicitações de processamento de acordo com os parâmetros passados. Retorna lista de solicitações.","operationId":"getSolicitacaoProcessamentoList","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Lista de solicitações de acordo com critérios pesquisados"},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/solicitacao/arquivo-lote/arquivo-entrada-temp":{"post":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Anexar arquivo lote de entrada temporário à solicitação","description":"Anexar arquivo lote de entrada temporário à uma solicitação específica.","operationId":"uploadArquivoTemporario","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"idTipoSolicitacao","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Arquivo lote de entrada temporário anexado à solicitação","schema":{"$ref":"#/definitions/SolicitacaoItemArquivoDTO"}},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_write","x-throttling-tier":"Unlimited","security":[{"default":["pcb_write"]}]}},"/solicitacao/arquivo-lote/nova":{"post":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Criar nova solicitação de processamento de arquivo lote","description":"Criar nova solicitação de processamento de arquivo lote.","operationId":"criaSolicitacaoProcessamento","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SolicitacaoEntradaArquivoDTO"}}],"responses":{"200":{"description":"Solicitação de processamento criada","schema":{"$ref":"#/definitions/SolicitacaoProcessamentoDTO"}},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_write","x-throttling-tier":"Unlimited","security":[{"default":["pcb_write"]}]}},"/solicitacao/arquivo-lote/{idSolicitacao}/arquivo-entrada":{"get":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Recuperar arquivo lote de entrada de solicitação","description":"Recuperar arquivo lote de entrada de uma solicitação específica.","operationId":"downloadArquivoEntradaSolicitacao_0","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Arquivo de entrada recuperado"},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]},"post":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Anexar arquivo lote de entrada à solicitação","description":"Anexar arquivo lote de entrada à uma solicitação específica.","operationId":"uploadArquivoSolicitacao","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Arquivo de entrada anexado à solicitação"},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_write","x-throttling-tier":"Unlimited","security":[{"default":["pcb_write"]}]}},"/solicitacao/arquivo-lote/{idSolicitacao}/arquivo-resultado":{"get":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Recuperar arquivo lote de resultado de processamento de solicitação","description":"Recuperar arquivo lote de resultado de processamento de uma solicitação específica.","operationId":"downloadArquivoResultadoSolicitacao","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Arquivo de resultado de processamento recuperado"},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}},"/solicitacao/arquivo-lote/{idSolicitacao}/cancela":{"post":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Cancelar solicitação de processamento de arquivo lote","description":"Cancelar uma solicitação de processamento de arquivo lote específica.","operationId":"cancelaSolicitacao","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Solicitação de processamento de arquivo lote cancelada","schema":{"$ref":"#/definitions/SolicitacaoProcessamentoDTO"}},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_write","x-throttling-tier":"Unlimited","security":[{"default":["pcb_write"]}]}},"/solicitacao/arquivo-lote/{idSolicitacao}/finaliza":{"post":{"tags":["SOLICITAÇÕES POR ARQUIVO LOTE: Manipulação de solicitações de processamento por troca de arquivos lote."],"summary":"Finalizar solicitação de processamento de arquivo lote","description":"Finalizar uma solicitação de processamento de arquivo lote específica.","operationId":"finalizaSolicitacao","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Solicitação de processamento de arquivo lote finalizada","schema":{"$ref":"#/definitions/SolicitacaoProcessamentoDTO"}},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_write","x-throttling-tier":"Unlimited","security":[{"default":["pcb_write"]}]}},"/solicitacao/{idSolicitacao}":{"get":{"tags":["SOLICITAÇÕES: Pesquisa e consulta de solicitações de processamento (inclusive por arquivos lote) no Portal de Cobrança."],"summary":"Recuperar detalhes de solicitação","description":"Recupera detalhes de uma solicitação específica.","operationId":"getSolicitacaoProcessamento","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"idSolicitacao","in":"path","description":"Identificador da solicitação de processamento","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Solicitação de processamento recuperada","schema":{"$ref":"#/definitions/SolicitacaoProcessamentoDTO"}},"403":{"description":"Usuário sem acesso ao recurso solicitado"}},"x-auth-type":"Application & Application User","x-scope":"pcb_read","x-throttling-tier":"Unlimited","security":[{"default":["pcb_read"]}]}}},"x-wso2-security":{"apim":{"x-wso2-scopes":[{"description":"Acesso de leitura às APIs do novo sistema de cobrança do BNDES","name":"pcb_read","roles":"pcb_af_api_r,pcb_af_api_rw","key":"pcb_read"},{"description":"Acesso de escrita às APIs do novo sistema de cobrança do BNDES","name":"pcb_write","roles":"pcb_af_api_rw","key":"pcb_write"}]}},"info":{"title":"swagger","version":"v1"},"host":"apis-gateway.bndes.gov.br","schemes":["https","http"],"securityDefinitions":{"default":{"type":"oauth2","authorizationUrl":"https://apis-gateway.bndes.gov.br/authorize","flow":"implicit","scopes":{"pcb_read":"pcb_read","pcb_write":"pcb_write"}}}}