---
title: "Consulta dos dados de todas as contas pockets"
method: GET
path: "/accounts/{accountNumber}/pockets"
tags: ["Conta pocket"]
---

# Consulta dos dados de todas as contas pockets

`GET /accounts/{accountNumber}/pockets`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}/pockets`
- Auth: HTTP bearer

<div class="bkly-ref-description">
  <p>Obtenha uma lista com os dados de todas as contas pockets associadas a uma conta de pagamento. A busca permite filtrar pelo status e pelo tipo da conta pocket.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> 
  <span class="bkly-ref-scope-tag">pocket.read</span> 
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Consulta dos dados de todas as contas pockets](/docs/consulta-dados-todas-pockets)."
}
[/block]

## Path parameters

- `accountNumber` string, nullable, required: Número da conta de pagamento com dígito.

## Query parameters

- `pocketType` string, nullable: Tipo da Pocket. Exemplo: Pocket_BRL.
- `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'CLOSED', nullable: Situação da conta Pocket.
- `pageSize` integer: Quantidade de itens a serem retornados por página.
- `page` integer: Pagina a ser retornada.

## Parameters

- `#/paths/~1pockets~1{pocketNumber}/get/parameters/2` (unresolved $ref)
- `#/paths/~1legal-agreements~1file/get/parameters/1` (unresolved $ref)

## Response `200`

Recurso encontrado

- GetPocketByAccountNumberResponse
  - `data` GetPocketByAccountNumberResp[], nullable
    - `number` string: Número da conta pocket.
    - `label` string: Nome descritivo da conta pocket.
    - `suffix` string: Sufixo atribuído ao número da pocket. Exemplo: BRL.
    - `currency` string: Sigla da moeda corrente da pocket.
    - `type` string: Tipo da conta com a sigla da moeda. Exemplo: POCKET_BRL.
    - `status` string: Situação da conta pocket.
    - `reason` string: Motivo da situação da conta pocket. Nesse caso, sempre será HOLDER_REQUEST.
    - `category` string: Categoria da conta.
    - `useCase` string: Motivo de uso da conta pocket, que pode ser: “ACCOUNT_FOR_UNDER_AGE” (Conta para menor de idade), “CORPORATE_EXPENSES” (Despesas corporativas), “FLEXIBLE_BENEFITS” (Benefícios flexíveis) e “BALANCE_SEGREGATION” (Segregação de saldo).
    - `createdAt` string: Data de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
    - `updatedAt` string: Data de atualização da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
    - `user` User
      - `name` string, required: Nome do usuário da conta pocket.
      - `document` Document, required
        - `value` string, nullable: Número do documento do usuário.
        - `type` 'CPF' | 'CNPJ': Tipo do documento do titular da conta.
      - `birthDate` string, date-time, required: Data de nascimento do usuário da conta pocket.
  - `links` Link[], nullable
    - `url` string, nullable: URLs que podem ser utilizadas em um próximo estado da entidade. Nesse caso, trata-se da própria requisição realizada.
    - `rel` string, nullable: Descrição de como a URL se relaciona com o recurso atual.
    - `method` string, nullable: Tipo de verbo que deve ser utilizado para acessar a URL. Nesse caso, é o GET.
  - `metadata` object, nullable

## Other responses

- `401` (unresolved $ref)
- `403` (unresolved $ref)
- `404` (unresolved $ref)
- `500` (unresolved $ref)
- `503` (unresolved $ref)

---

[API](https://skmtc.dev/bankly/apis/gest-o-de-contas.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-contas/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-contas/revisions/39000596dbd3?raw)