Listar todos os planos criados

Esse endpoint exibe todas os planos criados.

Requisição(Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/plans

--request GET 'https://sandbox.hiperbanco.com.br/plans' \
--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
`page`	`query`	Página do resultado da busca
`perPage`	`query`	Itens por página
`search`	`query`	Query de pesquisa.
`searchColumns`	`query`	Colunas as quais usar para pesquisar, separadas por vírgula. É possivel pesquisar por: `name`, `price`, `type_account`, `availability`
`orderColumn`	`query`	Coluna para ordenação. Valores possíveis: `name`, `price`, `type_account`, `availability`
`orderDirection`	`query`	Sentido da ordenação, pode ser `ASC` (ascendente) ou `DESC` (descendente). Funciona apenas se orderColumn tiver sido especificado

Corpo da requisição (Body)

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

Response

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações dos planos criados

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

Campo	Tipo	Descrição
`[].id`	`string`	Identificador do plano
`[].name`	`string`	Nome do plano
`[].type_account`	`string`	Tipo de conta (PF ou PJ)
`[].benefits`	`string`	Benefícios do plano
`[].description`	`string`	Descrição do plano
`[].visibility`	`boolean`	Indica se o plano é visível
`[].availability`	`boolean`	Indica se o plano está disponível
`[].price`	`number`	Preço padrão do plano
`[].pricePix`	`number`	Preço por operação Pix
`[].priceGenerateDynamicQrCodePix`	`number`	Preço para gerar QR Code Pix dinâmico
`[].priceGenerateStaticQrCodePix`	`number`	Preço para gerar QR Code Pix estático
`[].priceReceiveDynamicQrCodePix`	`number`	Preço para receber QR Code Pix dinâmico
`[].priceReceiveStaticQrCodePix`	`number`	Preço para receber QR Code Pix estático
`[].priceTed`	`number`	Preço por TED
`[].priceBillet`	`number`	Preço por boleto
`[].billSettlementPrice`	`number`	Preço para liquidação de boleto
`[].priceWithdraw`	`number`	Preço por saque
`[].priceP2P`	`number`	Preço por transferência P2P
`[].quantityPix`	`number`	Quantidade de operações Pix incluídas
`[].quantityBillSettlement`	`number`	Quantidade de liquidações de boletos incluídas
`[].quantityGenerateDynamicQrCodePix`	`number`	Quantidade de QR Codes Pix dinâmicos incluídos
`[].quantityGenerateStaticQrCodePix`	`number`	Quantidade de QR Codes Pix estáticos incluídos
`[].quantityReceiveDynamicQrCodePix`	`number`	Quantidade de recebimentos via QR Code dinâmico
`[].quantityReceiveStaticQrCodePix`	`number`	Quantidade de recebimentos via QR Code estático
`[].quantityTed`	`number`	Quantidade de TEDs incluídas
`[].quantityBillet`	`number`	Quantidade de boletos incluídos
`[].quantityPeriodo`	`number`	Período de referência para quantidades
`[].quantityP2P`	`number`	Quantidade de transferências P2P incluídas
`[].timeDefault`	`number`	Tempo padrão do plano
`[].planDefault`	`boolean`	Indica se é o plano padrão
`[].contract`	`string`	URL do contrato do plano
`[].daysUntilFirstPayment`	`number`	Dias até o primeiro pagamento
`[].createdAt`	`string`	Data de criação do plano
`[].updatedAt`	`string`	Data da última atualização do plano
`[].deletedAt`	`string`	Data de exclusão do plano
`[].client`	`object`	Informações do cliente
`[].client.id`	`string`	Identificador do cliente
`[].client.name`	`string`	Nome do cliente
`[].client.address`	`string`	Endereço do cliente
`[].client.client_id`	`string`	Identificador do cliente
`[].client.documentNumber`	`string`	Documento do cliente
`[].client.cnpj`	`string`	CNPJ do cliente
`[].client.email`	`string`	Email do cliente
`[].client.responsavel`	`string`	Nome do responsável pelo cliente
`[].client.phone`	`string`	Telefone do cliente
`[].client.branch`	`string`	Agência vinculada
`[].client.number`	`string`	Número da conta vinculada
`[].client.createdAt`	`string`	Data de criação do cliente
`[].client.updatedAt`	`string`	Data da última atualização do cliente
`[].client.deletedAt`	`string`	Data de exclusão do cliente
`[].client.ccbId`	`string`	Identificador da CCB
`[].client.ccbAccountBranch`	`string`	Agência vinculada à CCB
`[].client.ccbAccountNumber`	`string`	Número da conta vinculada à CCB
`[].client.ccbDocumentNumber`	`string`	Documento vinculado à CCB
`[].client.ccbFundingId`	`string`	Identificador de funding da CCB
`[].client.logoUrl`	`string`	URL do logotipo do cliente
`[].client.brandColor`	`string`	Cor da marca do cliente
`[].client.versionApp`	`string`	Versão do aplicativo do cliente
`[].client.shouldSendCardToCompanyAddress`	`boolean`	Indica se envia cartão para endereço da empresa

[
  {
    "id": "0bb24fa1-b916-49e7-8911-84aa347936ad",
    "name": "Plano A",
    "type_account": "PJ",
    "benefits": "Plano A",
    "description": "Plano Padrão",
    "visibility": true,
    "availability": true,
    "price": 0,
    "pricePix": 0,
    "priceGenerateDynamicQrCodePix": 0,
    "priceGenerateStaticQrCodePix": 0,
    "priceReceiveDynamicQrCodePix": 0,
    "priceReceiveStaticQrCodePix": 0,
    "priceTed": 0,
    "priceBillet": 0,
    "billSettlementPrice": 0,
    "priceWithdraw": 0,
    "priceP2P": 0,
    "quantityPix": 0,
    "quantityBillSettlement": 0,
    "quantityGenerateDynamicQrCodePix": 0,
    "quantityGenerateStaticQrCodePix": 0,
    "quantityReceiveDynamicQrCodePix": 0,
    "quantityReceiveStaticQrCodePix": 0,
    "quantityTed": 0,
    "quantityBillet": 0,
    "quantityPeriodo": 0,
    "quantityP2P": 0,
    "timeDefault": 0,
    "planDefault": false,
    "contract": "https://hiperbanco-sandbox.s3.amazonaws.com/plans%2Fcontracts%2F1755548829231-Plano%20A.pdf",
    "daysUntilFirstPayment": 1,
    "createdAt": "2023-02-01T16:10:28.195Z",
    "updatedAt": "2025-09-26T01:56:13.000Z",
    "deletedAt": null,
    "client": {
      "id": "a5723d19-8e3b-47d4-9d8b-11f93a2a7c21",
      "name": "Banco Nova Era",
      "address": "Avenida Central, 1200 - Centro",
      "client_id": "8f1c28db-412f-4f39-9e74-7e2d9b45e8a2",
      "documentNumber": "12345678000195",
      "cnpj": "12345678000195",
      "email": "[email protected]",
      "responsavel": "Fernanda Souza",
      "phone": "11987654321",
      "branch": "Agência Central",
      "number": "45",
      "createdAt": "2022-12-15T10:05:45.933Z",
      "updatedAt": "2025-07-01T09:14:28.000Z",
      "deletedAt": null,
      "ccbId": "7kq1hte9a2pllw3dfj8zrty2mn",
      "ccbAccountBranch": "0005",
      "ccbAccountNumber": "998877",
      "ccbDocumentNumber": "45789213560",
      "ccbFundingId": "a7c92eeb-4fc5-4c6b-8f01-2b36df901238",
      "logoUrl": "https://hiperbanco-sandbox.s3.amazonaws.com/logos%2FBancoNovaEra-logo.svg",
      "brandColor": "#0055cc",
      "versionApp": "2.3.4",
      "shouldSendCardToCompanyAddress": true
    }
  }
]

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.