Listar Contas

Lista todas as contas bancárias vinculadas a um item específico.

Endpoint

Método e URL:

GET /v1/items/:itemId/accounts

Parâmetros da URL:

• itemId (string, obrigatório): Identificador único do item

Campos da Resposta

• accounts: Array contendo as contas bancárias
  • id: Identificador único da conta
  • type: Tipo da conta (sempre "BANK" para contas bancárias)
  • subtype: Subtipo da conta (CHECKING_ACCOUNT ou SAVINGS_ACCOUNT)
  • 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": {
    "accounts": [
      {
        "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"
      }
    ]
  }
}