GUIA API BTB /04/2019 INFORMAÇÃO PÚBLICA

Transcrição

1 05/04/019

2 SUMÁRIO 1 HISTÓRICO DE VERSÕES... 4 INTRODUÇÃO VISÃO GERAL Verbos HTTP API - BTB Uso do POST Uso do GET Endpo Restrições ENDEREÇOS DA API DO BTB SWAGGER APIS BTB Order Inclusão de ordem Fechamento Doador Fechamento Tomador Cancelar Ordem Cancelar todas as ordens Consultar Ordem... 15

3 6.1.7 Consultar Lista de Ordens Consultar Situação da Ordem Book Consultar Ofertas Disponíveis Consultar Melhores Ofertas Consultar Instrumentos Trade Consultar Negócios Realizados Consultar Negócio Consultar Lista de Negócios Consultar Situação do Negócio Event Consultar Eventos FLUXOS DE NEGÓCIO SEGURANÇA Mutual SSL (Two Way SSL) Pinagem de certificado Token de assinatura AWS (Amazon Web Services)

4 1 HISTÓRICO DE VERSÕES Data Versão Descrição Fevereiro/ Versão Inicial Abril/019.0 Formas de utilização, segurança e fluxo de negócios 4

5 INTRODUÇÃO A API do BTB 1.0 disponibiliza endpos web, construídos no padrão REST (Representational State Transfer), que viabilizam a realização de acesso e operação no sistema BTB - Negociação Eletrônica de Empréstimo de Ativos, desenvolvido pela [B] 3, para consulta de cotações, envio, agressão de ordens, e consulta de lista de ordens próprias. As APIs (Application Programming Interface) WEB possibilitam aos s do BTB que não possuem acesso direto às redes privadas da [B] 3, desenvolverem suas aplicações no padrão server-to-server, para automatizarem seus processos de negociação de empréstimo de ativos. 3 VISÃO GERAL 3.1 Verbos HTTP API - BTB Para as APIs do BTB serão utilizados somente os verbos GET (para recuperar mensagens) e POST (Para enviar mensagens). Os verbos HTTP DELETE, PUT e HEAD não são suportados. 5

6 3. Uso do POST 6

7 3.3 Uso do GET 3.4 Endpo URI base (todas as URIs iniciam com): /BTBWebApi/api/v1.0/ Exemplo de uma URL completa, para o ambiente de produção, referente a mensagem order/entry : Restrições Estamos avaliando restrições para o uso de alguns dos métodos disponibilizados e devemos informar maiores detalhes em momento oportuno. Os métodos em avaliação estão destacados no item 6 APIS BTB. 7

8 4 ENDEREÇOS DA API DO BTB A B3 possui dois ambientes, um dedicado a certificação dos s e outro ambiente dedicado à produção. Seguem os endereços para conexão referente a cada ambiente: Certificação: Será divulgado assim que estiver disponível. Produção: Será divulgado assim que estiver disponível. 5 SWAGGER A documentação técnica detalhada das APIs do BTB está disponível no Swagger em: Aba: Material de apoio > Link: REST API Swagger 6 APIS BTB Abaixo estão listadas as mensagens, com a estrutura dos atributos e domínios que podem ser utilizados no processo de negociação eletrônica de empréstimos. O arquivo Swagger, fornece estes mesmos métodos e parâmetros. 8

9 6.1 Order Inclusão de ordem Verbo Método Descrição POST order/entry Inclusão de ordem Inclui uma ordem no livro de ofertas Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 Participante 1..1 Número identificação Party/code Número identificação Sim string Investidor Party/Account/number Investidor do de negociação Sim string 35 3 do custodiante do instrumento 0..1 Custodiante Custodian/code Agente de custódia string Investidor custodiante Custodian/Account/number Investidor do agente de custódia string Código de negociação Security/symbol Código de negociação Sim string Prazo de liquidação Offer/daysToSettlementIndicator Prazo de liquidação 0 - D D+1 Sim 1 4 da ordem 0..1 Indicador de ordem certificada Offer/certifiedOfferIndicator Indicador de ordem certificada True - Sim False - Sim boolean Quantidade Offer/quantity Quantidade de ativos para alugar Sim BigInt 1..1 Taxa Offer/rate Taxa Sim Decimal (11,5) 1..1 Data de validade Offer/expirationDate Data de validade da ordem Sim date

