PluggyDocs
GET/accounts/{id}

Recuperar

Recupera o recurso da conta pelo seu id

Parameters

Path Parameters

NameType
idrequired
string

Responses

200Recuperar uma conta.
object

Account of type bank

idrequiredstring

Identificador da conta principal

typerequiredstring

Categoria de conta de nível superior. - `BANK`: contas de depósito (corrente, poupança). O objeto `bankData` é populado. - `CREDIT`: contas de cartão de crédito. O objeto `creditData` é populado.

BANKCREDIT
subtyperequiredstring

Subtipo de conta dentro de seu `type`. - `CHECKING_ACCOUNT`: conta corrente (`type=BANK`). - `SAVINGS_ACCOUNT`: conta poupança (`type=BANK`). - `CREDIT_CARD`: conta de cartão de crédito (`type=CREDIT`). Para estes, o campo `number` é mascarado para os últimos 4 dígitos.

SAVINGS_ACCOUNTCHECKING_ACCOUNTCREDIT_CARD
numberrequiredstring

Identificador externo da conta

namerequiredstring

Nome da conta em um formato descritivo

marketingNamestring

Nome da conta conforme definido externamente

balancerequirednumber (double)

Fundos da conta

itemIdrequiredstring (uuid)

Identificador principal do item anexado

taxNumberstring

CPF do proprietário correspondente

ownerstring

Nome do titular da conta

currencyCoderequiredstring

Código que referencia a moeda do saldo

bankDataobject

Bank account additional fields

transferNumberstring | null

Número completo da conta bancária `(código da agência / número da conta)`

closingBalancenumber (double) | null

Saldo incluindo transações não postadas

automaticallyInvestedBalancenumber (double) | null

Saldo automaticamente investido na conta pela FI

overdraftContractedLimitnumber (double) | null

Limite de cheque especial contratado

overdraftUsedLimitnumber (double) | null

Limite de uso de cheque especial

unarrangedOverdraftAmountnumber (double) | null

Valor da operação contratada em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite pactuado de cheque especial.

hasReservedBalanceboolean | null

Se a conta possui saldos reservados ativos, como poupanças baseadas em metas ou bloqueios judiciais.

reservedBalancesobject[] | null

Fundos reservados/designados na conta. Presente apenas quando hasReservedBalance é verdadeiro e a instituição expõe os dados.

creditDataobject

Credit account additional fields

levelstring | null

Nível do cartão (Black, Signature)

brandstring | null

Marca do Cartão (Visa, Mastercard, Elo)

brandAdditionalInfostring | null

Texto livre descrevendo a categoria da marca quando a marca é 'OUTRA'

balanceCloseDatestring (date-time) | null

Data em que o saldo foi encerrado

balanceDueDatestring (date-time) | null

Data em que o saldo vence

availableCreditLimitnumber (double) | null

Limite de crédito disponível para gastar

balanceForeignCurrencynumber (double) | null

Saldo em USD

minimumPaymentnumber (double) | null

Pagamento mínimo devido

creditLimitnumber (double) | null

Valor máximo que pode ser gasto

isLimitFlexibleboolean | null

Indica se o limite de crédito pode ser ajustado (por exemplo, um cliente pode solicitar um aumento). Retornado apenas quando reportado pela instituição.

statusstring | null

Status do cartão de crédito

ACTIVEBLOCKEDCANCELLEDnull
holderTypestring | null

Tipo de titular do cartão de crédito

MAINADDITIONALnull
disaggregatedCreditLimitsobject[] | null

Limites de cartão de crédito desagregados

additionalCardsobject[] | null

Cartões de crédito adicionais associados ao principal

createdAtrequiredstring (date-time)

Data em que a conta foi criada pela primeira vez no Pluggy

updatedAtrequiredstring (date-time)

Data da última atualização dos dados da conta

Example response

