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.

{
  "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": "333.333.333-33",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "bankData": {
    "transferNumber": "123/0001/12345-0",
    "closingBalance": 120950,
    "automaticallyInvestedBalance": 100,
    "overdraftContractedLimit": 0,
    "overdraftUsedLimit": 0,
    "unarrangedOverdraftAmount": 0
  }
}

{
  "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"
  }
}

Saldo#

Os saldos das Contas Bancárias (Corrente e Poupança) representam o montante que o titular atualmente possui 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.

Saldos de contas bancárias em Open Finance#

Para conectores de Open Finance, a instituição relata o montante disponível de uma conta bancária e, quando os possui, o montante bloqueado e o montante automaticamente investido. Nem toda instituição relata os dois últimos, então trate-os como opcionais. A Pluggy os mapeia assim:

A soma em closingBalance é a mesma para cada conector de Open Finance. O que muda para algumas instituições é qual montante é usado como balance.

Itaú e Banco do Brasil. No Itaú PF (601), Itaú PJ (618), Banco do Brasil PF (611) e Banco do Brasil PJ (662), quando o montante automaticamente investido é maior que zero, ele é usado como balance em vez do montante disponível, e closingBalance é calculado a partir disso. Essas instituições relatam o dinheiro mantido no investimento automático (investimento automático do Itaú, Rende Fácil do Banco do Brasil) separadamente do montante disponível: algumas enviam o mesmo valor em ambos, outras enviam zero como disponível e o montante total como automaticamente investido. Em ambos os casos, o titular da conta vê esse montante como seu saldo no aplicativo do banco, então é isso que balance retorna. automaticallyInvestedBalance ainda retorna o montante exatamente como reportado.

Cheque especial. Se balance for zero e a conta tiver cheque especial em uso (overdraftUsedLimit maior que zero), balance é retornado como o negativo do cheque especial utilizado. Isso se aplica ao saldo coletado quando o item é sincronizado; o endpoint de saldo em tempo real retorna os montantes da instituição sem esse ajuste.

Dados bancários#

Dados de Crédito#

Limites de Crédito Desagregados#

Alguns cartões de crédito podem ter múltiplas 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#

disaggregatedCreditLimits vive dentro de creditData e é um array de objetos, um por linha de crédito:

{
  "creditData": {
    "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#

Veja ContasAPI em nossa referência da API para mais informações.