10 1..1 Tipo de ordem Offer/OfferType/code Tipo de ordem 1 - Doadora - Tomadora Sim string Carteira Offer/Finality/code Carteira de origem/destino dos ativos Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 Status Requisição 0..1 Número da ordem Offer/code Número da ordem string Situação da ordem Offer/offerStatus Situação da ordem 1 - Cancelada 9 - Fechada 11 - Disponível 3 - Aguardando Autorização Custodiante 34 - Rejeitada 60 - Aguardando Autorização Carrying 70 - Ordem em processamento pela clearing 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros-mensageria- Maio-018.xls - [Empréstimo de Ativo] 6.1. Fechamento Doador Verbo Método Descrição POST order/hitlender Fechamento Doador Agride uma ordem doadora específica no livro de ofertas

11 Requisição: 1 Participante 1..1 Nome Swagger Definição do Atributo Domínio Obrigatório? Número identificação tomador BorrowerParty/code 1..1 Investidor tomador BorrowerParty/Account/number Número identificação tomador Investidor do de negociação tomador Tipo de Tamanho Sim string 35 Sim string 35 do custodiante 0..1 Custodiante tomador BorrowerCustodian/code Custodiante tomador string 35 BorrowerCustodian/Account/number 0..1 Investidor do custodiante tomador Investidor do custodiante tomador string Número da ordem doadora LenderOffer/code Número da ordem doadora Sim string 35 3 da ordem 1.1 Quantidade LenderOffer/quantity Quantidade de ativos para tomar Sim BigInt 0.1 Carteira do tomador LenderOffer/BorrowerFinality/code Carteira de destino dos ativos no tomador Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 0..1 Número do negócio Trade/code Número do negócio string 35 1 do Negócio 0..1 Situação do negócio Trade/tradeStatus Situação do negócio 4 - Fechado 7 - Rejeitado 48 - Aguardando autorização 65 - Aguardando validação clearing 6 - Em processamento pela Clearing 71 - Cancelado

12 Status Requisição 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros-mensageria-maio- 018.xls - [Empréstimo de Ativo] Fechamento Tomador Verbo Método Descrição POST order/hitborrower Fechamento Tomador Agride uma ordem tomadora específica no livro de ofertas Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 Participante 1..1 Número identificação doador LenderParty/code 1..1 Investidor doador LenderParty/Account/number Número identificação doador Investidor do de negociação doador Sim string 35 Sim string 35 do custodiante 0..1 Custodiante doador LenderCustodian/code Custodiante doador string Investidor do custodiante doador LenderCustodian/Account/number Investidor do custodiante doador string Número da ordem tomadora BorrowerOffer/code Número da ordem tomadora Sim string 35 3 da ordem 1.1 Quantidade BorrowerOffer/quantity Quantidade de ativos para alugar Sim BigInt 1.1 Indicador de ordem certificada BorrowerOffer/certifiedOfferIndicator Indicador de ordem certificada True - Sim False - Sim boolean 1

13 0.1 Carteira do doador BorrowerOffer/LenderFinality/code Carteira de origem dos ativos no doador Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 0..1 Número do negócio Trade/code Número do negócio string 35 1 do Negócio Status Requisição 0..1 Situação do negócio Trade/tradeStatus Situação do negócio 0..1 Código de erro BusinessStatus/code Código de erro 4 - Fechado 7 - Rejeitado 48 - Aguardando autorização 65 - Aguardando validação clearing 6 - Em processamento pela Clearing 71 - Cancelado br/manuais/download/codigoserros-mensageria- Maio-018.xls - [Empréstimo de Ativo] Cancelar Ordem Verbo Método Descrição POST order/cancel Cancelar Ordem - Cancela uma ordem específica no livro de ofertas Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 da ordem 1..1 Número da ordem Offer/code Número da ordem a ser cancelada Sim string 35

14 Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1..1 Número da ordem Offer/code Número da ordem Sim string 35 1 Status Requisição 0..1 Situação da ordem Offer/offerStatus Situação da ordem 0..1 Código de erro BusinessStatus/code Código de erro 1 - Cancelada 9 - Fechada 11 - Disponível 3 - Aguardando Autorização Custodiante 34 - Rejeitada 60 - Aguardando Autorização Carrying 70 - Em processamento pela clearing br/manuais/download/codigoserros-mensageria- Maio-018.xls - [Empréstimo de Ativo] Cancelar todas as ordens Verbo Método Descrição POST order/cancel/all Cancelar Todas as Ordens - Cancela todas as ordens de um específico disponíveis no livro de ofertas

