👥Para Pessoa Física [PF]
Configuração de Estabelecimento Individual
Para estabelecer uma configuração direcionada a pessoas físicas dentro do sistema, é essencial proceder com uma solicitação via método POST. Essa solicitação pode ser executada tanto através do envio de dados em formato JSON quanto por meio do uso de multipart/form-data, adaptando-se assim às especificidades e à forma dos dados a serem transmitidos, incluindo a necessidade de anexar arquivos binários, se for o caso.
URL para Envio da Solicitação:
Cabeçalhos de Solicitação Obrigatórios:
Content-Type: Deve ser definido como multipart/form-data ou application/json, conforme a natureza dos dados enviados.
Authorization: Requer a inclusão de um 'Token API', precedido pela indicação Bearer, para autenticação e autorização do acesso.
Detalhes dos Parâmetros de Solicitação:
Parâmetro
Tipo
Descrição
tipoEstabelecimentoID
Inteiro
1 = para Pessoa Física, 2 = para Pessoa Jurídica
identificadorPlano
String
Código que identifica o plano escolhido pelo estabelecimento
nome
String
Nome completo do proprietário ou nome fantasia
sendMail
Boolean
Define se e-mails automáticos serão enviados (true ou false)
nomeComprovante
String
Nome que aparecerá nos comprovantes emitidos
String
E-mail de contato do estabelecimento
telefone
String
Telefone fixo do estabelecimento
celular
String
Número de celular do proprietário
dataNascimento
Data
Data de nascimento do proprietário (formato ISO)
dataNascimento2
Data
Data de nascimento do proprietário (formato europeu)
cpf
String
CPF do proprietário
categoria
Inteiro
Identificador da categoria à qual o estabelecimento pertence
quantidade_pos
Inteiro
Número de terminais POS associados ao estabelecimento
faturamento_estimado
Decimal
Valor do faturamento mensal estimado do estabelecimento
observacao
String
Observações adicionais sobre o estabelecimento
logradouro
String
Endereço do estabelecimento
numero
String
Número do endereço
cidade
String
Cidade do estabelecimento
estado
String
Estado do estabelecimento (código ISO 3166-2 de duas letras)
cep
String
Código de Endereçamento Postal
bairro
String
Bairro onde o estabelecimento está localizado
complemento
String
Complemento do endereço
nome (proprietario)
String
Nome do proprietário
sobrenome
String
Sobrenome do proprietário
email (proprietario)
String
E-mail do proprietário
celular (proprietario)
String
Celular do proprietário
cpf (proprietario)
String
CPF do proprietário
tipoContaBancaria
Inteiro
Tipo da conta bancária (1 para Corrente, 2 para Poupança)
nomeTitular
String
Nome do titular da conta bancária
bancoId
Inteiro
Identificador do banco
agencia
String
Número da agência
conta
String
Número da conta bancária
razaoSocial
String
Razão social do estabelecimento, se aplicável
desativarVendas
Boolean
Indica se as vendas estão habilitadas ou desabilitadas
Exemplo de Requisição em JSON:
{
"tipoEstabelecimentoId": "1",
"identificadorPlano": "",
"nome": "Laís Betina Aragão",
"sendMail": "false",
"nomeComprovante": "Lais Betina",
"email": "laisbetinaaragao77@gmail.com.br",
"telefone": ""
"celular": "51986060368",
"dataNascimento": "1983-06-07",
"dataNascimento2": "1983-06-07",
"cpf": "88029964153",
"categoria": "27",
"quantidade_pos": "0",
"faturamento_estimado": "10000",
"observacao": "",
"endereco": {
"logradouro": "Rua Iracema",
"numero": "274",
"cidade": "Cachoeirinha",
"estado": "RS",
"cep": "94940130",
"bairro": "Vila Monte Carlo",
"complemento": "",
},
"enderecoPOS": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": "",
},
"proprietario": {
"nome": "",
"sobrenome": "",
"email": "",
"celular": "",
"dataNascimento": "",
"cpf": "",
"endereco": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": ""
}
},
"contaBancaria": {
"tipoContaBancaria": "1",
"nomeTitular": "Lais Betina",
"bancoId": "7",
"agencia": "0190",
"conta": "098730-1",
},
"desativarVendas": "0",
"logo": (binary),
"documentos[]": (binary),
"documentosAtividade[]": (binary),
"documentosResidencia[]": (binary),
}Exemplo de resultado:
{
"success": true,
"estabelecimento": {
"id": 16853,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"categoria_estabelecimento_id": 1,
"endereco_id": 79885,
"razao_social": "",
"nome_fantasia": "Laís Betina Aragão",
"ativo": 0,
"data_nascimento": "1983-06-07T09:00:00.000Z",
"created": "2020-12-17T19:26:44.000Z",
"modified": "2020-12-17T19:26:44.000Z",
"removed": null,
"tipo_estabelecimento": {
"id": 1,
"titulo": "Pessoa Física",
"created": "2019-01-11T20:38:52.000Z",
"modified": "2019-01-11T20:38:52.000Z",
"removed": null
},
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação",
"created": "2019-07-22T20:24:19.000Z",
"modified": "2019-07-22T20:24:19.000Z",
"removed": null
},
"categoria_estabelecimento": {
"id": 1,
"titulo": "Padrão",
"created": "2019-07-25T18:18:17.000Z",
"modified": "2019-07-25T18:18:17.000Z",
"removed": null
},
"endereco": {
"id": 79885,
"logradouro": "Rua Iracema",
"numero": "274",
"complemento": "",
"cep": "94940130",
"bairro": "Vila Monte Carlo",
"cidade": "Cachoeirinha",
"uf": "RS",
"lat": null,
"long": null,
"created": "2020-12-17T19:26:44.000Z",
"modified": "2020-12-17T19:26:44.000Z",
"removed": null
}
}
}Este procedimento permite configurar com precisão e detalhamento o perfil e as informações financeiras de um estabelecimento dentro do marketplace, garantindo uma integração eficaz e a correta administração das transações comerciais e operações bancárias associadas.
Last updated