Informações do plano atual para o usuário

Esse endpoint retornará a informação de qual plano o usuário pertence

Requisição(Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/plans-mobile/myplan

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

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

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 da conta.
`status`	`string`	Status da conta
`branch`	`string`	Agência da conta.
`number`	`string`	Número da conta.
`user_transaction_night_limit`	`number`	Limite de transação noturna por operação.
`user_transaction_limit`	`number`	Limite de transação por operação.
`user_transaction_overall_limit`	`number`	Limite total de transações diárias.
`user_transaction_night_overall_limit`	`number`	Limite total de transações noturnas.
`acceptedTermsId`	`string`	Identificador dos termos aceitos (se houver).
`termsAcceptedAt`	`string`	Data/hora em que os termos foram aceitos.
`createdAt`	`string`	Data/hora de criação da conta.
`updatedAt`	`string`	Data/hora da última atualização.
`deletedAt`	`string`	Data/hora de exclusão da conta (se houver).
`type`	`string`	Tipo da conta
`escrowAccountEnabledAt`	`string`	Data/hora em que a conta escrow foi habilitada.
`plan`	`object`	Dados do plano associado à conta.
`plan.id`	`string`	Identificador único do plano.
`plan.name`	`string`	Nome do plano.
`plan.type_account`	`string`	Tipo de conta vinculada ao plano (`PF`, `PJ`).
`plan.benefits`	`string`	Benefícios do plano.
`plan.description`	`string`	Descrição do plano.
`plan.visibility`	`boolean`	Indica se o plano é visível.
`plan.availability`	`boolean`	Indica se o plano está disponível.
`plan.price`	`number`	Preço base do plano.
`plan.pricePix`	`number`	Preço por transação Pix.
`plan.priceGenerateDynamicQrCodePix`	`number`	Preço por geração de QR Code dinâmico Pix.
`plan.priceGenerateStaticQrCodePix`	`number`	Preço por geração de QR Code estático Pix.
`plan.priceReceiveDynamicQrCodePix`	`number`	Preço por recebimento via QR Code dinâmico Pix.
`plan.priceReceiveStaticQrCodePix`	`number`	Preço por recebimento via QR Code estático Pix.
`plan.priceTed`	`number`	Preço por operação TED.
`plan.priceBillet`	`number`	Preço por boleto emitido.
`plan.billSettlementPrice`	`number`	Preço por liquidação de boleto.
`plan.priceWithdraw`	`number`	Preço por saque.
`plan.priceP2P`	`number`	Preço por operação P2P.
`plan.quantityPix`	`number`	Quantidade de transações Pix inclusas.
`plan.quantityBillSettlement`	`number`	Quantidade de liquidações de boletos inclusas.
`plan.quantityGenerateDynamicQrCodePix`	`number`	Quantidade de gerações de QR Code dinâmico Pix inclusas.
`plan.quantityGenerateStaticQrCodePix`	`number`	Quantidade de gerações de QR Code estático Pix inclusas.
`plan.quantityReceiveDynamicQrCodePix`	`number`	Quantidade de recebimentos via QR Code dinâmico Pix inclusos.
`plan.quantityReceiveStaticQrCodePix`	`number`	Quantidade de recebimentos via QR Code estático Pix inclusos.
`plan.quantityTed`	`number`	Quantidade de operações TED inclusas.
`plan.quantityBillet`	`number`	Quantidade de boletos inclusos.
`plan.quantityPeriodo`	`number`	Período de apuração do plano (em dias/meses).
`plan.quantityP2P`	`number`	Quantidade de operações P2P inclusas.
`plan.timeDefault`	`number`	Tempo padrão de vigência (em dias).
`plan.planDefault`	`boolean`	Indica se é o plano padrão.
`plan.contract`	`string`	URL do contrato do plano.
`plan.daysUntilFirstPayment`	`number`	Dias até o primeiro pagamento.
`plan.createdAt`	`string`	Data/hora de criação do plano.
`plan.updatedAt`	`string`	Data/hora da última atualização do plano.
`plan.deletedAt`	`string`	Data/hora de exclusão do plano (se houver).

{
    "id": "bf1aa555-df16-48bd-a7c0-263cfaa71fb4",
    "status": "ACTIVE",
    "branch": "0001",
    "number": "1101263307",
    "user_transaction_night_limit": 100000,
    "user_transaction_limit": 100000,
    "user_transaction_overall_limit": 100000,
    "user_transaction_night_overall_limit": 100000,
    "acceptedTermsId": null,
    "termsAcceptedAt": null,
    "createdAt": "2023-11-17T16:19:42.843Z",
    "updatedAt": "2024-09-23T14:06:07.000Z",
    "deletedAt": null,
    "type": "MAIN",
    "escrowAccountEnabledAt": null,
    "plan": {
        "id": "6b41e0a7-58d0-4884-9dfb-6886208cbd4b",
        "name": "HIPERBANCO FRANQUIAS LTDA (HIPER BANCO)",
        "type_account": "PJ",
        "benefits": "HIPERBANCO FRANQUIAS LTDA (HIPER BANCO)",
        "description": "HIPERBANCO FRANQUIAS LTDA (HIPER BANCO)",
        "visibility": true,
        "availability": true,
        "price": 0.03,
        "pricePix": 0.03,
        "priceGenerateDynamicQrCodePix": 0.03,
        "priceGenerateStaticQrCodePix": 0.03,
        "priceReceiveDynamicQrCodePix": 0.03,
        "priceReceiveStaticQrCodePix": 0.03,
        "priceTed": 0.03,
        "priceBillet": 0.03,
        "billSettlementPrice": 0.03,
        "priceWithdraw": 0.03,
        "priceP2P": 0.03,
        "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://sandbox/plans%2Fcontracts%2F1755010025540-HIPERBANCO%20FRANQUIAS%20LTDA%20(HIPER%20BANCO).pdf",
        "daysUntilFirstPayment": 1,
        "createdAt": "2024-07-17T10:42:24.804Z",
        "updatedAt": "2025-08-18T17:27:09.000Z",
        "deletedAt": null
    }
}

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.