15 Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 Participante 1..1 Número identificação Party/code Número identificação Sim string 35 Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 Status Requisição 0..1 Situação da solicitação Offer/offerStatus Situação da solicitação 6 - Em processamento pela Clearing 0..1 Código de Erro BusinessStatus/code Código de erro br/manuais/download/codigoserros-mensageria-maio- 018.xls - [Empréstimo de Ativo] Consultar Ordem Verbo Método Descrição GET order/{code} Consultar Ordem - Retorna uma ordem específica incluída pelo Buy-Side

16 Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 da ordem 1..1 Número da ordem code Número da ordem Sim string 35 Retorno: 1 Participante 3 4 do custodiante do instrumento da ordem 0..1 Nome Swagger Definição do Atributo Domínio Obrigatório? Número identificação Offer/Party/code Número identificação Tipo de Tamanho string Nome do Offer/Party/name Nome do string Investidor Offer/Party/Account/number Investidor do de negociação string Nome do investidor Offer/Party/Account/name Nome do investidor string Custodiante Offer/Custodian/code Agente de custódia string Nome do custodiante Offer/Custodian/name Nome do custodiante string Investidor custodiante 0..1 Nome do investidor custodiante Offer/Custodian/Account/ number Offer/Custodian/Account/ name Investidor do agente de custódia Nome do investidor do agente de custodia string 35 string Código de negociação Offer/Security/symbol Código de negociação string Número da ordem Offer/code Número da ordem string Prazo de liquidação 0..1 Indicador de ordem certificada Offer/ daystosettlementindicator Offer/certifiedOfferIndicator Prazo de liquidação Indicador de ordem certificada 0 - D D+1 True - Sim False - 1 boolean 1

17 0..1 Quantidade Original Offer/originalQuantity 0..1 Quantidade Disponível Offer/quantity Quantidade original de ativos para alugar Quantidade disponível de ativos para alugar 0..1 Taxa Offer/rate Taxa 0..1 Data de Validade Offer/expirationDate Data de validade da ordem 0..1 Situação da ordem Offer/orferStatus Situação da ordem 1 - Cancelada 9 - Fechada 11 - Disponível 3 - Aguardando Autorização Custodiante 34 - Rejeitada 60 - Aguardando Autorização Carrying 70 - Em processamento pela clearing BigInt BigInt Decimal(1 1,5) date 5 Status Requisição 0..1 Tipo de ordem Offer/OfferType/code Tipo de ordem 0..1 Carteira Offer/Finality/code Carteira de origem/destino dos ativos 0..1 Código de erro BusinessStatus/code Código de erro 1 - Doadora - Tomadora br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] string Consultar Lista de Ordens Verbo Método Descrição GET order/list?partycode=&number=&symbol= &daystosettlementindicator=&offercode=&offertypecode= Consultar Lista de Ordens - Retorna lista de ordens incluídas pelo Buy-Side. Restrição: Em avaliação

18 Caso necessite obter informações atualizadas das ordens, recomendamos o uso do método /event Requisição: 1 Participante do instrumento 0..1 Nome Número identificação partycode 0..1 Investidor number 0..1 Código de negociação symbol Swagger Definição do Atributo Número identificação Investidor do de negociação Código de negociação Domínio Obrigatório? Tipo de Tamanho Sim string 35 string 35 string Número da ordem offercode Número da ordem string 35 3 da ordem 0..1 Prazo de liquidação daystosettlementindicator Prazo de liquidação 0 - D D Tipo de ordem offertypecode Tipo da ordem 1 - Doadora - Tomadora 1 Retorno: 1 Participante Número identificação Nome do Nome Swagger Definição do Atributo Domínio Obrigatório? OfferList/{}/Party/code Número identificação Tipo de Tamanho string 35 OfferList/{}/Party/name Nome do string 60

