Conta

O produto conta é a lista de contas bancárias, como Conta Corrente ou Conta Poupança e Cartão de Crédito, que estavam disponíveis no conector selecionado.

A resposta variará dependendo do Tipo de Contas, fornecendo um objeto data relacionado ao seu tipo bankData ou creditData.

Bank

{
  "id": "a658c848-e475-457b-8565-d1fffba127c4",
  "type": "BANK",
  "subtype": "CHECKING_ACCOUNT",
  "number": "0001/12345-0",
  "name": "Conta Corrente",
  "marketingName": "GOLD Conta Corrente",
  "balance": 120950,
  "itemId": "a0922d6f-2007-4169-a181-b961500608db",
  "taxNumber": "416.799.495-00",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "bankData": {
    "transferNumber": "123/0001/12345-0",
    "closingBalance": 120950,
    "automaticallyInvestedBalance": 100,
    "overdraftContractedLimit": 0,
    "overdraftUsedLimit": 0,
    "unarrangedOverdraftAmount": 0
  }
}

Credit

{
  "id": "4f61bd6d-e6fc-44b2-9c4b-5609058de7ab",
  "type": "CREDIT",
  "subtype": "CREDIT_CARD",
  "name": "Itau Uniclass 2.0 Mastercard Platinum",
  "marketingName": "Itau Uniclass 2.0 Mastercard Platinum",
  "taxNumber": "***.***.123-22",
  "owner": "FEDERICO MIRAS",
  "number": "1234",
  "balance": 142.41,
  "itemId": "fc214524-4725-4974-9f7a-0f1b50ea39e0",
  "currencyCode": "BRL",
  "creditData": {
    "level": "PLATINUM",
    "brand": "MASTERCARD",
    "brandAdditionalInfo": null,
    "balanceCloseDate": "2020-07-08",
    "balanceDueDate": "2020-07-17",
    "availableCreditLimit": 51300,
    "creditLimit": 51800,
    "isLimitFlexible": false,
    "balanceForeignCurrency": 500,
    "minimumPayment": 100,
    "status": "ACTIVE",
    "holderType": "MAIN"
  }
}

Propriedade	Descrição	Necessário
id	Identificador único do modelo de Conta, usado para recuperar transações relacionadas	Sim
type	Tipo de conta (BANK / CREDIT).	Sim
subtype	O subtipo de conta (`CHECKING_ACCOUNT` / `SAVINGS_ACCOUNT` / `CREDIT_CARD`).	Sim
number	Para o tipo BANK, este campo retorna o número da conta. Ex: 12345-6 (ou 12345-6/500 em algumas contas poupança). Para o tipo CREDIT, este campo retorna os últimos quatro dígitos do cartão de crédito. Ex: 1234. Para conectores com tipo PAYMENT_ACCOUNT, o número representa o número da conta de destino do fundo.	Sim
balance	Para o tipo BANK, este campo retorna o saldo disponível atual da conta. Para o tipo CREDIT, este campo retorna o valor do saldo atual da fatura em aberto ainda não paga. Para conectores com tipo PAYMENT_ACCOUNT, o saldo só pode ser retornado em contas digitais, não em contas externas. Mais detalhes aqui.	Sim
currencyCode	Código ISO da moeda da conta, ex: USD ou EUR	Sim
name	Nome da conta, ex: Conta Poupança 1234 ou Mastercard Gold.	Sim
marketingName	O nome extra fornecido para algumas contas que estão relacionadas ao nível da conta. Nem sempre fornecido.
owner	Nome do proprietário da conta.
taxNumber	Número de identificação fiscal formatado do proprietário da conta (CPF ou CNPJ). Para conectores com tipo PAYMENT_ACCOUNT, taxNumber representa o CNPJ da empresa conectada. A disponibilidade varia de acordo com o conector. Para alguns conectores empresariais (por exemplo, Bradesco PJ, Caixa PJ), contas sob o mesmo itemId podem retornar diferentes valores de `taxNumber`, uma vez que o valor vem da empresa selecionada ou diretamente da API da instituição.
bankData	Dados específicos para tipos de conta bancária.
creditData	Dados específicos para tipos de conta de crédito.

Saldo #

Os saldos das Contas Bancárias (Corrente e Poupança) representam o montante que o titular possui atualmente disponível para gastar. Se esse valor for negativo, representa uma dívida que o titular tem com a instituição financeira, um exemplo disso seria um cheque especial.

Os saldos dos Cartões de Crédito são o montante devido à instituição, isso significaria o saldo em aberto do mês atual do usuário. Se a fatura anterior foi paga com um valor excedente, o saldo retornaria um valor negativo.

Para conectores de Open Finance, o saldo do Cartão de Crédito é o limite utilizado para aquele cartão de crédito.

Calculando saldos de cartões de crédito

Contas do tipo crédito podem aproveitar o availableCreditLimit para consolidar uma visão 360 dos cartões de crédito.

creditLimit = availableCreditLimit (ainda a gastar) + balance (saldo em aberto) + dívida do saldo anterior.

Dados Bancários #

