Openi DeveloperDeveloper
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/:accountId

Parâmetros da URL:

  • itemId (string, obrigatório): Identificador único do item
  • accountId (string, obrigatório): Identificador único da conta bancária

Campos da Resposta

  • id: Identificador único da conta
  • type: Tipo da conta (sempre "BANK" para contas bancárias)
  • subtype: Subtipo da conta (conta corrente ou poupança)
  • bankCompeCode: Código COMPE do banco
  • bankBranchNumber: Número da agência
  • accountNumber: Número da conta
  • accountDigit: Dígito verificador da conta
  • accountSuffix: Sufixo da conta (presente em algumas contas poupança)
  • currency: Código da moeda (ex: "BRL")
  • currentBalance: Saldo atual da conta
  • currentAutomaticallyInvestedBalance: Saldo investido automaticamente
  • overdraftLimit: Limite do cheque especial disponível
  • overdraftUsedLimit: Valor utilizado do cheque especial
  • createdAt: Data de criação
  • updatedAt: 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."
}

On this page