19 do custodiante Investidor OfferList/{}/Party/Account/ number Investidor do de negociação string 35 Nome do investidor OfferList/{}/Party/Account/name Nome do investidor string 60 Custodiante OfferList/{}/Custodian/code Agente de custódia string 35 Nome do custodiante Investidor custodiante Nome do investidor custodiante OfferList/{}/Custodian/name Nome do custodiante string 60 OfferList/{}/Custodian/Account/n umber OfferList/{}/Custodian/Account/n ame Investidor do agente de custódia Nome do investidor do agente de custodia string 35 string 60 3 do instrumento Código de negociação OfferList/{}/Security/symbol Código de negociação string 1 4 da ordem Número da ordem OfferList/{}/code Número da ordem string 35 Prazo de liquidação Indicador de ordem certificada OfferList/{}/ daystosettlementindicator OfferList/{}/ certifiedofferindicator Quantidade original OfferList/{}/originalQuantity Quantidade disponível OfferList/{}/quantity Prazo de liquidação Indicador de ordem certificada Quantidade original de ativos para alugar Quantidade disponível de ativos para alugar 0 - D D+1 True - Sim False - Taxa OfferList/{}/rate Taxa Data de validade OfferList/{}/expirationDate Data de validade da ordem 1 boolean 1 BigInt BigInt Decimal( 11,5) date Situação da ordem OfferList/{}/offerStatus Situação da ordem 1 - Cancelada 9 - Fechada 11 - Disponível 3 - Aguardando Autorização Custodiante 34 - Rejeitada 60 - Aguardando Autorização Carrying 70 - Em processamento pela clearing

20 5 Status Requisição Tipo de ordem OfferList/{}/OfferType/code Tipo de ordem Carteira OfferList/{}/Finality/code 1..1 Quantidade total de registros da pesquisa OfferList/{}/TrafficInformation/ returnrecordquantity Carteira de origem/destino dos ativos Quantidade total de registros da pesquisa 0..1 Código de erro BusinessStatus/code Código de erro 1 - Doadora - Tomadora br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] string 1 Sim Consultar Situação da Ordem Verbo Método Descrição GET order/status/{code} Consultar Situação da Ordem Retorna situação de uma ordem específica Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 da ordem 1..1 Número da ordem code Número da ordem Sim string 35

21 Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 0..1 Número da ordem Offer/code Número da ordem string 35 1 da ordem Status Requisição 0..1 Situação da ordem Offer/offerStatus Situação da ordem 0..1 Código de erro BusinessStatus/code Código de erro 1 - Cancelada 9 - Fechada 11 - Disponível 3 - Aguardando Autorização Custodiante 34 - Rejeitada 60 - Aguardando Autorização Carrying 70 - Ordem em processamento pela clearing br/manuais/download/codigoserros-mensageria- Maio-018.xls - [Empréstimo de Ativo] 6. Book 6..1 Consultar Ofertas Disponíveis Verbo Método Descrição GET Consultar Ofertas Disponíveis Retorna as 100 melhores ofertas book/list/{symbol}/{daystosettlementindicator} disponíveis de um determinado instrumento

22 Requisição: 1 do instrumento Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1..1 Código de negociação symbol Código de negociação Sim string 1 da ordem 1..1 Prazo de liquidação daystosettlementindicator Prazo de liquidação 0 - D D+1 Sim 1 Retorno: 1 3 do instrumento da ordem Doadora da ordem Tomadora Nome Código de negociação Número da ordem Security/symbol Swagger Definição do Atributo Código de negociação Domínio Obrigatório? Tipo de Tamanho string 1 Security/LenderOfferList/code Número da ordem string Quantidade Security/LenderOfferList/quantity Quantidade de ativos para alugar 0..1 Taxa Security/LenderOfferList/rate Taxa Decimal(11,5) Número identificação Número da ordem Security/LenderOfferList/Party/code Número identificação BigInt string 35 Security/BorrowerOfferList/code Número da ordem string Quantidade Security/BorrowerOfferList/quantity Quantidade de ativos para alugar 0..1 Taxa Security/BorrowerOfferList/rate Taxa Decimal(11,5) 0..1 Número identificação Security/BorrowerOfferList/Party/code Número identificação BigInt string 35

