Criação de planos

Esse endpoint possibilita a criação de planos

Requisição(Request)

Requisição HTTP

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

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

Corpo da requisição (Body)

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

Campo

Tipo

Descrição

name

string

Obrigatório. Nome do plano

description

string

Obrigatório. Descrição do plano

benefits

string

Obrigatório. Benefícios do plano

contract

string

Obrigatório. Arquivo do contrato em PDF. Observação: tamanho máximo permitido para o arquivo é de 50 MB

availability

boolean

Obrigatório. Disponibilidade do plano

visibility

boolean

Obrigatório. Visibilidade do plano

price

number

Obrigatório. Preço da mensalidade do plano

pricePix

number

Obrigatório. Preço para operações via Pix

priceTed

number

Obrigatório. Preço para operações via TED

priceBillet

number

Obrigatório. Preço para operações via boleto

priceWithdraw

number

Obrigatório. Preço para saque

priceP2P

number

Obrigatório. Preço para transferência P2P

priceGenerateDynamicQrCodePix

number

Obrigatório. Preço para gerar QR Code dinâmico Pix

priceGenerateStaticQrCodePix

number

Obrigatório. Preço para gerar QR Code estático Pix

priceReceiveDynamicQrCodePix

number

Obrigatório. Preço para receber via QR Code dinâmico Pix

priceReceiveStaticQrCodePix

number

Obrigatório. Preço para receber via QR Code estático Pix

quantityGenerateDynamicQrCodePix

number

Obrigatório. Quantidade de geração de QR Code dinâmico Pix gratuita

quantityGenerateStaticQrCodePix

number

Obrigatório. Quantidade de geração de QR Code estático Pix gratuita

quantityReceiveDynamicQrCodePix

number

Obrigatório. Quantidade de recebimento via QR Code dinâmico Pix gratuita

quantityReceiveStaticQrCodePix

number

Obrigatório. Quantidade de recebimento via QR Code estático Pix gratuita

quantityPix

number

Obrigatório. Quantidade de operações Pix gratuita

quantityTed

number

Obrigatório. Quantidade de operações TED gratuita

quantityBillet

number

Obrigatório. Quantidade de operações de boleto gratuita

quantityPeriodo

number

Obrigatório. Quantidade de períodos permitidos gratuita

quantityP2P

number

Obrigatório. Quantidade de operações P2P gratuita

timeDefault

number

Obrigatório. Preencher sempre com 0

planDefault

boolean

Obrigatório. Define se é o plano padrão

type_account

string

Obrigatório. Tipo de conta. Pode ser PJ ou PF

daysUntilFirstPayment

number

Obrigatório. Dias até o primeiro pagamento

billSettlementPrice

number

Obrigatório. Preço da liquidação de boleto

quantityBillSettlement

number

Obrigatório. Quantidade de liquidação de boleto gratuita

{
  "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.

❗️

Atenção

Se o saldo disponível na conta for insuficiente para cobrir o valor da transação somado à tarifa, a operação será rejeitada e a API retornará o erro INSUFFICIENT_BALANCE.

Resposta (Response)

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

Erros

Status codeCódigoMensagemDescrição
400PLAN_CONTRACT_REQUIREDPlan contract is required.É necessário um contrato de plano.
422DEFAULT_PLAN_CANNOT_BE_DISABLEDIt's not possible to disable a default plan.Não é possível desabilitar um plano padrão.
422CONFLICTING_DEFAULT_PLANSIt'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.