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)
| 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)
No body, envie os seguintes campos em formato multipart/form-data:
Campo | Tipo | Descrição |
|---|---|---|
|
| Nome do plano |
|
| Descrição do plano |
|
| Benefícios do plano |
|
| Arquivo do contrato em PDF. Observação: tamanho máximo permitido 50 MB |
|
| Disponibilidade do plano |
|
| Visibilidade do plano |
|
| Preço padrão do plano |
|
| Preço para operações via Pix |
|
| Preço para operações via TED |
|
| Preço para operações via boleto |
|
| Preço para saque |
|
| Preço para transferência P2P |
|
| Preço para gerar QR Code dinâmico Pix |
|
| Preço para gerar QR Code estático Pix |
|
| Preço para receber via QR Code dinâmico Pix |
|
| Preço para receber via QR Code estático Pix |
|
| Quantidade de geração de QR Code dinâmico Pix |
|
| Quantidade de geração de QR Code estático Pix |
|
| Quantidade de recebimento via QR Code dinâmico Pix |
|
| Quantidade de recebimento via QR Code estático Pix |
|
| Quantidade de operações Pix |
|
| Quantidade de operações TED |
|
| Quantidade de operações de boleto |
|
| Quantidade de períodos permitidos |
|
| Quantidade de operações P2P |
|
| Tempo padrão configurado |
|
| Define se é o plano padrão |
|
| Tipo de conta. Pode ser |
|
| Dias até o primeiro pagamento |
|
| Preço da liquidação de boleto |
|
| 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
}
ImportanteEste 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:
| Campo | Tipo | Descrição |
|---|---|---|
data | object | Estrutura que contém os dados |
data.plan | object | Informações do plano |
data.plan.id | string | Identificador do plano |
data.plan.name | string | Nome do plano |
data.plan.type_account | string | Tipo de conta (PF ou PJ) |
data.plan.benefits | string | Benefícios do plano |
data.plan.description | string | Descrição do plano |
data.plan.visibility | boolean | Indica se o plano é visível |
data.plan.availability | boolean | Indica se o plano está disponível |
data.plan.price | number | Preço padrão do plano |
data.plan.pricePix | number | Preço por operação Pix |
data.plan.priceGenerateDynamicQrCodePix | number | Preço para gerar QR Code Pix dinâmico |
data.plan.priceGenerateStaticQrCodePix | number | Preço para gerar QR Code Pix estático |
data.plan.priceReceiveDynamicQrCodePix | number | Preço para receber QR Code Pix dinâmico |
data.plan.priceReceiveStaticQrCodePix | number | Preço para receber QR Code Pix estático |
data.plan.priceTed | number | Preço por TED |
data.plan.priceBillet | number | Preço por boleto |
data.plan.billSettlementPrice | number | Preço para liquidação de boleto |
data.plan.priceWithdraw | number | Preço por saque |
data.plan.priceP2P | number | Preço por transferência P2P |
data.plan.quantityPix | number | Quantidade de operações Pix incluídas |
data.plan.quantityBillSettlement | number | Quantidade de liquidações de boletos incluídas |
data.plan.quantityGenerateDynamicQrCodePix | number | Quantidade de QR Codes Pix dinâmicos incluídos |
data.plan.quantityGenerateStaticQrCodePix | number | Quantidade de QR Codes Pix estáticos incluídos |
data.plan.quantityReceiveDynamicQrCodePix | number | Quantidade de recebimentos via QR Code dinâmico |
data.plan.quantityReceiveStaticQrCodePix | number | Quantidade de recebimentos via QR Code estático |
data.plan.quantityTed | number | Quantidade de TEDs incluídas |
data.plan.quantityBillet | number | Quantidade de boletos incluídos |
data.plan.quantityPeriodo | number | Período de referência para quantidades |
data.plan.quantityP2P | string | Quantidade de transferências P2P incluídas |
data.plan.timeDefault | number | Tempo padrão do plano |
data.plan.planDefault | boolean | Indica se é o plano padrão |
data.plan.contract | string | URL do contrato do plano |
data.plan.daysUntilFirstPayment | number | Dias até o primeiro pagamento |
data.plan.createdAt | string | Data de criação do plano |
data.plan.updatedAt | string | Data da última atualização do plano |
data.plan.deletedAt | string | Data 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 |
|---|---|---|---|
|
| Plan contract is required. | É necessário um contrato de plano. |
|
| It's not possible to disable a default plan. | Não é possível desabilitar um plano padrão. |
|
| You cannot change the account type of a standard plan. | Você não pode alterar o tipo de conta de um plano padrão. |
|
| It's not possible to revert a default plan. | Não é possível reverter um plano padrão. |
|
| It's not possible to disable a plan which has active users. | Não é possível desabilitar um plano que tenha usuários ativos. |
|
| 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.
Updated about 1 month ago