23 4 Status Requisição 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] 6.. Consultar Melhores Ofertas Verbo Método Descrição GET Consultar Melhores Ofertas Retorna a melhor oferta disponível para book/top/{symbol}/{daystosettlementindicator} um ou mais instrumentos, limitado a 50 instrumentos Requisição: 1 do instrumento da ordem Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1..* Código de negociação symbol Código de negociação Sim string Prazo de Liquidação daystosettlementindicator Prazo de liquidação 0 - D D+1 Sim 1 Retorno: 1 do instrumento Nome Swagger Definição do Atributo Domínio Obrigatório? Código de negociação SecurityList/symbol Código de negociação string 1 Número da ordem SecurityList/LenderOffer/code Número da ordem string 35 Tipo de Tamanho

24 3 da ordem Doadora da ordem Tomadora Quantidade SecurityList/LenderOffer/quantity Quantidade de ativos para alugar Taxa SecurityList/LenderOffer/rate Taxa Número identificação SecurityList/LenderOffer/Party/code Número identificação BigInt Decimal(1 1,5) string 35 Número da ordem SecurityList/BorrowerOffer/code Número da ordem string 35 Quantidade SecurityList/BorrowerOffer/quantity Quantidade de ativos para alugar Taxa SecurityList/BorrowerOffer/rate Taxa BigInt Decimal(1 1,5) Número identificação SecurityList/BorrowerOffer/Party/code Número identificação string 35 4 Status Requisição 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] 6..1 Consultar Instrumentos Verbo Método Descrição GET Consultar Instrumentos Retorna os instrumentos disponíveis para /v1.0/securitylending/list empréstimo. Restrição: Em avaliação

25 Requisição: Sem parâmetros Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 do instrumento Código de Negociação SecurityList/symbol Código de Negociação string 1 Descrição do código de negociação SecurityList/Description Descrição do instrumento string Trade Consultar Negócios Realizados Verbo Método Descrição GET Consultar Negócios Realizados Retorna lista de negócios realizados pelo mercado de um determinado instrumento trade/all/{symbol}/{daystosettlementindicator} Restrição: Em avaliação

26 Requisição: 1 do instrumento da ordem Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1..1 Código de negociação symbol Código de negociação Sim string Prazo de liquidação daystosettlementindicator Prazo de liquidação 0 - D D+1 Sim 1 Retorno: 1 Informaçõe s do instrumento Ocorrência s Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 0..1 Código de negociação Security/symbol Código de negociação string Quantidade TradeList/quantity Quantidade de ativos negociados BigInt Informaçõe s da ordem 0..1 Taxa TradeList/rate Taxa Decimal (11,5) 0..1 Data e hora do negócio TradeList/date Data e hora do negócio date 3 Status Requisição 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros-mensageria- Maio-018.xls - [Empréstimo de Ativo]

27 6.3. Consultar Negócio Verbo Método Descrição GET trade/{code} Consultar Negócio - Retorna um negócio específico Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 do Negócio 1..1 Número do negócio code Número do negócio Sim string 35 Retorno: 0..1 Nome Swagger Definição do Atributo Domínio Obrigatório? Número identificação Trade/Party/party/code Número identificação Tipo de Tamanho string Nome do Trade/Party/party/name Nome do string 60 1 Participante 0..1 Investidor Trade/Party/party/Account/number Investidor do de negociação string Nome do investidor Trade/Party/party/Account/name Nome do investidor string Número identificação contraparte Trade/Party/CounterParty/code Número identificação contraparte string Nome do contraparte Trade/Party/CounterParty/name Nome do contraparte string 60 do custodiante 0..1 Custodiante Trade/Custodian/code Custodiante string Nome do custodiante Trade/Custodian/name Nome do custodiante string Investidor custodiante Trade/Custodian/Account/number Investidor do custodiante string 35

28 3 do instrumento 0..1 Nome do investidor custodiante Trade/Custodian/Account/name Nome do investidor do custodiante string Código de negociação Trade/Security/symbol Código de negociação string Número do negócio Trade/code Número do negócio string Prazo de liquidação Trade/daysToSettlementIndicator Prazo de liquidação 0 - D D Data de negociação Trade/date Data de negociação datetime 0..1 Quantidade Trade/quantity Quantidade de ativos negociados BigInt 4 do Negócio 0..1 Data de vencimento Trade/expirationDate Data de vencimento do negócio 0..1 Taxa Trade/rate Taxa date Decimal (11,5) 0..1 Situação do negócio Trade/tradeStatus Situação do negócio 4 - Fechado 7 - Rejeitado 48 - Aguardando autorização 65 - Aguardando validação clearing 6 - Em processamento pela Clearing 71 - Cancelado 0..1 Tipo do negócio Trade/TradeType/code Tipo do negócio 1 - Doador - Tomador string da Ordem Status Requisição 0..1 Número da ordem Trade/Offer/code Número da ordem string Número da ordem contraparte Trade/Offer/counterpartyOfferCode 0..1 Carteira Trade/Offer/Finality/code Número da ordem contraparte Carteira de origem/destino dos ativos 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] string 35

