API Reference
Log In
API Reference

Insere um plano para um estabelecimento

Este endpoint tem como objetivo incluir ou atualizar planos para um estabelecimento.

Log in to see full request history

Tipos de planos

Os tipos de planos que podem ser associados ao estabelecimento são:

Tipos de planosDescrição
PAYMENT_BILLPlano de pagamento de contas.
BANK_BILLPlano de emissão de boleto.
WEBPlano de venda web.
PIXPlano de pix.

Obs.: O ID do plano será informado pelo técnico responsável pela integração.

Respostas das requisições

Você receberá na resposta da requisição os dados do cliente com o plano incluído e os limites estabelecidos (no caso se for plano web ou pagamento de contas).

Além dos dados básicos, as variáveis que a resposta informa são:

VariávelTipoDescrição
defaultPlanIdWebStringID do plano de venda web.
defaultPlanIdBankBillStringID do plano de pagamento de contas.
defaultPlanIdBillingStringID do plano de emissão de boleto.
defaultPlanIdPixStringID do plano de pix.
globalLimitWebBigIntegerLimite global padrão para vendas web.
dailyLimitWebBigIntegerLimite diário padrão para vendas web.
transactionLimitWebBigIntegerLimite por transação padrão para vendas web.
globalLimitPayBillBigIntegerLimite global padrão para transações de pagamento de conta.
dailyLimitPayBillBigIntegerLimite diário padrão para transações de pagamento de conta.
transactionLimitPayBillBigIntegerLimite por transação padrão para transações de pagamento de conta.
Path Params
string
required

Documento legal do estabelecimento. Enviar o valor sem caracteres especiais. Somente números devem ser enviados. Máximo de 14 caracteres

Body Params
string
required

Id do plano que será configurado

string
required

Tipo do plano que será configurado. Os planos podem ser WEB, PIX, BANK_BILL, PAYMENT_BILL e POS

Headers
string
Defaults to application/json

Tipo do corpo da requisição a ser enviado

string
required
Defaults to Bearer {access_token}

Autenticação do tipo Bearer a ser enviada. O atributo {access_token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento

string
required

ID do integrador. Esse ID será provido pelo técnico responsável por acompanhar a integração

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json