Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) Projeto IPN – Integração da Pós-Negociação Especificação Técnica das Alterações de Modelo de Negócio e de Processos para a Clearing de Renda Variável e Renda Fixa Privada (v2) SINACOR Especificação Técnica para Consumo de Informações do SINACOR através do uso de Serviços A implantação da 2ª Fase do Projeto de Integração das Clearings depende da aprovação dos órgãos reguladores. 1 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) Sumário 1 Introdução ............................................................................................................................. 4 2 Histórico de Revisão .............................................................................................................. 5 3 Service Contract Ordem ........................................................................................................ 6 3.1 Operation Contract Consultar ....................................................................................... 6 3.1.1 3.2 Operation Contract Incluir ............................................................................................ 7 3.2.1 3.3 Informações adicionais para utilização dos contratos .......................................... 9 Operation Contract Cancelar ...................................................................................... 11 3.4.1 4 Informações adicionais para utilização dos contratos .......................................... 8 Operation Contract Alterar ........................................................................................... 9 3.3.1 3.4 Informações adicionais para utilização dos contratos .......................................... 6 Informações adicionais para utilização dos contratos ........................................ 11 3.5 Data Contract ConsultaRequest .................................................................................. 12 3.6 Data Contract ConsultaResponse ................................................................................ 13 3.7 Data Contract OrdemConsulta .................................................................................... 14 3.8 Data Contract Erro....................................................................................................... 16 3.9 Data Contract OrdemRequest ..................................................................................... 16 3.10 Data Contract OrdemResponse................................................................................... 17 3.11 Data Contract CancelamentoRequest ......................................................................... 17 Service Contract Distribuição .............................................................................................. 18 4.1 Operation Contract Distribuir ..................................................................................... 18 4.1.1 4.2 Informações adicionais para utilização dos contratos ........................................ 18 Operation Contract Cancelar ...................................................................................... 20 4.2.1 Informações adicionais para utilização dos contratos ........................................ 20 4.3 Data Contract DistribuicaoRequest ............................................................................. 20 4.4 Data Contract Distribuicao .......................................................................................... 21 4.5 Data Contract DistribuicaoResponse .......................................................................... 22 4.6 Data Contract CancelamentoRequest ......................................................................... 22 2 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 4.7 Data Contract Erro....................................................................................................... 22 3 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 1 Introdução O objetivo do documento é apresentar a lista de Serviços Públicos do SINACOR e suas respectivas características de uso para consumo de informações do SINACOR. Os respectivos serviços serão disponibilizados no SINACOR em decorrência da fase 2 do Projeto de Integração das Clearings. 4 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 2 Histórico de Revisão Data 15/07/2015 Versão 1.0 Alterações Versão Inicial 5 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3 Service Contract Ordem 3.1 Operation Contract Consultar Serviço que permite consultar uma ordem ou um conjunto de ordens registradas no SINACOR. 3.1.1 Informações adicionais para utilização dos contratos Data Contract ConsultaRequest DataPregaoInicial OBSERVAÇÃO O único campo obrigatório no filtro de consulta. Data Contract ConsultaResponse ListaOrdemConsulta OcorreuErro ListaErro OBSERVAÇÃO Estará preenchido se a consulta retornar dados Retorna o status da consulta e será sempre preenchido Se OcorreuErro for TRUE, retorna uma lista de Data Contract ERRO 6 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3.2 Operation Contract Incluir Serviço que permite incluir Ordens (ofertas) no SINACOR. 7 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3.2.1 Informações adicionais para utilização dos contratos Data Contract OrdemRequest CodigoIdentificadorOperaca o ContaCliente CodigoNegociacao SenderLocation OBSERVAÇÃO Campo obrigatório Campo opcional Campo obrigatório Campo opcional EnteringTrader Campo opcional DataPregao DataValidadeOrdem NaturezaOperacao PrazoDiaMercadoTermo DataHoraRegistroOrdem Quantidade Preco Campo obrigatório Campo opcional Campo obrigatório Campo obrigatório se o instrumento for referente a mercado a termo Campo opcional Campo obrigatório Campo obrigatório. Deve-se informar o preço caso o Tipo da Ordem seja Limitada ou Stop. Caso contrário, informar null Campo obrigatório Campo opcional Campo opcional Campo opcional TipoOrdem Texto Memo Justificativa Data Contract OrdemResponse OBSERVAÇÃO CodigoIdentificadorOperacao Preenchido sempre com a informação recebida no request NumeroOrdem Retorna o Número da Ordem criada OcorreuErro Retorna o status da inclusão. Será sempre preenchido. ListaErro Se OcorreuErro for TRUE, retorna uma lista de Data Contract ERRO 8 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3.3 Operation Contract Alterar Serviço que permite alterar ordens (ofertas) registradas no SINACOR. Ao contrário da inclusão de uma ordem, os atributos a serem enviados são todos obrigatórios, devendo-se enviar inclusive os valores já salvos no sistema (conceito de arquitetura desconectada). 3.3.1 Informações adicionais para utilização dos contratos 9 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) Data Contract OrdemRequest OBSERVAÇÃO CodigoIdentificadorOperacao Campo obrigatório ContaCliente Campo obrigatório e alterável CodigoNegociacao Campo obrigatório, mas não alterável SenderLocation Campo obrigatório, mas não alterável EnteringTrader Campo obrigatório, mas não alterável DataPregao DataValidadeOrdem NaturezaOperacao PrazoDiaMercadoTermo DataHoraRegistroOrdem Quantidade Preco TipoOrdem Texto Memo Justificativa Campo obrigatório, mas não alterável Campo obrigatório e alterável Campo obrigatório, mas não alterável Campo obrigatório, mas não alterável Campo obrigatório, mas não alterável Campo obrigatório e alterável Campo obrigatório e alterável Campo obrigatório e alterável Campo obrigatório e alterável Campo obrigatório e alterável Campo obrigatório e alterável. Se não quiser justificar, passar null no campo Data Contract OrdemResponse OBSERVAÇÃO CodigoIdentificadorOperacao Preenchido sempre com a informação recebida no request NumeroOrdem Retorna o Número da Ordem OcorreuErro Retorna o status da alteração. Será sempre preenchido. ListaErro Se OcorreuErro for TRUE, retorna uma lista de Data Contract ERRO 10 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3.4 Operation Contract Cancelar Serviço que permite cancelar Ordens (ofertas) registradas no SINACOR. 3.4.1 Informações adicionais para utilização dos contratos Data Contract CancelamentoRequest OBSERVAÇÃO CodigoIdentificadorOperacao Obrigatório NumeroOrdem Obrigatório 11 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3.5 Data Contract ConsultaRequest DESCRIÇÃO NumeroOrdem DataPregaoInicial DataPregaoFinal CodigoNegociacao MercadoInstrumento TIPO CAMPO E TAMANHO NUMBER (15) DATE Número da Ordem Data do Pregão da ordem | Data de Referência. Deve ser menor ou igual à DataPregaoFinal Segunda data do pregão para DATE efetuar busca por período. Se for informada somente a DataPregaoInicial, o Sistema presumirá a mesma data informada na DataPregaoInicial Código de Negociação do VARCHAR2 (20) instrumento da ordem. Ex: PETR4 Mercado do qual o NUMBER(4) instrumento de negociação faz parte VALORES POSSÍVEIS N/A N/A N/A N/A (ex: PETR4) 1 (Disponível) 2 (Futuro) 3 (Opção sobre disponível) 4 (Opção sobre futuro) 5 (Termo) 8 (ETF primário) 10 (Vista) 12 (Exercício de opção de compra) 13 (Exercício de opção de venda) 17 (Leilão) 20 (Fracionário) 30 (Termo) 70 (Opção de compra) 80 (Opção de venda) 81 (Swap) 82 (Opção flexível de venda) 83 (Opção flexível de compra) 84 (Termo de balcão) 85 (Indicadores 12 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) NaturezaOperacao VARCHAR(1) TipoOrdem Código da Natureza da Operação da Ordem Código Evento Origem da ordem Código Tipo da Ordem IndicadorOrdemAtiva Indicador de Ordem Ativa VARCHAR (1) Memo IndicadorPessoaVinculada Campo MEMO da ordem Indicador de Pessoa Vinculada VARCHAR(50) VARCHAR(1) Integrada Indicador se a Ordem está integrada para o módulo atual VARCHAR(1) SenderLocation Identificador SenderLocation, VARCHAR(50) referente à trinca do operador Identificador EnteringTrader, VARCHAR(50) referente à trinca do operador Apelido do Operador da ordem VARCHAR(28) OrigemOrdem EnteringTrader ApelidoOperador VARCHAR(1) NUMBER (2) econômicos) 86 (Curvas de desconto) 87 (Superfícies de volatilidade) 91 (Aluguel) 9999 (Outros) C (compra) V (venda) A (Automática) M (Manual) 1 (Mercado) 2 (Casada) 3 (Administrada) 5 (Limitada) 6 (Financiamento) 7 (Stop) 8 (Monitorada) S (ativa) N (cancelada) N/A S (vinculada) N (não vinculada) S (integrada) N (não integrada) N/A N/A N/A 3.6 Data Contract ConsultaResponse DESCRIÇÃO ListaOrdemConsulta OcorreuErro ListaErro Lista de Data Contract OrdemConsulta com o resultado da pesquisa Retorna o status da consulta. Se OcorreuErro for TRUE, retorna uma lista de Data Contracts ERRO TIPO CAMPO E TAMANHO Data Contract OrdemConsulta VALORES POSSÍVEIS N/A BOOLEAN Data Contract Erro N/A N/A 13 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 3.7 Data Contract OrdemConsulta DESCRIÇÃO NumeroOrdem ContaCliente TipoOrdem CodigoNegociacao MercadoInstrumento Número da Ordem Código Identificador da Conta Cliente Código Tipo da Ordem TIPO CAMPO E TAMANHO NUMBER (15) VARCHAR (15) VALORES POSSÍVEIS N/A N/A NUMBER (2) 1 (Mercado) 2 (Casada) 3 (Administrada) 5 (Limitada) 6 (Financiamento) 7 (Stop) 8 (Monitorada) N/A Código de Negociação do VARCHAR (20) instrumento da ordem. Mercado do qual o NUMBER(4) instrumento de negociação faz parte 1 (Disponível) 2 (Futuro) 3 (Opção sobre disponível) 4 (Opção sobre futuro) 5 (Termo) 8 (ETF primário) 10 (Vista) 12 (Exercício de opção de compra) 13 (Exercício de opção de venda) 17 (Leilão) 20 (Fracionário) 30 (Termo) 70 (Opção de compra) 80 (Opção de venda) 81 (Swap) 82 (Opção fexível de venda) 83 (Opção flexível de compra) 84 (Termo de balcão) 85 (Indicadores 14 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) ApelidoOperador IndicadorOrdemAtiva Apelido do Operador da ordem VARCHAR(28) Indicador de Ordem Ativa VARCHAR (1) OrigemOrdem Código Evento Origem da ordem Data do Pregão da ordem | Data de Referência Data de Validade da ordem VARCHAR(1) Data/Hora do Registro da Ordem Código da Natureza da Operação da Ordem DATE DataPregao DataValidadeOrdem DataHoraRegistroOrdem NaturezaOperacao DATE DATE econômicos) 86 (Curvas de desconto) 87 (Superfícies de volatilidade) 91 (Aluguel) 9999 (Outros) N/A S (ativa) N (cancelada) A (Automática) M (Manual) N/A Data padrão dd/mm/aaaa 31/12/9999 (VAC) N/A VARCHAR(1) C (compra) V (venda) Prazo em dias do instrumento quando o instrumento for mercado a termo Quantidade Quantidade da ordem SaldoCancelado Quantidade do saldo cancelado da ordem QuantidadeCasada Quantidade casada da ordem (com N negócios) QuantidadeDisponivelCasar Quantidade disponível para casar (quantidade da ordem quantidade cancelada quantidade casada) NomeEmissor Nome do Emissor da Ordem, quando disponível IndicadorOrdemDiscricionari Indicador de Ordem a Discricionária NUMBER(3) N/A NUMBER(16,4) NUMBER(16,4) N/A N/A NUMBER(16,4) N/A NUMBER(16,4) N/A VARCHAR(30) N/A VARCHAR(1) IndicadorPessoaVinculada Indicador de Pessoa Vinculada VARCHAR(1) Preco Integrada Valor do preço da ordem Indicador se a Ordem está integrada para o módulo atual NUMBER(19,8) VARCHAR(1) SenderLocation Identificador SenderLocation, referente à trinca do operador Identificador EnteringTrader, VARCHAR(50) S (discricionária) N (não discricionária) S (vinculada) N (não vinculada) N/A S (integrada) N (não integrada) N/A VARCHAR(50) N/A PrazoDiaMercadoTermo EnteringTrader 15 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) Memo referente à trinca do operador Campo MEMO da ordem VARCHAR(50) N/A TIPO CAMPO E TAMANHO NUMBER(5) VARCHAR(100) VALORES POSSÍVEIS N/A N/A TIPO CAMPO E TAMANHO VARCHAR (40) VALORES POSSÍVEIS N/A NUMBER(15) VARCHAR (15) N/A N/A VARCHAR(20) N/A VARCHAR(50) N/A VARCHAR(50) N/A DATE N/A DATE Data padrão dd/mm/aaaa ou 31/12/9999 (VAC) C (compra) V (venda) 3.8 Data Contract Erro DESCRIÇÃO CodigoErro Descricao Código do Erro Descrição do Erro 3.9 Data Contract OrdemRequest DESCRIÇÃO CodigoIdentificadorOperacao Código Identificador da Operação (GUID). Sequencial que irá identificar a resposta relativa a uma solicitação NumeroOrdem Número da Ordem ContaCliente Código Identificador da Conta Cliente CodigoNegociacao Código de Negociação do instrumento da ordem. Ex: PETR4 SenderLocation Identificador SenderLocation, referente à trinca do operador EnteringTrader Identificador EnteringTrader, referente à trinca do operador DataPregao Data do Pregão da ordem | Data de Referência DataValidadeOrdem Data de Validade da ordem. Se não informado, o Sistema considera o mesmo valor do atributo DataPregao NaturezaOperacao Código da Natureza da Operação da Ordem PrazoDiaMercadoTermo DataHoraRegistroOrdem Quantidade Preco Prazo em dias do instrumento quando este for de mercado a termo Data/Hora do Registro da Ordem Quantidade da ordem Valor do preço da ordem. Ao informar o preço, o Tipo da Ordem deve ser Limitada ou VARCHAR(1) NUMBER(3) N/A DATE N/A NUMBER(16,4) NUMBER(19,8) N/A N/A 16 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) TipoOrdem Texto Memo Justificativa Stop Código Tipo da Ordem. Quando for informado o preço da ordem, esta deverá ser Limitada ou Stop. Campo TEXTO da ordem Campo MEMO da ordem Justificativa da ordem NUMBER (2) VARCHAR(250) VARCHAR(50) VARCHAR(200) 1 (Mercado) 2 (Casada) 3 (Administrada) 5 (Limitada) 6 (Financiamento) 7 (Stop) 8 (Monitorada) N/A N/A N/A TIPO CAMPO E TAMANHO VARCHAR (40) VALORES POSSÍVEIS N/A NUMBER (15) BOOLEAN N/A N/A Data Contract Erro N/A TIPO CAMPO E TAMANHO VARCHAR (40) VALORES POSSÍVEIS N/A NUMBER (15) N/A 3.10 Data Contract OrdemResponse DESCRIÇÃO CodigoIdentificadorOperacao Código Identificador da Operação (GUID). Sequencial que irá identificar a resposta relativa a uma solicitação NumeroOrdem Número da Ordem OcorreuErro Retorna o status da transação executada. ListaErro Se OcorreuErro for TRUE, retorna uma lista de Data Contract ERRO 3.11 Data Contract CancelamentoRequest ORDEMCANCELAMENTO DESCRIÇÃO CodigoIdentificadorOperacao Código Identificador da Operação (GUID). Sequencial que irá identificar a resposta relativa a uma solicitação NumeroOrdem Número da Ordem a ser cancelada 17 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 4 Service Contract Distribuição 4.1 Operation Contract Distribuir Serviço que permite realizar uma distribuição no SINACOR de acordo com os algoritmos de distribuição. A distribuição pode ocorrer informando um Lote já criado no SINACOR ou a partir da Data de Pregão, Natureza da Operação (Compra/Venda) e Código da Negociação. Escolhendo esta última opção, o SINACOR irá criar um lote e realizar a distribuição. 4.1.1 Informações adicionais para utilização dos contratos 18 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) Data Contract DistribuicaoRequest CodigoIdentificadorOperaca o NomeLote DataPregao NaturezaOperacao CodigoNegociacao ListaDistribuicao OBSERVACAO Campo obrigatório Campo obrigatório se não for Informado DataPregao, NaturezaOperacao e CodigoNegociacao Campo obrigatório se não for Informado NomeLote Campo obrigatório se não for Informado NomeLote Campo obrigatório se não for Informado NomeLote Campo obrigatório Data Contract Distribuicao Algoritmo ContaCliente Quantidade ValorPreco Percentual CodigoCarteira CodigoCustodiante ContaClienteCustodiante CotacaoDolar TipoDirecionamento PercentualCorretagem OBSERVACAO Campo obrigatório Campo obrigatório Campo obrigatório se o algoritmo informado for “D” ou “M” Campo obrigatório se o algoritmo informado for “D” Campo obrigatório se o algoritmo informado for “P” Campo opcional. Será utilizado o default do cadastro quando não for informado Campo opcional. Será utilizado o default do cadastro quando não for informado Campo opcional. Será utilizado o default do cadastro quando não for informado Campo opcional. Será utilizado o default do cadastro quando não for informado Campo opcional Campo opcional Data Contract DistribuicaoResponse OBSERVAÇÃO CodigoIdentificadorOperacao Preenchido sempre com a informação recebida no request NomeLote Retorna o Nome do Lote gerado ou que foi passado no request OcorreuErro Retorna o status da distribuição. Será sempre preenchido. ListaErro Se OcorreuErro for TRUE, retorna uma lista de Data Contract ERRO 19 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 4.2 Operation Contract Cancelar Serviço que permite cancelar uma distribuição já efetuada no SINACOR. 4.2.1 Informações adicionais para utilização dos contratos Data Contract CancelamentoRequest OBSERVAÇÃO CodigoIdentificadorOperacao Campo obrigatório NomeLote Campo obrigatório 4.3 Data Contract DistribuicaoRequest DESCRIÇÃO CodigoIdentificadorOperaca o Código Identificador da Operação (GUID). Sequencial TIPO CAMPO E TAMANHO VARCHAR (40) VALORES POSSÍVEIS N/A 20 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) que irá identificar a resposta relativa a uma solicitação NomeLote DataPregao NaturezaOperacao CodigoNegociacao ListaDistribuicao Nome do lote de distribuição Data do Pregão da ordem | Data de Referência Código da Natureza da Operação da Ordem Código de Negociação do instrumento da ordem. Ex: PETR4 Lista com a distribuição VARCHAR(60) DATE N/A N/A VARCHAR(1) C (compra) V (venda) N/A (ex: PETR4) VARCHAR2 (20) Data Contract Distribuicao N/A TIPO CAMPO E TAMANHO VARCHAR(1) VARCHAR (15) VALORES POSSÍVEIS D (quantidade x preço) M (preço médio) P (percentual) N/A NUMBER(16,4) N/A NUMBER(19,8) N/A NUMBER(7,4) N/A NUMBER(5) NUMBER(5) VARCHAR(15) N/A N/A N/A NUMBER(19,8) N/A NUMBER(2) 1 (Normal) 2 (Custodiante) 3 (ADR) NUMBER(12,8) N/A 4.4 Data Contract Distribuicao DESCRIÇÃO Algoritmo Código do tipo de execução da digitação, ou seja, qual o algoritmo utilizado ContaCliente Código Identificador da Conta Cliente para qual a distribuição foi atribuída Quantidade da distribuição, caso o algoritmo utilizado tenha sido QuantidadeXPreço ou Preço Médio Valor da distribuição, caso o algoritmo utilizado tenha sido QuantidadeXPreço Percentual da distribuição, caso o algoritmo utilizado tenha sido Percentual. Código da carteira Código custodiante Código de identificação da conta cliente do custodiante Cotação do dólar. Se não informado, sistema assume "1" Código do Tipo de Direcionamento da digitação. Se não informado, sistema assume “1” Normal Percentual de acréscimo da corretagem Quantidade ValorPreco Percentual CodigoCarteira CodigoCustodiante CodigoClienteCustodiante CotacaoDolar TipoDirecionamento PercentualCorretagem 21 Projeto IPN – Integração da Pós-Negociação Clearing de Renda Variável e Renda Fixa Privada (v2) 4.5 Data Contract DistribuicaoResponse DESCRIÇÃO CodigoIdentificadorOperacao Código Identificador da Operação (GUID). Sequencial que irá identificar a resposta relativa a uma solicitação NomeLote Nome do lote de distribuição OcorreuErro Retorna o status da Distribuição. ListaErro Se OcorreuErro for TRUE, retorna uma lista de Data Contracts ERRO TIPO CAMPO E TAMANHO VARCHAR (40) VALORES POSSÍVEIS N/A VARCHAR(60) BOOLEAN N/A N/A Data Contract Erro N/A TIPO CAMPO E TAMANHO VARCHAR (40) VALORES POSSÍVEIS N/A VARCHAR(60) N/A TIPO CAMPO E TAMANHO NUMBER(5) VARCHAR(100) VALORES POSSÍVEIS N/A N/A 4.6 Data Contract CancelamentoRequest DESCRIÇÃO CodigoIdentificadorOperacao Código Identificador da Operação (GUID). Sequencial que irá identificar a resposta relativa a uma solicitação NomeLote Nome do lote de distribuição 4.7 Data Contract Erro DESCRIÇÃO CodigoErro Descricao Código do Erro Descrição do Erro 22