Atualizar um plano

Esse endpoint possibilita a atualização de um plano

Requisição(Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/plans/{id}
--request PATCH 'https://sandbox.hiperbanco.com.br/plans/{id}' \
--header 'version: cutting-edge' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------519079170945030968549232' \
--form 'name="Criação de Planos"' \
--form 'description="Descrição do plano"' \
--form 'benefits="Beneficios do plano"' \
--form 'contract=@caminho/arquivo.pdf' \
--form 'availability="true"' \
--form 'visibility="true"' \
--form 'price="0"' \
--form 'pricePix="0"' \
--form 'priceTed="0"' \
--form 'priceBillet="0"' \
--form 'priceWithdraw="0"' \
--form 'priceP2P="0"' \
--form 'priceGenerateDynamicQrCodePix="0"' \
--form 'priceGenerateStaticQrCodePix="0"' \
--form 'priceReceiveDynamicQrCodePix="0"' \
--form 'priceReceiveStaticQrCodePix="0"' \
--form 'quantityGenerateDynamicQrCodePix="0"' \
--form 'quantityGenerateStaticQrCodePix="0"' \
--form 'quantityReceiveDynamicQrCodePix="0"' \
--form 'quantityReceiveStaticQrCodePix="0"' \
--form 'quantityPix="0"' \
--form 'quantityTed="0"' \
--form 'quantityBillet="0"' \
--form 'quantityPeriodo="0"' \
--form 'quantityP2P="0"' \
--form 'timeDefault="0"' \
--form 'planDefault="true"' \
--form 'type_account="PJ"' \
--form 'daysUntilFirstPayment="1"' \
--form 'billSettlementPrice="0.48"' \
--form 'quantityBillSettlement="1"'

Cabeçalhos (Headers)

NomePropriedadeDescrição
versioncutting-edgeEssa propriedade garante que o response da API seja retornado no formato JSON
AuthorizationBearer tokenObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

NomeTipoDescrição
idpathIdentificador do plano

Corpo da requisição (Body)

No body, envie os seguintes campos em formato multipart/form-data:

Campo

Tipo

Descrição

name

string

Nome do plano

description

string

Descrição do plano

benefits

string

Benefícios do plano

contract

string

Arquivo do contrato em PDF. Observação: tamanho máximo permitido 50 MB

availability

boolean

Disponibilidade do plano

visibility

boolean

Visibilidade do plano

price

number

Preço padrão do plano

pricePix

number

Preço para operações via Pix

priceTed

number

Preço para operações via TED

priceBillet

number

Preço para operações via boleto

priceWithdraw

number

Preço para saque

priceP2P

number

Preço para transferência P2P

priceGenerateDynamicQrCodePix

number

Preço para gerar QR Code dinâmico Pix

priceGenerateStaticQrCodePix

number

Preço para gerar QR Code estático Pix

priceReceiveDynamicQrCodePix

number

Preço para receber via QR Code dinâmico Pix

priceReceiveStaticQrCodePix

number

Preço para receber via QR Code estático Pix

quantityGenerateDynamicQrCodePix

number

Quantidade de geração de QR Code dinâmico Pix

quantityGenerateStaticQrCodePix

number

Quantidade de geração de QR Code estático Pix

quantityReceiveDynamicQrCodePix

number

Quantidade de recebimento via QR Code dinâmico Pix

quantityReceiveStaticQrCodePix

number

Quantidade de recebimento via QR Code estático Pix

quantityPix

number

Quantidade de operações Pix

quantityTed

number

Quantidade de operações TED

quantityBillet

number

Quantidade de operações de boleto

quantityPeriodo

number

Quantidade de períodos permitidos

quantityP2P

number

Quantidade de operações P2P

timeDefault

number

Tempo padrão configurado

planDefault

boolean

Define se é o plano padrão

type_account

string

Tipo de conta. Pode ser PJ ou PF

daysUntilFirstPayment

number

Dias até o primeiro pagamento

billSettlementPrice

number

Preço da liquidação de boleto

quantityBillSettlement

number

Quantidade de liquidação de boleto

{
  "name": "Criação de Planos",
  "description": "Descrição do plano",
  "benefits": "Benefícios do plano",
  "contract": "CriacaoDePlano.pdf",
  "availability": true,
  "visibility": true,
  "price": 0,
  "pricePix": 0,
  "priceTed": 0,
  "priceBillet": 0,
  "priceWithdraw": 0,
  "priceP2P": 0,
  "priceGenerateDynamicQrCodePix": 0,
  "priceGenerateStaticQrCodePix": 0,
  "priceReceiveDynamicQrCodePix": 0,
  "priceReceiveStaticQrCodePix": 0,
  "quantityGenerateDynamicQrCodePix": 0,
  "quantityGenerateStaticQrCodePix": 0,
  "quantityReceiveDynamicQrCodePix": 0,
  "quantityReceiveStaticQrCodePix": 0,
  "quantityPix": 0,
  "quantityTed": 0,
  "quantityBillet": 0,
  "quantityPeriodo": 0,
  "quantityP2P": 0,
  "timeDefault": 0,
  "planDefault": true,
  "type_account": "PJ",
  "daysUntilFirstPayment": 1,
  "billSettlementPrice": 0.48,
  "quantityBillSettlement": 1
}
⚠️

Importante

Este exemplo está apenas representando a estrutura.

O envio real é via multipart/form-data, não em JSON.

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso.

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

CampoTipoDescrição
dataobjectEstrutura que contém os dados
data.planobjectInformações do plano
data.plan.idstringIdentificador do plano
data.plan.namestringNome do plano
data.plan.type_accountstringTipo de conta (PF ou PJ)
data.plan.benefitsstringBenefícios do plano
data.plan.descriptionstringDescrição do plano
data.plan.visibilitybooleanIndica se o plano é visível
data.plan.availabilitybooleanIndica se o plano está disponível
data.plan.pricenumberPreço padrão do plano
data.plan.pricePixnumberPreço por operação Pix
data.plan.priceGenerateDynamicQrCodePixnumberPreço para gerar QR Code Pix dinâmico
data.plan.priceGenerateStaticQrCodePixnumberPreço para gerar QR Code Pix estático
data.plan.priceReceiveDynamicQrCodePixnumberPreço para receber QR Code Pix dinâmico
data.plan.priceReceiveStaticQrCodePixnumberPreço para receber QR Code Pix estático
data.plan.priceTednumberPreço por TED
data.plan.priceBilletnumberPreço por boleto
data.plan.billSettlementPricenumberPreço para liquidação de boleto
data.plan.priceWithdrawnumberPreço por saque
data.plan.priceP2PnumberPreço por transferência P2P
data.plan.quantityPixnumberQuantidade de operações Pix incluídas
data.plan.quantityBillSettlementnumberQuantidade de liquidações de boletos incluídas
data.plan.quantityGenerateDynamicQrCodePixnumberQuantidade de QR Codes Pix dinâmicos incluídos
data.plan.quantityGenerateStaticQrCodePixnumberQuantidade de QR Codes Pix estáticos incluídos
data.plan.quantityReceiveDynamicQrCodePixnumberQuantidade de recebimentos via QR Code dinâmico
data.plan.quantityReceiveStaticQrCodePixnumberQuantidade de recebimentos via QR Code estático
data.plan.quantityTednumberQuantidade de TEDs incluídas
data.plan.quantityBilletnumberQuantidade de boletos incluídos
data.plan.quantityPeriodonumberPeríodo de referência para quantidades
data.plan.quantityP2PstringQuantidade de transferências P2P incluídas
data.plan.timeDefaultnumberTempo padrão do plano
data.plan.planDefaultbooleanIndica se é o plano padrão
data.plan.contractstringURL do contrato do plano
data.plan.daysUntilFirstPaymentnumberDias até o primeiro pagamento
data.plan.createdAtstringData de criação do plano
data.plan.updatedAtstringData da última atualização do plano
data.plan.deletedAtstringData de exclusão do plano (ou null)
{
  "data": {
    "plan": {
      "id": "6b41e0a7-58d0-4884-9dfb-6886208cbd4b",
      "name": "BANCO NOVA ERA LTDA",
      "type_account": "PJ",
      "benefits": "BANCO NOVA ERA LTDA",
      "description": "Plano Empresarial Padrão - Banco Nova Era",
      "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": true,
      "contract": "https://storage.cloud.google.com/banconovaera-staging/plans%2Fcontracts%2F1727111063222-BANCO%20NOVA%20ERA%20LTDA.pdf",
      "daysUntilFirstPayment": 1,
      "createdAt": "2024-07-17T10:42:24.804Z",
      "updatedAt": "2025-09-27T21:44:59.000Z",
      "deletedAt": null
    }
  }
}

Erros

Status code

Código

Mensagem

Descrição

400

PLAN_CONTRACT_REQUIRED

Plan contract is required.

É necessário um contrato de plano.

422

DEFAULT_PLAN_CANNOT_BE_DISABLED

It's not possible to disable a default plan.

Não é possível desabilitar um plano padrão.

422

DEFAULT_PLAN_ACCOUNT_TYPE_IMMUTABLE

You cannot change the account type of a standard plan.

Você não pode alterar o tipo de conta de um plano padrão.

422

DEFAULT_PLAN_REVERSAL_NOT_ALLOWED

It's not possible to revert a default plan.

Não é possível reverter um plano padrão.

422

PLAN_DEACTIVATION_WITH_ACTIVE_USERS

It's not possible to disable a plan which has active users.

Não é possível desabilitar um plano que tenha usuários ativos.

422

CONFLICTING_DEFAULT_PLANS

It's not possible to set the same default plan for business and customer accounts.

Não é possível definir o mesmo plano padrão para contas PF e PJ.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.