/marketplace/broker/v1/account/balance
API para recuperar informação de Conta Corrente

Objetivo

Esta API tem o objetivo de retornar as informações de saldo de conta corrente do corretor informado

Contrato de Serviço - Swagger
Download Swagger
Collection Test Postman
Download Collection Test
Dados Básicos

Nome do Serviço

marketplace/broker/v1/account/balance

Descrição Resumida

Prover informações de conta corrente do corretor

URL

Base Path:
/marketplace/broker/v1

Path:
/account/balance

URI:
/marketplace/broker/v1/account/balance

Status

Ativo

Versão

1.0

Diagrama
Exemplo de Payload
brokerType:F
key=AIzaSyCS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
Content-Type=application/json
X-Company-Id=01
X-SusepCode:00000202000000
X-SucursalCode:102
X-Application-Id=01
X-User-Id=01
{
  “totalBalance”:{
        “amount”: 1498,
        “currency”: “R$”,
        “amountFormatted”: “R$1.498,00”
  },
  “grantedCredit”:{
    “amount”: 2000,
    “currency”: “R$”,
    “amountFormatted”: “R$2.000,00”
  },
  “userBalance”:{
    “amount”: 1498,
    “currency”: “R$”,
    “amountFormatted”: “R$1.498,00”    
  }
}
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-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
    • 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 usuário da corretora (no caso de seguros)
    • 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.
    • brokerType
      Tipo: String
      Obrigatório: Não
      Descrição: Tipo do corretor.
      -- Saiba Mais
      [+]
      Ex: brokerType=F
      tipo do corretor, obrigatório caso for tipo F (filial).

.

Parâmetros e Detalhes do Response
RESPONSE
  • Body
    • totalBalance
      • amount
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Valor do saldo total
        -- Saiba Mais
        [+]
        Ex: Valor saldo total da corretora (no caso de seguros) com o formato inteiro (1498)
      • currency
        Tipo: String
        Obrigatório: Sim
        Descrição: Descrição do tipo de moeda
        -- Saiba Mais
        [+]
        Ex: "R$"
      • amountFormatted
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Valor do saldo total formatado
        -- Saiba Mais
        [+]
        Ex: "R$ 1.498,00"
    • grantedCredit
      • amount
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Valor do saldo concedido
        -- Saiba Mais
        [+]
        Ex:2000
      • currency
        Tipo: String
        Obrigatório: Sim
        Descrição: Descrição do tipo de moeda
        -- Saiba Mais
        [+]
        Ex: "R$"
      • amountFormatted
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Valor do saldo concedido formatado
        -- Saiba Mais
        [+]
        Ex: "R$ 2.000,00"
    • userBalance
      • amount
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Valor do saldo do usuário
        -- Saiba Mais
        [+]
        Caso a corretora (no caso de seguros) tenha controle do saldo por usuário, retornará esse objeto na resposta. Esse campo terá o seu valor como inteiro, por exemplo, 1498
      • currency
        Tipo: String
        Obrigatório: Sim
        Descrição: Descrição do tipo de moeda
        -- Saiba Mais
        [+]
        Ex: "R$"
      • amountFormatted
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Valor do saldo total do usuário
        -- Saiba Mais
        [+]
        Ex: "R$ 1.498,00"
Informações de ambientes
Histórico de versões

Autor

Área ou Setor

Versão

Descrição da versão

OpenInsurance

Integração

V1.0

Versão Inicial

Observações de Negócio

Para ter acesso a funcionalidade conta corrente, o corretor deverá ter dado o aceite no termo de adesão da utilização dessa condição comercial.

A corretora pode optar por ter controle e distribuir o seu saldo entre os seus vendedores/usuários, que nesse caso, será retornado o limite disponível (objeto: userBalance) do usuário (x-user-id) informado na entrada. Se não tiver o controle, só retornará o saldo geral da corretora, que possibilita que qualquer usuário dela poderá fazer uso desse saldo para aplicação na oferta.

Importante: O Corretor poderá fazer uso da plataforma da HDI, aplicando ou retirando valores de desconto com a conta corrente, logo o saldo sofrerá alteração. Posto isso, é importante sempre que for necessário verificar o saldo, realizar uma nova requisição na API para consultar os valores disponíveis no momento.

Language
Response
Click Try It! to start a request and see the response here!