API Contas

GET /baas/v1/open/dat/accounts

Obtém a lista de contas de depósito à vista, poupança e pagamento pré-pagas mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Permission necessária: ACCOUNTS_READ

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`accountType`	string	Filtro pelo tipo de conta. Enum: `CONTA_DEPOSITO_A_VISTA`, `CONTA_POUPANCA`, `CONTA_PAGAMENTO_PRE_PAGA`.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "brandName": "Organização A",
      "companyCnpj": "21128159000166",
      "type": "CONTA_DEPOSITO_A_VISTA",
      "compeCode": "001",
      "branchCode": "6272",
      "number": "94088392",
      "checkDigit": "4",
      "accountId": "92792126019929279212650822221989319252576"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].brandName: Nome da marca reportada pelo participante no Open Finance. Preferencialmente o mesmo nome atribuído no diretório Customer Friendly Server Name.
data[].companyCnpj: CNPJ completo da instituição responsável pelo cadastro (sem máscara).
data[].type: Tipo da conta. Enum: CONTA_DEPOSITO_A_VISTA (conta corrente), CONTA_POUPANCA, CONTA_PAGAMENTO_PRE_PAGA.
data[].compeCode: Código COMPE da instituição atribuído pelo Banco Central do Brasil (3 dígitos).
data[].branchCode: Código da agência detentora da conta (4 dígitos). Obrigatório quando type for diferente de CONTA_PAGAMENTO_PRE_PAGA.
data[].number: Número da conta (8 a 20 dígitos).
data[].checkDigit: Dígito verificador da conta. Obrigatório quando type for diferente de conta pré-paga ou quando a conta pré-paga possuir dígito.
data[].accountId: Identificador único e imutável da conta do cliente na instituição transmissora.
links.self: URI completa que gerou a resposta atual.
links.first: URI da primeira página. Obrigatório quando não for a primeira página.
links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
links.next: URI da próxima página. Obrigatório quando não for a última página.
links.last: URI da última página. Obrigatório quando não for a última página.
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/accounts/{accountId}

Obtém os dados de identificação da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId.

Permission necessária: ACCOUNTS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`accountId`	string	Identificador único da conta.

Exemplo de resposta (200 OK)

