API Reference
Log In

Cria um estabelecimento V2

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

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

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
Language
Click Try It! to start a request and see the response here!