Contas vinculadas a um plano

Esse endpoint irá listar todas as contas vinculadas a um plano.

Requisição(Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/plans/activeAccounts/{id}

--request GET 'https://sandbox.hiperbanco.com.br/plans/activeAccounts/{id}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição
`id`	`path`	Identificador do plano
`page`	`query`	Página do resultado da busca
`perPage`	`query`	Itens por página
`search`	`query`	Query de pesquisa - É possível pesquisar pelo `account_number` e `onboarding_registerName`

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações das contas que estão vinculados a aquele plano

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Campo	Tipo	Descrição
`items`	`array`	Lista de contas
`items[].account_id`	`string`	Identificador da conta
`items[].account_status`	`string`	Status da conta
`items[].account_number`	`string`	Número da conta
`items[].planBilling_status`	`string`	Status de cobrança do plano
`items[].onboarding_registerName`	`string`	Nome do titular
`items[].plan_name`	`string`	Nome do plano associado
`items[].createdAt`	`string`	Data de criação da conta
`meta`	`object`	Metadados da listagem
`meta.totalItems`	`number`	Total de itens
`meta.itemCount`	`number`	Quantidade de itens retornados nesta página
`meta.itemsPerPage`	`number`	Quantidade máxima de itens por página
`meta.totalPages`	`number`	Total de páginas
`meta.currentPage`	`number`	Página atual

{
  "items": [
    {
      "account_id": "8f3d2b41-1234-4c8d-9b9e-62c7f9a8a111",
      "account_status": "ACTIVE",
      "account_number": "9988776655",
      "planBilling_status": "WAITING",
      "onboarding_registerName": "Lucas Andrade Silva",
      "plan_name": "Plano A",
      "createdAt": "20/07/2024 09:15:42"
    },
    {
      "account_id": "5a7bc1d2-5678-49d0-88cd-42efc0d9b222",
      "account_status": "CLOSE",
      "account_number": "4433221100",
      "planBilling_status": "WAITING",
      "onboarding_registerName": "Fernanda Costa Almeida",
      "plan_name": "Plano A",
      "createdAt": "15/03/2023 16:25:11"
    }
  ],
  "meta": {
    "totalItems": 2,
    "itemCount": 2,
    "itemsPerPage": 5,
    "totalPages": 1,
    "currentPage": 1
  }
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.