v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Accounts | Dados

Obtém a lista de contas consentidas pelo cliente

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

PERMISSÃO NECESSÁRIA: ACCOUNTS_READ

get/baas/v1/open/dat/accounts

Query parameters

pageinteger

Número da página que está sendo requisitada (o valor da primeira página é 1)

page-sizeinteger

Quantidade total de registros por páginas

Response

Lista de contas obtida com sucesso

Example response

{
  "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"
  }
}