/checkingAccount/recalculation
API para realizar a aplicação de saldo de conta corrente
Disponibilizar um serviço que oferece a possibilidade da corretora (no caso de seguros) em aplicar o saldo de conta corrente nas ofertas.
Nome do Serviço | API Aplica Saldo Conta Corrente |
Descrição Resumida | Realizar a aplicação de saldo de conta corrente |
URL | Base Path: /marketplace/sales/v3 Path: /offers/{idOffer}/items/{codeItem}/checkingAccount/recalculation URI: /marketplace/sales/v3/offers/{idOffer}/items/{codeItem}/checkingAccount/recalculation |
Status | Ativo |
Versão | 1.0 |
key:AIzaSyCwI7icy8qCtOrhLSmLFAKkZpoIKqr7ZZZ
idOffer: 1
codeItem: 1
X-Application-Id:01
X-Company-Id:01
X-Susep-Code: 00000000000001
X-Sucursal-Code: 001
X-User-Id:68769613893
Content-Type:application/json
X-Track-Id:fdgdst43
Authorization=Bearer eyJraWQiOiJiZDc2MzhjYzg4OTU2ZmNjZGFhMGRlYWQ2NDk5M2E1NjQ0ZTcwMTVkIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJoZGktY29ycG9yYXRlLWF1dGhAaW5zLWNyb3NzLXNlY3VyaXR5LWF1dGgtaW50Zy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsImF1ZCI6ImFwaS5oZGkuY29tLmJyIiwiYXBwbGljYXRpb24iOltudWxsXSwicm9sZXMiOlsiUm9sZTEiLCJSb2xlMiIsIlJvbGVOIl0sImlzcyI6ImhkaS1jb3Jwb3JhdGUtYXV0aEBpbnMtY3Jvc3Mtc2VjdXJpdHktYXV0aC1pbnRnLmlhbS5nc2VydmljZWFjY291bnQuY29tIiwiZXhwIjoxNTcyNDc4NDY4LCJpYXQiOjE1NzI0NzQ4NjgsInVzZXIiOlsiYXBpLWlucy1pbnRlZ3JhdGlvbi1pbnRlcm5hbC1hY2Nlc3MiXSwid2ViQ2xpZW50IjpbbnVsbF19.N0KeFZzNZiUToV0-Y3hA15PYaYzAUq4xSjbErA97FUhp3Mqs1Yg2AByIOhcqWG4qIuEqvSuf1dIH0QdIToVySP4db9fGEELqu48SF1yCwk2fuaxGLmRtgNDjoJRPwkrxFDUSR7MMsnxn9pV2_sevaWJCyF7QKdGMG0zgZVQbb25S7IrOD3CF97fN9PN5yhsj9f3C8_WDqbDRsvVUdMItmmsbQI98iWM4xQ7O93s1TQCcd84ZQhOdBfYw_yY6jz-hA-tYin3vS33DIcAAR-HNnljdV_9XmWQ5WXd07VjCI8Ynntlrb3vyYjgbkl15VMvfsm0p2ZXgm5jLKFdw8w5nyg
{
"checkingAccount": {
"amount": 10
}
}
{
"offers": [
{
"id": "123456",
"totalPrice": {
"amount": 1499.99,
"currency": "R$",
"amountFormatted": "R$ 1.499,99"
},
"items": [
{
"code": "1",
"name": "Oferta de Seguro Auto",
"businessNotifications": [
{
"code": "string",
"description": "string",
"type": "string"
}
],
"segment": [
{
"id": 1,
"descritption": "INSURANCE",
"components": [
{
"id": 1,
"descritption": "AUTO",
"compositions": [
{
"id": 9,
"descritption": "HDI ONE CLICK"
}
]
}
]
}
],
"insurance": {
"quotationId": "0",
"items": [
{
"referencedRepairShopDeductibleValue": {
"amount": 1499.99,
"currency": "R$",
"amountFormatted": "R$ 1.499,99"
},
"deductibleValue": {
"amount": 1499.99,
"currency": "R$",
"amountFormatted": "R$ 1.499,99"
},
"totalNetPremium": {
"amount": 1299.99,
"currency": "R$",
"amountFormatted": "R$ 1.299,99"
}
}
],
"totalGrossPremium": {
"amount": 1299.99,
"currency": "R$",
"amountFormatted": "R$ 1.299,99"
},
"cost": {
"amount": 104.25,
"currency": "R$",
"amountFormatted": "R$ 104,25"
},
"totalIof": {
"amount": 95.74,
"currency": "R$",
"amountFormatted": "R$ 95,74"
},
"total": {
"amount": 1499.99,
"currency": "R$",
"amountFormatted": "R$ 1.499,99"
},
"installments": [
{
"quantity": 0,
"price": {
"amount": 374.99,
"currency": "R$",
"amountFormatted": "R$ 374,99"
},
"billingType": {
"id": 1,
"description": "Dรฉbito em Conta"
},
"isBestPaymentDay": true
}
]
}
}
]
}
]
}
- Header
-
Content-TypeTipo: 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-idTipo: String
Obrigatório: Sim
Descrição: Código da empresa
-- Saiba Mais[+]
Deverá ser preenchido com o dado fornecido pela HDI -
X-Application-idTipo: String
Obrigatório: Sim
Descrição: Código da aplicação
-- Saiba Mais[+]
Deverá ser preenchido com o dado fornecido pela HDI -
X-Susep-CodeTipo: 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-CodeTipo: String
Obrigatório: Sim
Descrição: Código da sucursal do corretor
-- Saiba Mais[+]
Ex:001 -
X-User-IdTipo: 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) -
X-Track-IdTipo: String
Obrigatório: Sim
Descrição: Código do Rastreamento da transação
-- Saiba Mais[+]
Deverá ser informado o X-Track-Id da oferta (informação que consta no response Header) que terá o valor aplicado de Conta Corrente. -
AuthorizationTipo: String
Obrigatório: Sim
Descrição: Token de Autorização
-- Saiba Mais[+]
Ex: Bearer eyJraWQiOiJiZDc2MzhjYzg4OTU2Z...
-
- Param
-
keyTipo: 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. -
idOfferTipo: String
Obrigatório: Sim
Descrição: Código da oferta
-- Saiba Mais[+]
número da oferta que deverá ter o valor aplicado (essa informação vem na resposta da oferta, cujo endereço é: offers[posicaoDaOferta].id) -
codeItemTipo: String
Obrigatório: Sim
Descrição: Item da oferta
-- Saiba Mais[+]
Código do item que deverá ter o valor aplicado (essa informação vem na resposta da oferta, cujo endereço é: offers[posicaoDaOferta].items[posicaoDoProduto].code)
-
- Body
- checkingAccount
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor da conta
-- Saiba Mais[+]
valor do desconto que será aplicado no item da oferta usando conta corrente
-
- checkingAccount
- Body
-
offers[]
-
idTipo: String
Obrigatório: Sim
Descrição: ID da Oferta
-- Saiba Mais[+]
EX: 993h3188-7f74-4b3c-3411-dedd0600f12f - totalPrice
-
amountTipo: Number
Obrigatório: Sim
Descrição: Valor total da oferta
-- Saiba Mais[+]
Ex: 1500.25 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda do valor total
-- Saiba Mais[+]
Ex: R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor total formatado
-- Saiba Mais[+]
Ex: R$ 1.500,25
-
- items[]
-
codeTipo: String
Obrigatório: Sim
Descrição: Código do item segurado
-- Saiba Mais[+]
Ex: 1 -
nameTipo: String
Obrigatório: Sim
Descrição: Nome do Item segurado
-- Saiba Mais[+]
Ex: "Oferta de Seguro Auto" - businessNotifications[]
-
codeTipo: String
Obrigatório: Sim
Descrição: Código do businessNotifications
-- Saiba Mais[+]
Ex: 1 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição do businessNotifications
-- Saiba Mais[+]
Ex: INSURANCE -
typeTipo: String
Obrigatório: Sim
Descrição: Tipo do businessNotifications
-- Saiba Mais[+]
Ex: INSURANCE
-
- segment[]
-
idTipo: String
Obrigatório: Sim
Descrição: Código do segmento
-- Saiba Mais[+]
Ex: 1 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição do segmento
-- Saiba Mais[+]
Ex: INSURANCE - components[]
-
idTipo: String
Obrigatório: Sim
Descrição: Código do componente
-- Saiba Mais[+]
Ex: 1 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição do componente
-- Saiba Mais[+]
Ex: AUTO - compositions[]
-
idTipo: String
Obrigatório: Sim
Descrição: Código da composição
-- Saiba Mais[+]
Ex: 1 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da composição
-- Saiba Mais[+]
Ex: HDI AUTO PERFIL
-
-
-
- insurance
-
quotationIdTipo: String
Obrigatório: Sim
Descrição: Número da cotação interna
-- Saiba Mais[+]
Ex: 483331000 -
items[]
- coverages[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Id da cobertura
-- Saiba Mais[+]
3 -
codeTipo: String
Obrigatório: Sim
Descrição: Código da cobertura
-- Saiba Mais[+]
05 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da cobertura
-- Saiba Mais[+]
Valor de Mercado Referenciado -
deductibleIDTipo: Integer
Obrigatório: Sim
Descrição: Código da franquia
-- Saiba Mais[+]
5 -
deductibleDescriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da franquia
-- Saiba Mais[+]
REDUZIDA -
branchCodeTipo: String
Obrigatório: Sim
Descrição: Código da marca
-- Saiba Mais[+]
31 -
branchDescriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da marca
-- Saiba Mais[+]
Automóvel - Casco - guarantees[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Código da garantia
-- Saiba Mais[+]
1 -
codeTipo: String
Obrigatório: Sim
Descrição: Código da garantia
-- Saiba Mais[+]
1 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da garantia
-- Saiba Mais[+]
MORTE -
isValue
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
10000.00 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 10.000,00
-
-
netPremium
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
35.20 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 35,20
-
-
deductible
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
0 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 0,00
-
-
- additionals[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Id da cobertura adicional
-- Saiba Mais[+]
1 -
codeTipo: String
Obrigatório: Sim
Descrição: Código da cobertura adicional
-- Saiba Mais[+]
1 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da cobertura adicional
-- Saiba Mais[+]
Guincho Sem Limite de KM + 15 Dias Carro Reserva -
maximumIndemnityLimits
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
11150.00 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 11150.00
-
-
premiumValue
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
291.66 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 291.66
-
-
deductible
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
0 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 0,00
-
-
- accessories[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Id da cobertura de acessórios
-- Saiba Mais[+]
32 -
codeTipo: String
Obrigatório: Sim
Descrição: Código da cobertura de acessórios
-- Saiba Mais[+]
0121 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da cobetura de acessórios
-- Saiba Mais[+]
Sistema de multimídia -
maximumIndemnityLimits
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
11150.00 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 11150.00
-
-
premiumValue
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
291.66 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 291.66
-
-
- protections[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Id da cobertura de protecionais
-- Saiba Mais[+]
32 -
codeTipo: String
Obrigatório: Sim
Descrição: Código da cobertura de acessórios
-- Saiba Mais[+]
0121 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da cobetura de acessórios
-- Saiba Mais[+]
Alarme e Bloqueio de combustível -
maximumIndemnityLimits
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
11150.00 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
R$ 11150.00
-
-
-
-
referencedRepairShopDeductibleValue
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
Ex: 1499.99 -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 1.499,99"
-
-
deductibleValue
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor da Franquia
-- Saiba Mais[+]
Ex: "1499.99" -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 1.499,99"
-
-
totalNetPremium
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor do prêmio líquido do item
-- Saiba Mais[+]
Ex: 1299.99 -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 1.299,99"
-
- coverages[]
-
totalGrossPremium
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor do prêmio total dos itens
-- Saiba Mais[+]
Ex: 1299.99 -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 1.299,99"
-
-
cost
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
Ex: 104.25 -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 104,25"
-
-
totalIof
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor do iof
-- Saiba Mais[+]
Ex: 95.74 -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 95,74"
-
-
total
-
amountTipo: integer
Obrigatório: Sim
Descrição: Valor total da oferta
-- Saiba Mais[+]
Ex: 1499.99 -
currencyTipo: string
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: "R$ 1.499,99"
-
- installments[]
-
quantityTipo: Number
Obrigatório: Sim
Descrição: Quantidade de parcelas
-- Saiba Mais[+]
Ex: 1 -
price
-
amountTipo: Number
Obrigatório: Sim
Descrição: Valor de cada parcela
-- Saiba Mais[+]
Ex: 1500.25 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: R$ -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Ex: R$ 1.500,25
-
- billingType
-
idTipo: Number
Obrigatório: Sim
Descrição: Código do tipo decobrança
-- Saiba Mais[+]
Ex: 2 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição do tipo de cobrança
-- Saiba Mais[+]
Ex: Débito em Conta
-
-
isBestPaymentDayTipo: boolean
Obrigatório: Sim
Descrição: É o melhor dia para pagamento?
-- Saiba Mais[+]
Ex: true
-
-
- checkingAccount
- limitAmount
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
Valor máximo permitido para aplicação de conta corrente na cotação.
Ex: 100.0 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Valor máximo permitido para aplicação de Conta Corrente formatado com a moeda Real.
Ex: "R$ 100.00"
-
- appliedAmount
-
amountTipo: Integer
Obrigatório: Sim
Descrição: Valor
-- Saiba Mais[+]
Valor máximo permitido para aplicação de conta corrente na cotação.
Ex: 100.0 -
currencyTipo: String
Obrigatório: Sim
Descrição: Moeda
-- Saiba Mais[+]
Ex: "R$" -
amountFormattedTipo: String
Obrigatório: Sim
Descrição: Valor formatado
-- Saiba Mais[+]
Valor máximo permitido para aplicação de Conta Corrente formatado com a moeda Real.
Ex: "R$ 100.00"
-
- limitAmount
-
-
-
offers[]
.
Autor | Área ou Setor | Versão | Descrição da versão |
---|---|---|---|
OpenInsurance | Integração | V1.0 | Versão Inicial |
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, o valor para verificação da aplicação será do usuário. Caso contrário será avaliado o saldo da corretora para aplicação da Conta Corrente.
A regra para aplicação será:
1° Se o valor informado for menor ou igual ao limite do item oferta (offers[posicaoOferta].items[PosicaoItemDaOferta].checkingAccount.limitAmount.amount) e menor ou igual ao saldo do corretor/usuário (userBalance.amount ou totalBalance. Amount), será aplicado o valor.
2° Se o valor informado for maior que o limite do item oferta e este item for menor ou igual ao saldo do corretor/usuário (userBalance.amount ou totalBalance. Amount), será aplicado o valor máximo permitido para o item, gerando uma notificação que o valor foi ajustado.
3° Se o valor informado for maior que o limite do item oferta e este item for maior do que saldo do corretor/usuário (userBalance.amount ou totalBalance. Amount), será gerado um erro, pois o valor é maior que permitido para o saldo.
4° Se o valor informado for menor ou igual ao limite do item oferta e maior que o saldo do corretor/usuário (userBalance.amount ou totalBalance. Amount), será gerado um erro, pois o valor é maior que permitido para o saldo.