29 6.3.3 Consultar Lista de Negócios Verbo Método Descrição GET Consultar Lista de Negócios - Retorna lista de negócios. trade/list/?partycode=&number=&symbol=&daystosettlementindicator= &offertypecode=&date=lendercode=&borrowercode=&tradecode= Restrição: Em avaliação Caso necessite obter informações atualizadas dos negócios, recomendamos o uso do método /event Requisição: 1 Participante Informaçõe s do instrumento 0..1 Número identificação Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho partycode 0..1 Investidor number Número identificação Investidor do de negociação Sim string 35 string Código de negociação symbol Código de negociação string Prazo de liquidação daystosettlementind icator Prazo de liquidação 0 - D D+1 Sim 1 3 Informaçõe s da ordem 0..1 Tipo do negócio offertypecode Tipo do negócio 0..1 Indicador Data de negociação date Indicador Data de negociação 1 - Doador - Tomador 0 - D D-1 string Número da Ordem Doadora lendercode Número da ordem Doadora string 35

30 0..1 Número da Ordem Tomadora borrowercode Número da Ordem Tomadora string 35 4 Informaçõe s do Negócio 0..1 Número do negócio tradecode Número do negócio string 35 Retorno: 1 Participante 3 do custodiante do instrumento Nome Número identificação Nome do Participante Swagger TradeList/{}/Party/party/code Definição do Atributo Número identificação Domínio Obrigatório? Tipo de Tamanho string 35 TradeList/{}/Party/party/name Nome do string 60 Investidor TradeList/{}/Party/party/Account/number Nome do investidor Número identificação contraparte Nome do contraparte Investidor do de negociação string 35 TradeList/{}/Party/party/Account/name Nome do investidor string 60 TradeList/{}/Party/CounterParty/code TradeList/{}/Party/CounterParty/name Número identificação contraparte Nome do contraparte string 35 string 60 Custodiante TradeList/{}/Custodian/code Custodiante string 35 Nome do custodiante Investidor custodiante Nome do investidor custodiante Código de negociação TradeList/{}/Custodian/name Nome do custodiante string 60 TradeList/{}/Custodian/Account/number TradeList/{}/Custodian/Account/name Investidor do custodiante Nome do investidor do custodiante string 35 string 60 TradeList/{}/ Security/symbol Código de negociação string 1

31 4 5 6 do Negócio da Ordem Status Requisição Número do negócio Data de negociação Quantidade TradeList/{}/quantity Data de vencimento TradeList/{}/code Número do negócio string 35 TradeList/{}/date Data de negociação datetime TradeList/{}/expirationDate Quantidade de ativos negociados Data de vencimento do negócio Taxa TradeList/{}/rate Taxa Situação do negócio TradeList/{}/tradeStatus Situação do negócio Tipo do negócio TradeList/{}/TradeType/code Tipo do negócio Número da Ordem Número da Ordem Contraparte 4 - Fechado 7 - Rejeitado 48 - Aguardando autorização 65 - Aguardando validação clearing 6 - Em processamento pela Clearing 71 - Cancelado 1 - Doador - Tomador BigInt date Decimal (11,5) string 1 TradeList/{}/ Offer/code Número da ordem string 35 TradeList/{}/ Offer/counterpartyOfferCode Carteira TradeList/{}/ Offer/Finality/code 1..1 Quantidade total de registros da pesquisa TradeList/{}/ TrafficInformation/ returnrecordquantity Número da ordem contraparte Carteira de origem/destino dos ativos Quantidade total de registros da pesquisa 0..1 Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] string 35 Sim

32 6.3.4 Consultar Situação do Negócio Verbo Método Descrição GET trade/status/{code} Consultar Situação do Negócio - Retorna situação de um negócio específico Requisição: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 do Negócio 1..1 Número do negócio code Número do negócio Sim string 35 Retorno: Status Requisição Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de 0..1 Situação do negócio Trade/tradeStatus Situação do negócio 0..1 Código de erro BusinessStatus/code Código de erro 4 - Fechado 7 - Rejeitado 48 - Aguardando autorização 65 - Aguardando validação clearing 6 - Em processamento pela Clearing 71 - Cancelado br/manuais/download/codigoserros-mensageria- Maio-018.xls - [Empréstimo de Ativo] Tamanho

