Bank account
Buscar Conta Específica
Retorna os detalhes de uma conta bancária específica.
Endpoint
Método e URL:
GET /v1/items/:itemId/accounts/:accountIdParâmetros da URL:
itemId(string, obrigatório): Identificador único do itemaccountId(string, obrigatório): Identificador único da conta bancária
Campos da Resposta
id: Identificador único da contatype: Tipo da conta (sempre "BANK" para contas bancárias)subtype: Subtipo da conta (conta corrente ou poupança)bankCompeCode: Código COMPE do bancobankBranchNumber: Número da agênciaaccountNumber: Número da contaaccountDigit: Dígito verificador da contaaccountSuffix: Sufixo da conta (presente em algumas contas poupança)currency: Código da moeda (ex: "BRL")currentBalance: Saldo atual da contacurrentAutomaticallyInvestedBalance: Saldo investido automaticamenteoverdraftLimit: Limite do cheque especial disponíveloverdraftUsedLimit: Valor utilizado do cheque especialcreatedAt: Data de criaçãoupdatedAt: Data da última atualização
Resposta
Resposta de sucesso (200):
{
"status": "success",
"data": {
"id": "uuid",
"type": "BANK",
"subtype": "CHECKING_ACCOUNT | SAVINGS_ACCOUNT",
"bankCompeCode": "string",
"bankBranchNumber": "string",
"accountNumber": "string",
"accountDigit": "string",
"accountSuffix": "string",
"currency": "string",
"currentBalance": "string",
"currentAutomaticallyInvestedBalance": "string",
"overdraftLimit": "string",
"overdraftUsedLimit": "string",
"createdAt": "timestamp",
"updatedAt": "timestamp"
}
}Resposta de erro (404):
{
"status": "error",
"message": "Bank account not found."
}