Propriedade	Descrição
transferNumber	Este campo retorna as informações mais importantes da conta: COMPE / Agência / Conta. Ex.: 123 / 1234 / 12345-6
closingBalance	Saldo atual da conta. Para conectores de Open Finance, representa o saldo disponível + o saldo bloqueado
automaticallyInvestedBalance	Saldo da conta que é automaticamente investido pela instituição.
overdraftContractedLimit	Montante do limite de cheque especial contratado.
overdraftUsedLimit	Montante total utilizado do limite especial de cheque e do adiantamento ao depositante.
unarrangedOverdraftAmount	Valor da operação contratada em caráter emergencial para cobrir saldo de conta de depósito à vista e excesso sobre o limite de cheque especial acordado.

Dados de Crédito #

Propriedade	Descrição
minimumPayment	Pagamento mínimo do saldo para o período atual.
balanceForeignCurrency	Saldo em moeda estrangeira para o período atual.
availableCreditLimit	O limite de crédito disponível para a conta ainda a gastar.
creditLimit	O limite de crédito para a conta.
isLimitFlexible	Se o cartão de crédito é ilimitado.
balanceDueDate	Data de Vencimento do Saldo para a conta do cartão. (aaaa-mm-dd)
balanceCloseDate	Data de fechamento quando o saldo foi calculado. (aaaa-mm-dd)
level	Nível do tipo de cartão (Black, Signature, etc).
brand	Marca do Cartão (Mastercard, Visa, Elo, etc).
brandAdditionalInfo	Texto livre especificando a categoria da marca quando `brand` é `OTHER`. Disponível apenas em conectores de Open Finance.
status	Status do cartão (ACTIVE, BLOCKED, CANCELLED). Para conectores regulamentados retornamos apenas ACTIVE, significando que o status do cartão ainda está sendo recuperado da FI.
holderType	Tipo de titular do cartão (MAIN ou ADDITIONAL)

Limites de Crédito Desagregados #

Alguns cartões de crédito podem ter várias linhas de crédito ou diferentes modalidades de operação. O campo disaggregatedCreditLimits fornece informações detalhadas sobre cada linha de crédito para ajudá-lo a identificar corretamente o cartão principal e calcular saldos precisos.

Quando Usar Limites Desagregados #

Use este recurso quando você encontrar:

Saldos de cartões de crédito incorretos
Múltiplas linhas de crédito no mesmo cartão
Diferentes modalidades de operação com limites separados

Estrutura #

O campo disaggregatedCreditLimits é um array de objetos contendo informações detalhadas sobre cada linha de crédito:

{
  "disaggregatedCreditLimits": [
    {
      "creditLineLimitType": "LIMITE_CREDITO_TOTAL",
      "consolidationType": "INDIVIDUAL",
      "identificationNumber": "1000",
      "isLimitFlexible": false,
      "usedAmount": 149.84,
      "usedAmountCurrencyCode": "BRL",
      "lineName": "CREDITO_A_VISTA",
      "limitAmount": 1000.0,
      "limitAmountCurrencyCode": "BRL",
      "customizedLimitAmount": 2000.0,
      "customizedLimitAmountCurrencyCode": "BRL",
      "availableAmount": 850.16,
      "availableAmountCurrencyCode": "BRL"
    }
  ]
}

Campos Chave #

Campo	Tipo	Descrição	Exemplo
`creditLineLimitType`	string	Tipo de limite de crédito	`"LIMITE_CREDITO_TOTAL"` ou `"LIMITE_CREDITO_MODALIDADE_OPERACAO"`
`consolidationType`	string	Indica se o limite é consolidado ou individual	`"INDIVIDUAL"` ou `"CONSOLIDATED"`
`identificationNumber`	string	Número de identificação adicional do cartão de crédito	`"1000"`
`isLimitFlexible`	boolean	Indica se o limite é flexível	`false`
`usedAmount`	number	Montante utilizado do cartão de crédito adicional	`149.84`
`usedAmountCurrencyCode`	string	Código da moeda do montante utilizado	`"BRL"`
`lineName`	string	Nome da linha de limite de crédito. Um dos `CREDITO_A_VISTA`, `CREDITO_PARCELADO`, `SAQUE_CREDITO_BRASIL`, `SAQUE_CREDITO_EXTERIOR`, `EMPRESTIMO_CARTAO_CONSIGNADO`, `OUTROS`	`"CREDITO_A_VISTA"`
`lineNameAdditionalInfo`	string	Texto livre descrevendo a linha quando `lineName` é `OUTROS`	`"SAQUE_CREDITO"`
`limitAmount`	number	Montante do limite do cartão de crédito adicional	`1000.00`
`limitAmountCurrencyCode`	string	Código da moeda do limite	`"BRL"`
`limitAmountReason`	string	Razão pela qual o montante total do limite reportado é zero	`"Limite zerado após análise"`
`customizedLimitAmount`	number	Montante total do limite personalizado pelo cliente através dos canais eletrônicos da instituição	`2000.00`
`customizedLimitAmountCurrencyCode`	string	Código da moeda do montante do limite personalizado	`"BRL"`
`availableAmount`	number	Montante disponível do cartão de crédito adicional	`850.16`
`availableAmountCurrencyCode`	string	Código da moeda do montante disponível	`"BRL"`

Veja Accounts em nossa referência de API para mais informações.

Saldo#

Dados Bancários#

Dados de Crédito#

Limites de Crédito Desagregados#

Quando Usar Limites Desagregados#

Estrutura#