CONSULTA EXTRATO CONTA CORRENTE

Objetivo

Esta API tem o objetivo de retornar o extrato de conta corrente do corretor informado

Contrato de Serviço - Swagger

Collection Test Postman

Dados Básicos


Nome do Serviço	/marketplace/broker/v1/account/statement
Descrição Resumida	Prover informações de extrato de conta corrente do corretor
URL	Base Path: /marketplace/broker/v1 Path: /account/statement URI: /marketplace/broker/v1/account/statement
Status	Ativo
Versão	1.0

Diagrama

Exemplo de Payload

key=AIzaSyCS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
daysRange=10

Content-Type=application/json
X-Company-Id=01
X-Application-Id=01
X-User-Id=01
X-Trace-Id="Trace"
X-Susep-Code=123456789
X-Sucursal-Code=001

[
  {
    "date": "2020-02-10",
    "type": {
      "id": 123,
      "description": "Manage"
    },
    "total": 500.01,
    "reversal": 0,
    "transactions": [
      {
        "credit": 10000000.01,
        "date": "2020-02-10",
        "validity": {
          "startDate": "2020-02-10",
          "endDate": "2020-02-10"
        },
        "expirationDate": "2020-02-10",
        "createdDate": "2020-02-10",
        "offer": {
          "id": "string",
          "items": [
            {
              "code": "1",
              "insurance": {
                "quotationId": "0"
              }
            }
          ]
        },
        "broker": {
          "code": "1098765431",
          "type": {
            "id": 123,
            "description": "Manage"
          },
          "name": "Jose Reinaldo"
        },
        "customer": {
          "name": "Jose Reinaldo",
          "documents": [
            {
              "type": {
                "id": 123,
                "description": "Manage"
              },
              "number": "23456733544"
            }
          ]
        },
        "type": {
          "id": 123,
          "description": "Manage"
        },
        "value": 500.01,
        "reversal": 0
      }
    ]
  }
]

Parâmetros e Detalhes do Request

REQUEST

Header
- Content-Type
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Tipo do conteúdo a ser trafegado no protocolo http
  
  -- Saiba Mais
  
  [+]
  
  Este conteúdo pode ser: Application/Json e em alguns casos já temos Application/PDF
- X-Company-id
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da empresa
  
  -- Saiba Mais
  
  [+]
  
  Deverá ser preenchido com o dado fornecido pela HDI
- X-Application-id
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da aplicação
  
  -- Saiba Mais
  
  [+]
  
  Deverá ser preenchido com o dado fornecido pela HDI
- X-User-Id
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código do Usuário
  
  -- Saiba Mais
  
  [+]
  
  Código do usuário autenticado no sistema que irá consumir a API
  Representado por exemplo pelo CPF do corretor (no caso de seguros)
- Trace-Id
  
  Tipo: String
  Obrigatório: Não
  Descrição: Código de Trace
  
  -- Saiba Mais
  
  [+]
  
  Código de trace
- X-Susep-Code
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da Susep do corretor
  
  -- Saiba Mais
  
  [+]
  
  Deverá ser informado os 14 caracteres do código da Susep da corretora, por exemplo, 00000000000001
- X-Sucursal-Code
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da sucursal do corretor
  
  -- Saiba Mais
  
  [+]
  
  Ex:001
- Authorization
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Token de Autorização
  
  -- Saiba Mais
  
  [+]
  
  Ex: Bearer eyJraWQiOiJiZDc2MzhjYzg4OTU2Z...
Param
- key
  
  Tipo: String
  Obrigatório: Sim
  Descrição: chave de acesso única por player.
  
  -- Saiba Mais
  
  [+]
  
  Esta chave é intransferível e garante a autorização para consumir as APIs. Esta informação será trafegada em todas os Params das APIs da HDI.
- daysRange
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Range de dias para consulta
  
  -- Saiba Mais
  
  [+]
  
  Ex: 10

Parâmetros e Detalhes do Response

RESPONSE

Body[]
- transactionTypeDate
  
  Tipo: String (Date)
  Obrigatório: Sim
  Descrição: Data da movimentação
  
  -- Saiba Mais
  
  [+]
  
  Ex: "2020-11-18"
- type
  - id
    
    Tipo: String
    Obrigatório: Não
    Descrição: Código da movimentação
    
    -- Saiba Mais
    
    [+]
    
    Ex: C
    
    Enum de tipo de movimentação:
    1 - CREDITO("C", "Crédito"),
    2 - DEBITO("D", "Debito"),
    3 - ESTORNO_EXPIRACAO("EX", "Estorno Expiração"),
    4 - ESTORNO("E", "Estorno"),
    5 - TRANSFERENCIA("T", "Transferência"),
    6 - ESTORNO_REGUA("ER", "Estorno Régua"),
    7 - EXPIRACAO("EP", "Expiracao"),
    8 - ALL("ALL", "Todos"),
    9 - TRANSFERENCIA_SALDO("TS", "Transferência de Saldo"),
    10 - ESTORNO_TRANSFERENCIA_SALDO("ET", "Estorno de Transferência de Saldo"),
    11 - DEBITO_DE_CREDITO("DC", "Debito de Transferência de Saldo")
  - description
    
    Tipo: String
    Obrigatório: Não
    Descrição: Descrição da movimentação
    
    -- Saiba Mais
    
    [+]
    
    Ex: "CREDITO"
    
    Enum de tipo de movimentação:
    1 - CREDITO("C", "Crédito"),
    2 - DEBITO("D", "Debito"),
    3 - ESTORNO_EXPIRACAO("EX", "Estorno Expiração"),
    4 - ESTORNO("E", "Estorno"),
    5 - TRANSFERENCIA("T", "Transferência"),
    6 - ESTORNO_REGUA("ER", "Estorno Régua"),
    7 - EXPIRACAO("EP", "Expiracao"),
    8 - ALL("ALL", "Todos"),
    9 - TRANSFERENCIA_SALDO("TS", "Transferência de Saldo"),
    10 - ESTORNO_TRANSFERENCIA_SALDO("ET", "Estorno de Transferência de Saldo"),
    11 - DEBITO_DE_CREDITO("DC", "Debito de Transferência de Saldo")
