GET
Recuperar conta

Authorizations

X-API-KEY
string
header
required

Chave de API obrigatória em todas as rotas.

Path Parameters

id
string<uuid>
required

Identificador primário da conta.

Response

Objeto Account.

Conta bancária (type=BANK) ou de cartão de crédito (type=CREDIT) coletada para um item. Consulte balanceAvailable antes de interpretar o scalar balance; balances preserva conjuntos que não podem ser reduzidos com fidelidade.

id
string<uuid>
required

Identificador primário da conta.

itemId
string<uuid>
required

Identificador primário do item ao qual a conta está vinculada.

type
enum<string>
required

BANK = contas bancárias, de poupança, empréstimo, caixa ou outros produtos AIS, com bankData populado. CREDIT = contas de cartão de crédito, com creditData populado.

Available options:
BANK,
CREDIT
subtype
enum<string>
required

CHECKING_ACCOUNT (corrente), SAVINGS_ACCOUNT (poupança), LOAN_ACCOUNT (empréstimo), CASH_ACCOUNT (caixa) e OTHER_ACCOUNT (outro tipo AIS) usam type=BANK; CREDIT_CARD usa type=CREDIT. Para cartões, number é mascarado nos últimos 4 dígitos.

Available options:
CHECKING_ACCOUNT,
SAVINGS_ACCOUNT,
CREDIT_CARD,
LOAN_ACCOUNT,
CASH_ACCOUNT,
OTHER_ACCOUNT
number
string
required

Identificador externo da conta (ex.: 0001/12345-0) ou últimos 4 dígitos do cartão.

name
string
required

Nome descritivo da conta (ex.: Conta Corrente).

balance
number
required

Scalar normalizado da última coleta. Só deve ser interpretado quando balanceAvailable=true.

balanceAvailable
boolean
required

Indica se balance representa um scalar fiel na moeda da conta.

currencyCode
string
required

ISO 4217 (ex.: BRL).

createdAt
string<date-time>
required

Quando a conta foi criada no agregador.

updatedAt
string<date-time>
required

Última atualização dos dados da conta.

marketingName
string | null

Nome da marca/produto conforme definido pela instituição.

balanceUpdatedAt
string<date-time> | null

Momento informado/persistido para a última coleta de saldo.

balances
object[]

Conjunto completo de saldos retornado pelo provedor, usado especialmente em contas multimoeda.

taxNumber
string | null

CPF/CNPJ do titular, formatado (ex.: 416.799.495-00).

owner
string | null

Nome completo do titular da conta.

bankData
object | null

Presente quando type=BANK.

creditData
object | null

Presente quando type=CREDIT.