Detalhes do plano

Esse endpoint exibe dos detalhes dos planos

Requisição(Request)

Requisição HTTP

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

--request GET 'https://sandbox.hiperbanco.com.br/plans/{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)

Nome	Tipo	Descrição
`id`	`path`	Identificador do plano

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 único do plano.
`name`	`string`	Nome do plano.
`type_account`	`string`	Tipo de conta vinculada ao plano (`PF`, `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 base do plano.
`pricePix`	`number`	Preço por transação Pix.
`priceGenerateDynamicQrCodePix`	`number`	Preço por geração de QR Code dinâmico Pix.
`priceGenerateStaticQrCodePix`	`number`	Preço por geração de QR Code estático Pix.
`priceReceiveDynamicQrCodePix`	`number`	Preço por recebimento via QR Code dinâmico Pix.
`priceReceiveStaticQrCodePix`	`number`	Preço por recebimento via QR Code estático Pix.
`priceTed`	`number`	Preço por operação TED.
`priceBillet`	`number`	Preço por boleto emitido.
`billSettlementPrice`	`number`	Preço por liquidação de boleto.
`priceWithdraw`	`number`	Preço por saque.
`priceP2P`	`number`	Preço por operação P2P.
`quantityPix`	`number`	Quantidade de transações Pix inclusas.
`quantityBillSettlement`	`number`	Quantidade de liquidações de boletos inclusas.
`quantityGenerateDynamicQrCodePix`	`number`	Quantidade de gerações de QR Code dinâmico Pix inclusas.
`quantityGenerateStaticQrCodePix`	`number`	Quantidade de gerações de QR Code estático Pix inclusas.
`quantityReceiveDynamicQrCodePix`	`number`	Quantidade de recebimentos via QR Code dinâmico Pix inclusos.
`quantityReceiveStaticQrCodePix`	`number`	Quantidade de recebimentos via QR Code estático Pix inclusos.
`quantityTed`	`number`	Quantidade de operações TED inclusas.
`quantityBillet`	`number`	Quantidade de boletos inclusos.
`quantityPeriodo`	`number`	Período de apuração do plano (em dias/meses).
`quantityP2P`	`number`	Quantidade de operações P2P inclusas.
`timeDefault`	`number`	Tempo padrão de vigência (em dias).
`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/hora de criação do plano.
`updatedAt`	`string`	Data/hora da última atualização do plano.
`deletedAt`	`string`	Data/hora de exclusão do plano (se houver).
`client`	`object`	Dados do cliente vinculado ao plano.
`client.id`	`string`	Identificador único do cliente.
`client.name`	`string`	Nome do cliente.
`client.address`	`string`	Endereço do cliente.
`client.client_id`	`string`	Identificador do cliente no sistema.
`client.documentNumber`	`string`	Documento do cliente (CNPJ/CPF).
`client.cnpj`	`string`	CNPJ do cliente.
`client.email`	`string`	E-mail de contato do cliente.
`client.responsavel`	`string`	Nome do responsável.
`client.phone`	`string`	Telefone de contato.
`client.branch`	`string`	Agência vinculada (se houver).
`client.number`	`string`	Número da conta vinculada (se houver).
`client.createdAt`	`string`	Data/hora de criação do cliente.
`client.updatedAt`	`string`	Data/hora da última atualização do cliente.
`client.deletedAt`	`string`	Data/hora de exclusão do cliente (se houver).
`client.ccbId`	`string`	Identificador 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 principal da marca.
`client.versionApp`	`string`	Versão do aplicativo.
`client.shouldSendCardToCompanyAddress`	`boolean`	Indica se o cartão deve ser enviado para o endereço da empresa.
`quantityWithdraw`	`number`	Quantidade de saques inclusos.

{
    "id": "0accbb77-208b-4e6e-9a67-9d875442d7e1",
    "name": "Criando um plano",
    "type_account": "PF",
    "benefits": "inserir todos os beneficios",
    "description": "Descrição do plano",
    "visibility": true,
    "availability": true,
    "price": 1.12,
    "pricePix": 1.12,
    "priceGenerateDynamicQrCodePix": 1.12,
    "priceGenerateStaticQrCodePix": 1.12,
    "priceReceiveDynamicQrCodePix": 1.12,
    "priceReceiveStaticQrCodePix": 1.12,
    "priceTed": 1.12,
    "priceBillet": 1.12,
    "billSettlementPrice": 1.12,
    "priceWithdraw": 1.12,
    "priceP2P": 1.12,
    "quantityPix": 10,
    "quantityBillSettlement": 10,
    "quantityGenerateDynamicQrCodePix": 10,
    "quantityGenerateStaticQrCodePix": 10,
    "quantityReceiveDynamicQrCodePix": 10,
    "quantityReceiveStaticQrCodePix": 10,
    "quantityTed": 10,
    "quantityBillet": 10,
    "quantityPeriodo": 0,
    "quantityP2P": 10,
    "timeDefault": 0,
    "planDefault": true,
    "contract": "https:/sandbox.s3.amazonaws.com/plans%2Fcontracts%2F34234234-Criando%20um%20plano.pdf",
    "daysUntilFirstPayment": 1,
    "createdAt": "2025-09-28T21:26:15.699Z",
    "updatedAt": "2025-09-28T21:26:15.699Z",
    "deletedAt": null,
    "client": {
        "id": "e5ae05b0-11fb-4625-9a4b-9cb299abe0fc",
        "name": "Hiperbanco Sandbox",
        "address": "Parque Tecnologico",
        "client_id": "e5ae05b0-11fb-4625-9a4b-9cb299abe0fc",
        "documentNumber": "67524151000110",
        "cnpj": "67524151000110",
        "email": "[email protected]",
        "responsavel": "Larissa Santana",
        "phone": "71993568610",
        "branch": "",
        "number": "",
        "createdAt": "2022-11-09T14:17:23.933Z",
        "updatedAt": "2025-09-26T13:15:58.305Z",
        "deletedAt": null,
        "ccbId": "e5ae05b0-11fb-4625-9a4b-9cb299abe0fc",
        "ccbAccountBranch": "0001",
        "ccbAccountNumber": "147852369",
        "ccbDocumentNumber": "12345678912345",
        "ccbFundingId": "e5ae05b0-11fb-4625-9a4b-9cb299abe0fc",
        "logoUrl": "https://sandbox.s3.amazonaws.com/logos%2FHiperBanco-logo.svg",
        "brandColor": "#dca500",
        "versionApp": "1.10.1",
        "shouldSendCardToCompanyAddress": false
    },
    "quantityWithdraw": 0
}

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.