- total
  
  Tipo: Integer
  Obrigatório: Sim
  Descrição: Valor total da movimentação
  
  -- Saiba Mais
  
  [+]
  
  Ex: 502.00
- transactions[]
  - type
    - id
      
      Tipo: String
      Obrigatório: Sim
      Descrição: Código do tipo de transação
      
      -- Saiba Mais
      
      [+]
      
      Ex: "1"
      
      Enum de tipo de movimentação:
      1 - CREDITO("C", "Crédito"),
      2 - DEBITO("D", "Debito"),
      3 - ESTORNO_EXPIRACAO("EX", "Estorno Expiração"),
      4 - ESTORNO("E", "Estorno"),
      5 - TRANSFERENCIA("T", "Transferência"),
      6 - ESTORNO_REGUA("ER", "Estorno Régua"),
      7 - EXPIRACAO("EP", "Expiracao"),
      8 - ALL("ALL", "Todos"),
      9 - TRANSFERENCIA_SALDO("TS", "Transferência de Saldo"),
      10 - ESTORNO_TRANSFERENCIA_SALDO("ET", "Estorno de Transferência de Saldo"),
      11 - DEBITO_DE_CREDITO("DC", "Debito de Transferência de Saldo")
    - description
      
      Tipo: String
      Obrigatório: Sim
      Descrição: Descrição do tipo de transação
      
      -- Saiba Mais
      
      [+]
      
      Ex: "CREDOTP"
      
      Enum de tipo de movimentação:
      1 - CREDITO("C", "Crédito"),
      2 - DEBITO("D", "Debito"),
      3 - ESTORNO_EXPIRACAO("EX", "Estorno Expiração"),
      4 - ESTORNO("E", "Estorno"),
      5 - TRANSFERENCIA("T", "Transferência"),
      6 - ESTORNO_REGUA("ER", "Estorno Régua"),
      7 - EXPIRACAO("EP", "Expiracao"),
      8 - ALL("ALL", "Todos"),
      9 - TRANSFERENCIA_SALDO("TS", "Transferência de Saldo"),
      10 - ESTORNO_TRANSFERENCIA_SALDO("ET", "Estorno de Transferência de Saldo"),
      11 - DEBITO_DE_CREDITO("DC", "Debito de Transferência de Saldo")
  - grantedCredit
    
    Tipo: Integer
    Obrigatório: Sim
    Descrição: Valor do crédito
    
    -- Saiba Mais
    
    [+]
    
    Ex: 2000.00
  - validity
    - startDate
      
      Tipo: String (Date)
      Obrigatório: Não
      Descrição: Data de inicio da validade
      
      -- Saiba Mais
      
      [+]
      
      Ex: "2020-11-10"
    - endDate
      
      Tipo: String (Date)
      Obrigatório: Não
      Descrição: Data de fim da validade
      
      -- Saiba Mais
      
      [+]
      
      Ex: "2020-11-30"
  - quotation
    - id
      
      Tipo: String
      Obrigatório: Sim
      Descrição: Código do Item
      
      -- Saiba Mais
      
      [+]
      
      Ex: 282749390
  - prospect
    - name
      
      Tipo: String
      Obrigatório: Sim
      Descrição: Nome do cliente
      
      -- Saiba Mais
      
      [+]
      
      Ex: "IAGO LOPES DE LIMA"
    - documents
      - type
        
        id
        
        Tipo: String
        Obrigatório: Sim
        Descrição: Código do tipo de documento
        
        -- Saiba Mais
        
        [+]
        
        Ex: "1"
        
        Lista de valores possíveis:
        1 - CPF
        2 - CNPJ
        3 - RG
        
        description
        
        Tipo: String
        Obrigatório: Sim
        Descrição: Descrição do tipo de documento
        
        -- Saiba Mais
        
        [+]
        
        Ex: "CPF"
        
        Lista de valores possíveis:
        1 - CPF
        2 - CNPJ
        3 - RG
      - number
        
        Tipo: String
        Obrigatório: Sim
        Descrição: Número do documento
        
        -- Saiba Mais
        
        [+]
        
        Ex: "11111111111"
  - value
    
    Tipo: Integer
    Obrigatório: Sim
    Descrição: Valor da transação
    
    -- Saiba Mais
    
    [+]
    
    Ex: 102.00

Informações de ambientes


## Homologação	## https://openapi-int.hdi.com.br/marketplace/broker/v1/account/statement
## Produção	## https://openapi.hdi.com.br/marketplace/broker/v1/account/statement

Histórico de versões

Autor	Área ou Setor	Versão	Descrição da versão
OpenInsurance	Integração	V1.0	Versão Inicial