{
  "data": {
    "compeCode": "001",
    "branchCode": "6272",
    "number": "24550245",
    "checkDigit": "4",
    "type": "CONTA_DEPOSITO_A_VISTA",
    "subtype": "INDIVIDUAL",
    "currency": "BRL"
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.compeCode: Código COMPE da instituição atribuído pelo Banco Central do Brasil (3 dígitos).
data.branchCode: Código da agência detentora da conta (4 dígitos). Obrigatório quando type for diferente de CONTA_PAGAMENTO_PRE_PAGA.
data.number: Número da conta (8 a 20 dígitos).
data.checkDigit: Dígito verificador da conta. Obrigatório quando type for diferente de conta pré-paga ou quando a conta pré-paga possuir dígito.
data.type: Tipo da conta. Enum: CONTA_DEPOSITO_A_VISTA, CONTA_POUPANCA, CONTA_PAGAMENTO_PRE_PAGA.
data.subtype: Subtipo da conta. Enum: INDIVIDUAL (único titular), CONJUNTA_SIMPLES (movimentações requerem autorização de todos os titulares), CONJUNTA_SOLIDARIA (cada titular pode movimentar de forma isolada).
data.currency: Moeda da conta no padrão ISO-4217 (ex: BRL).
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/accounts/{accountId}/balances

Obtém os saldos da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId.

Permission necessária: ACCOUNTS_BALANCES_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`accountId`	string	Identificador único da conta.

Exemplo de resposta (200 OK)

{
  "data": {
    "availableAmount": {
      "amount": "1000.0400",
      "currency": "BRL"
    },
    "blockedAmount": {
      "amount": "1000.0400",
      "currency": "BRL"
    },
    "automaticallyInvestedAmount": {
      "amount": "1000.0400",
      "currency": "BRL"
    },
    "updateDateTime": "2021-05-21T08:30:00Z",
    "hasReservedBalance": true
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.availableAmount.amount: Saldo disponível para utilização imediata. Não considera cheque especial, investimentos automáticos nem reserva de saldo. Com 2 a 4 casas decimais. Pode ser negativo.
data.availableAmount.currency: Moeda no padrão ISO-4217 (ex: BRL).
data.blockedAmount.amount: Saldo bloqueado, indisponível para uso imediato por motivo de bloqueio apresentado ao cliente nos canais eletrônicos. Com 2 a 4 casas decimais.
data.blockedAmount.currency: Moeda no padrão ISO-4217.
data.automaticallyInvestedAmount.amount: Saldo disponível somado ao valor obtido pela aplicação automática atrelada à conta. Com 2 a 4 casas decimais.
data.automaticallyInvestedAmount.currency: Moeda no padrão ISO-4217.
data.updateDateTime: Data e hora da última captura do saldo para compartilhamento no Open Finance, no formato RFC-3339 UTC. Pode refletir captura síncrona (segundos atrás) ou assíncrona (horas ou dias atrás).
data.hasReservedBalance: Indica se o cliente possui saldo reservado ativo (true). false quando não possui o produto. Quando true, os detalhes estão disponíveis em GET /accounts/{accountId}/reserved-balances. Obrigatório para transmissoras que ofertam produtos de reserva de saldo. Não se aplica a investimentos (reportados nas APIs de Investimentos).
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/accounts/{accountId}/transactions

Obtém a lista de transações da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId. Permite consulta de até 12 meses no passado e 12 meses no futuro. A lista é ordenada da transação mais recente para a mais antiga, incluindo lançamentos futuros.

Permission necessária: ACCOUNTS_TRANSACTIONS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`accountId`	string	Identificador único da conta.

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`fromBookingDate`	date	Data inicial de filtragem pelo `transactionDateTime` (`YYYY-MM-DD`). Obrigatório se `toBookingDate` for informado. Se não informado, assume o dia atual.
`toBookingDate`	date	Data final de filtragem pelo `transactionDateTime` (`YYYY-MM-DD`). Obrigatório se `fromBookingDate` for informado. Se não informado, assume o dia atual.
`creditDebitIndicator`	string	Filtro pelo tipo de lançamento. Enum: `CREDITO`, `DEBITO`.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
      "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
      "creditDebitType": "DEBITO",
      "transactionName": "Transferencia Enviada Lima Santos",
      "type": "PIX",
      "typeAdditionalInfo": "APLIC_FINANCEIRA",
      "transactionAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "transactionDateTime": "2016-01-29T12:29:03.374Z",
      "partieCnpjCpf": "43908445778",
      "partiePersonType": "PESSOA_NATURAL",
      "partieCompeCode": "001",
      "partieBranchCode": "6272",
      "partieNumber": "67890854360",
      "partieCheckDigit": "4",
      "codeISPB": "00300300"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].transactionId: Código ou identificador único prestado pela instituição para representar a transação individual. Deve obedecer as regras de imutabilidade conforme tabela de tipos de transação.
data[].completedAuthorisedPaymentType: Indicador do status da transação. Enum: TRANSACAO_EFETIVADA (transactionId imutável), LANCAMENTO_FUTURO (transactionId pode mudar), TRANSACAO_PROCESSANDO (transactionId pode mudar).
data[].creditDebitType: Tipo de lançamento no extrato. Enum: CREDITO (entrada de recursos), DEBITO (saída de recursos).
data[].transactionName: Literal usada pela instituição para identificar a transação. Deve ser idêntica à exibida nos canais digitais. Quando há múltiplas linhas, todas devem ser concatenadas neste campo.
data[].type: Tipo da transação. Enum: TED, DOC, PIX, TRANSFERENCIA_MESMA_INSTITUICAO, BOLETO, CONVENIO_ARRECADACAO, PACOTE_TARIFA_SERVICOS, TARIFA_SERVICOS_AVULSOS, FOLHA_PAGAMENTO, DEPOSITO, SAQUE, CARTAO, ENCARGOS_JUROS_CHEQUE_ESPECIAL, RENDIMENTO_APLIC_FINANCEIRA, PORTABILIDADE_SALARIO, APLICACAO_FINANCEIRA, RESGATE_APLIC_FINANCEIRA, OPERACAO_CREDITO, TRANSFERENCIA_SALDO_RESERVADO, OUTROS.
data[].typeAdditionalInfo: Informações complementares do tipo de transação. Obrigatório quando type for OUTROS.
data[].transactionAmount.amount: Valor da transação com 2 a 4 casas decimais.
data[].transactionAmount.currency: Moeda da transação no padrão ISO-4217.
data[].transactionDateTime: Data e hora original da transação informada nos canais digitais, no formato RFC-3339 com milissegundos (ex: 2016-01-29T12:29:03.374Z). Para lançamentos futuros, deve refletir a data prevista de efetivação. Após efetivação, deve conter data e hora da efetivação.
data[].partieCnpjCpf: CPF ou CNPJ da contraparte (pagador ou recebedor), sem formatação. A partir de 02/05/23, obrigatório para transações de pagamento (IN BCB nº 371). Para FOLHA_PAGAMENTO quando a transmissora for o banco-folha, deve ser o CNPJ do empregador.
data[].partiePersonType: Tipo de pessoa da contraparte. Enum: PESSOA_NATURAL (informar CPF em partieCnpjCpf), PESSOA_JURIDICA (informar CNPJ em partieCnpjCpf).
data[].partieCompeCode: Código COMPE da instituição da contraparte (3 dígitos). Obrigatório quando a instituição possuir o número-código.
data[].partieBranchCode: Código da agência da conta da contraparte (4 dígitos).
data[].partieNumber: Número da conta da contraparte (8 a 20 dígitos).
data[].partieCheckDigit: Dígito verificador da conta da contraparte.
data[].codeISPB: Código ISPB da instituição contraparte. Para CREDITO: ISPB da instituição de origem dos recursos. Para DEBITO: ISPB da instituição de destino. Obrigatório quando existir informação de contraparte.
links.self: URI completa que gerou a resposta atual.
links.first: URI da primeira página. Obrigatório quando não for a primeira página.
links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
links.next: URI da próxima página. Obrigatório quando não for a última página.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/accounts/{accountId}/transactions-current

Obtém a lista de transações recentes da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId. Permite consulta de até 7 dias no passado e 12 meses no futuro. A lista é ordenada da transação mais recente para a mais antiga.

Permission necessária: ACCOUNTS_TRANSACTIONS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`accountId`	string	Identificador único da conta.

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`fromBookingDate`	date	Data inicial de filtragem. Período máximo: 7 dias no passado, inclusive (D-6), e 12 meses no futuro. Obrigatório se `toBookingDate` for informado. Se não informado, assume o dia atual.
`toBookingDate`	date	Data final de filtragem. Período máximo: 7 dias no passado, inclusive (D-6), e 12 meses no futuro. Obrigatório se `fromBookingDate` for informado. Se não informado, assume o dia atual.
`creditDebitIndicator`	string	Filtro pelo tipo de lançamento. Enum: `CREDITO`, `DEBITO`.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
      "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
      "creditDebitType": "DEBITO",
      "transactionName": "Transferencia Enviada Lima Santos",
      "type": "PIX",
      "typeAdditionalInfo": "APLIC_FINANCEIRA",
      "transactionAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "transactionDateTime": "2016-01-29T12:29:03.374Z",
      "partieCnpjCpf": "43908445778",
      "partiePersonType": "PESSOA_NATURAL",
      "partieCompeCode": "001",
      "partieBranchCode": "6272",
      "partieNumber": "67890854360",
      "partieCheckDigit": "4",
      "codeISPB": "00300300"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

Este endpoint retorna a mesma estrutura de resposta que GET /accounts/{accountId}/transactions. A diferença está nos limites de período de consulta: máximo de 7 dias no passado (D-6) mais 12 meses no futuro, em vez dos 12 meses no passado do endpoint histórico.

O objeto meta contém apenas requestDateTime (sem totalRecords e totalPages), e o objeto links não possui o campo last. Consulte a descrição completa dos campos na seção anterior.

GET /baas/v1/open/dat/accounts/{accountId}/overdraft-limits

Obtém os limites de cheque especial e adiantamento a depositante da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId. Instituições que possuam contas sem limites associados devem retornar HTTP 200 com o objeto data vazio.

Permission necessária: ACCOUNTS_OVERDRAFT_LIMITS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`accountId`	string	Identificador único da conta.

Exemplo de resposta (200 OK)

{
  "data": {
    "overdraftContractedLimit": {
      "amount": "1000.0400",
      "currency": "BRL"
    },
    "overdraftUsedLimit": {
      "amount": "1000.0400",
      "currency": "BRL"
    },
    "unarrangedOverdraftAmount": {
      "amount": "1000.0400",
      "currency": "BRL"
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.overdraftContractedLimit.amount: Valor do limite contratado do cheque especial. Com 2 a 4 casas decimais.
data.overdraftContractedLimit.currency: Moeda do limite no padrão ISO-4217 (ex: BRL).
data.overdraftUsedLimit.amount: Valor utilizado total do limite do cheque especial e do adiantamento a depositante. Com 2 a 4 casas decimais.
data.overdraftUsedLimit.currency: Moeda no padrão ISO-4217.
data.unarrangedOverdraftAmount.amount: Valor de 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. Com 2 a 4 casas decimais.
data.unarrangedOverdraftAmount.currency: Moeda no padrão ISO-4217.
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.