API Reference
Log In
API Reference

Cria um estabelecimento

Este endpoint tem como objetivo realizar a criação de um novo estabelecimento.

Log in to see full request history

Tipos de conta bancária​
Os tipos de conta bancária que podem ser retornados são:

📘

Está é a conta bancária onde os recebíveis serão enviados e as transações serão feitas.

Tipos de conta bancáriaDescrição
CHECKINGConta bancária do tipo Corrente
SAVINGConta bancária do tipo Poupança

🚧

Solicitação de POS

Para Onboarding de solicitação de POS, se faz necessário informar um id de plano POS conforme descrito na seção Tipos de Planos abaixo e no campo plans no body da requisição. Uma vez recebido o POS, ative-o através do endpoint de ativação, acesse clicando aqui

Tipos de planos

O tipo de plano que pode ser associado ao estabelecimento é:

Tipos de planosDescrição
WEBTransações feitas por link de pagamento
POSTransação realizadas na Maquininha Justa
BANK_BILLEmissão de boletos
PAYMENT_BILLPagamento de Contas
PIXTransações do tipo PIX

Respostas das requisições​

Você receberá na resposta da requisição todos os dados do cliente que foi cadastrado com o id do estabelecimento, que será o próprio CNPJ.

As variáveis que a resposta informa diferentes do body são:

VariávelTipoDescrição
idStringID gerado na criação do estabelecimento
cnaeStringCódigo de classificação da atividade do estabelecimento

Obs.: Um Webhook será enviado para um endpoint cadastrado quando houver a atualização do status do estabelecimento, para mais detalhes clique aqui.

Detalhes sobre o envio da requisição:

ObjetoDescrição
addressDados do endereço do estabelecimento
ownerDados pessoais do sócio do estabelecimento
accountBankDados bancários do estabelecimento
plansPlanos de recebimento do estabelecimento. Deverá ser incluso somente se o estabelecimento for utilizar um plano específico
Body Params
string
required
Defaults to Nome Teste

Nome fantasia do estabelecimento

string
required
Defaults to Matriz

Tipo do estabelecimento. Matriz ou Filial

string
required
Defaults to Nome Teste

Razão Social do estabelecimento

string
required
Defaults to 29263252000195

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

string
required
Defaults to 01342/00

Código de classificação da atividade do estabelecimento. Colocar do mesmo formato que está no cartão do CNPJ 01342/00

string
required
Defaults to CNPJ

Tipo do documento do estabelecimento

string
required
Defaults to 1972-02-26

Data da constituição do estabelecimento. Enviar uma String no formato yyyy-MM-dd

address
object
owner
object
accountBank
object
string
Defaults to aa73aa52-8a2b-412a-8a6a-aaaaaaaaaaaa

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

plans
array of objects

Planos de recebimento do estabelecimento. Deverá ser incluso somente se o estabelecimento for utilizar um plano específico

plans
Headers
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
Defaults to {random UIID}

Deve ser gerado um UIID a cada requisição

string
Defaults to application/json

Tipo do corpo da requisição a ser enviado

Responses

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