33 6.4 Event Consultar Eventos Verbo Método Descrição GET Consultar Eventos - Retorna consulta de eventos relacionados às ofertas e event/{startdate} negócios por ervalo de tempo. Requisição: Restrição: Em avaliação Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho 1 Timestamp 1..1 Data hora evento inicio startdate Data hora inicial para consulta de eventos Sim datetime 35 Retorno: Nome Swagger Definição do Atributo Domínio Obrigatório? Tipo de Tamanho Data hora ordem OfferList/{}/date Data hora da ordem datetime 35 1 da oferta Número da ordem OfferList/{}/code Número da Ordem string 35 Quantidade Original OfferList/{}/originalQuantity Quantidade original de ativos da ordem big Quantidade Atual OfferList/{}/quantity Quantidade atual de ativos da ordem big

34 Situação da ordem OfferList/{}/offerStatus Situação da ordem string 60 Número do negócio OfferList/{}/TradeList/{}/code Número do negócio string 35 do negócio Status Requisição Data hora negócio OfferList/{}/TradeList/{}/date Data hora do negócio datetime 35 Quantidade OfferList/{}/TradeList/{}/quantity Situação do negócio Quantidade de ativos negociados OfferList/{}/TradeList/{}/tradeStatus Situação do negócio string Código de erro BusinessStatus/code Código de erro br/manuais/download/codigoserros- Mensageria-Maio-018.xls - [Empréstimo de Ativo] big

35 7 FLUXOS DE NEGÓCIO As APIs podem ser consumidas em uma ordem específica para atender a um fluxo de negócio. A indicação sobre a sequência de uso está disponível no link: Aba: Material de apoio > Link: BTB Fluxo de Negócios REST API 8 SEGURANÇA Neste capítulo temos as informações relacionadas à Segurança da. A B3 definiu como modelo de segurança para as APIs expostas o uso de Mutual SSL (Two Way SSL) com pinagem de certificado e tokens de assinatura AWS (Amazon Web Services) para as requisições enviadas. 8.1 Mutual SSL (Two Way SSL) Para que o canal de comunicação entre cliente e servidor seja seguro, para todas as APIs do BTB, é utilizado protocolo HTTPS (Hyper Text Transfer Protocol Secure), o que implica a apresentação de certificado pelo servidor para garantir sua autenticidade e criptografia dos dados trafegados. Com o uso do Mutual SSL (Two Way SSL) o cliente também deverá apresentar certificado ao servidor durante o handshake SSL, garantindo assim mútua autenticidade. O certificado de cliente será fornecido pela B3 juntamente com a senha utilizada para proteger a chave privada. Abaixo exemplo se conexão utilizando mutual SSL com o comando curl curl --cert./client.cer:senhafornecidapelab3 --key client.key \ --request GET

36 8. Pinagem de certificado Os clientes que irão consumir as APIs deverão implementar a pinagem do certificado raiz do endereço de conexão. As imagens abaixo ilustram como obter as informações para implementação da pinagem de certificado. 36

37 8.3 Token de assinatura AWS (Amazon Web Services) O token de assinatura padrão AWS aumenta a segurança na comunicação entre cliente e servidor prevenindo adulteração das requisições em ataques do tipo man in the middle. Para geração do token de assinatura os elementos que compõe a requisição são concatenados em uma única string e então realiza-se o cálculo do HMAC (Hash Message Authentication Code) conforme o padrão RFC 104 HMAC- SHA1 utilizando uma palavra-chave (secret). A requisição então deverá vir acompanhada de header Authorization contendo a chave de identicação (Api Key) e o token separados por : conforme exemplo abaixo: 37

38 Para este exemplo o secret utilizado foi: 7b9e79e5-b8fb-4f47-9c8e-1ccbba45006e. Utilize os dados da requisição acima para validar sua implementação. O API Key e Secret para assinatura das requisições nos ambientes de certificação e produção será fornecido pela B3. O endereço abaixo contém a especificação completa deste padrão: 38