json
{
  "id": "a658c848-e475-457b-8565-d1fffba127c4",
  "type": "BANK",
  "subtype": "SAVINGS_ACCOUNT",
  "number": "40114687/1234",
  "name": "Conta Corrente",
  "marketingName": "SIGNATURE CJA. AHORRO PESOS",
  "balance": 120950,
  "itemId": "a0922d6f-2007-4169-a181-b961500608db",
  "taxNumber": "416.799.495-00",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "bankData": {
    "transferNumber": "string",
    "closingBalance": 0,
    "automaticallyInvestedBalance": 0,
    "overdraftContractedLimit": 0,
    "overdraftUsedLimit": 0,
    "unarrangedOverdraftAmount": 0,
    "hasReservedBalance": true,
    "reservedBalances": [
      {
        "name": "string",
        "identification": "string",
        "availableAmounts": [
          {
            "amount": 0,
            "currencyCode": "string",
            "remuneration": {
              "preFixedRate": 0,
              "postFixedIndexerPercentage": 0,
              "rateType": "string",
              "indexer": "string",
              "calculation": "string",
              "ratePeriodicity": "string",
              "indexerAdditionalInfo": "string"
            }
          }
        ]
      }
    ]
  },
  "creditData": {
    "level": "string",
    "brand": "string",
    "brandAdditionalInfo": "string",
    "balanceCloseDate": "2024-01-01T00:00:00Z",
    "balanceDueDate": "2024-01-01T00:00:00Z",
    "availableCreditLimit": 0,
    "balanceForeignCurrency": 0,
    "minimumPayment": 0,
    "creditLimit": 0,
    "isLimitFlexible": true,
    "status": "ACTIVE",
    "holderType": "MAIN",
    "disaggregatedCreditLimits": [
      {
        "creditLineLimitType": "string",
        "consolidationType": "string",
        "identificationNumber": "string",
        "isLimitFlexible": true,
        "usedAmount": 0,
        "usedAmountCurrencyCode": "string",
        "lineName": "CREDITO_A_VISTA",
        "lineNameAdditionalInfo": "string",
        "limitAmount": 0,
        "limitAmountCurrencyCode": "string",
        "limitAmountReason": "string",
        "customizedLimitAmount": 0,
        "customizedLimitAmountCurrencyCode": "string",
        "availableAmount": 0,
        "availableAmountCurrencyCode": "string"
      }
    ],
    "additionalCards": [
      {
        "number": "string"
      }
    ]
  },
  "createdAt": "2024-01-15T13:21:08.456Z",
  "updatedAt": "2024-07-22T18:05:11.328Z"
}
curl -X GET \
  'https://api.pluggy.ai/accounts/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "id": "a658c848-e475-457b-8565-d1fffba127c4",
  "type": "BANK",
  "subtype": "SAVINGS_ACCOUNT",
  "number": "40114687/1234",
  "name": "Conta Corrente",
  "marketingName": "SIGNATURE CJA. AHORRO PESOS",
  "balance": 120950,
  "itemId": "a0922d6f-2007-4169-a181-b961500608db",
  "taxNumber": "416.799.495-00",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "bankData": {
    "transferNumber": "string",
    "closingBalance": 0,
    "automaticallyInvestedBalance": 0,
    "overdraftContractedLimit": 0,
    "overdraftUsedLimit": 0,
    "unarrangedOverdraftAmount": 0,
    "hasReservedBalance": true,
    "reservedBalances": [
      {
        "name": "string",
        "identification": "string",
        "availableAmounts": [
          {
            "amount": 0,
            "currencyCode": "string",
            "remuneration": {
              "preFixedRate": 0,
              "postFixedIndexerPercentage": 0,
              "rateType": "string",
              "indexer": "string",
              "calculation": "string",
              "ratePeriodicity": "string",
              "indexerAdditionalInfo": "string"
            }
          }
        ]
      }
    ]
  },
  "creditData": {
    "level": "string",
    "brand": "string",
    "brandAdditionalInfo": "string",
    "balanceCloseDate": "2024-01-01T00:00:00Z",
    "balanceDueDate": "2024-01-01T00:00:00Z",
    "availableCreditLimit": 0,
    "balanceForeignCurrency": 0,
    "minimumPayment": 0,
    "creditLimit": 0,
    "isLimitFlexible": true,
    "status": "ACTIVE",
    "holderType": "MAIN",
    "disaggregatedCreditLimits": [
      {
        "creditLineLimitType": "string",
        "consolidationType": "string",
        "identificationNumber": "string",
        "isLimitFlexible": true,
        "usedAmount": 0,
        "usedAmountCurrencyCode": "string",
        "lineName": "CREDITO_A_VISTA",
        "lineNameAdditionalInfo": "string",
        "limitAmount": 0,
        "limitAmountCurrencyCode": "string",
        "limitAmountReason": "string",
        "customizedLimitAmount": 0,
        "customizedLimitAmountCurrencyCode": "string",
        "availableAmount": 0,
        "availableAmountCurrencyCode": "string"
      }
    ],
    "additionalCards": [
      {
        "number": "string"
      }
    ]
  },
  "createdAt": "2024-01-15T13:21:08.456Z",
  "updatedAt": "2024-07-22T18:05:11.328Z"
}