🔼
POST urlServidor/v1/marketplace/establishments

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Headers

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token de autenticação. Pode ser encontrado em nosso portal na guia de integração.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request POST \
--location '{{server}/v1/marketplace/establishments' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearer_token}}' \

📦 Detalhamento campos Body

Campo	Tipo	Obrigatório	Descrição
`type`	string	✅	Tipo do estabelecimento. Valores possíveis: `INDIVIDUAL` (Pessoa Física), `BUSINESS` (Pessoa Jurídica).
`activity_id`	number	Condicional	Tipo de atividade do estabelecimento. Obrigatório para o type `INDIVIDUAL`
`representative_id`	number	❌	ID do representante vinculado.
`notes`	string	❌	Campo de anotações livres.
`visited`	boolean	❌	Indica se o estabelecimento foi visitado.
`responsible`	object	✅	Dados do responsável pelo estabelecimento.
├─ `email`	string	✅	E-mail válido e ativo do responsável.
├─ `document`	string	✅	CPF do responsável.
├─ `first_name`	string	✅	Nome completo do responsável.
├─ `phone`	string	✅	Número de telefone do responsável.
├─ `birthdate`	string	✅	Data de nascimento (YYYY-MM-DD).
`address`	object	✅	Endereço do estabelecimento.
├─ `zip_code`	string	✅	CEP válido (sem caracteres especiais).
├─ `street`	string	✅	Logradouro.
├─ `neighborhood`	string	✅	Bairro.
├─ `city`	string	✅	Cidade.
├─ `state`	string	✅	Estado (UF). Enum: `AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MS, MT, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO`.
├─ `complement`	string	❌	Complemento.
├─ `number`	string	✅	Número do endereço.
`revenue`	number	✅	Faturamento estimado.
`first_name`	string	⚠️	Razão Social (quando PJ). Obrigatório para o type `BUSINESS`
`last_name`	string	⚠️	Nome Fantasia. Obrigatório para o type `BUSINESS`
`cnae`	string	✅	Código CNAE da atividade.
`document`	string	✅	CNPJ do estabelecimento.
`phone_number`	string	✅	Telefone principal do estabelecimento.
`format`	string	✅	Formato da empresa. Enum: `SS, SC, SPE, LTDA, SA, ME, MEI, EI, EIRELI, SLU, ESI`.
`email`	string	✅	E-mail principal do estabelecimento.
`birthdate`	string	✅	Data de abertura (YYYY-MM-DD). *Obrigatório para o Type `BUSINESS`
`gmv`	number	❌	Meta de faturamento anual.

🧩 Exemplo do Body para criar a transação

O corpo da requisição deve ser enviado no formato JSON, conforme descrito abaixo:

{
  "type": "BUSINESS",
  "activity_id": 30,
  "notes": "Observação sobre o EC",
  "visited": false,
  "responsible": {
    "email": "[email protected]",
    "document": "400.752.010-03",
    "first_name": "João Desenvolvedor",
    "phone": "00000000001",
    "birthdate": "2000-10-12"
  },
  "address": {
    "zip_code": "29090390",
    "street": "Rua Dos desenvolvedores",
    "neighborhood": "Bairro da Programação",
    "city": "Vitória",
    "state": "ES",
    "number": "01"
  },
  "first_name": "DV",
  "last_name": "Solucoes",
  "cnae": "0111302",
  "document": "11.299.221/0001-29",
  "phone_number": "27998765431",
  "email": "[email protected]",
  "birthdate": "2022-01-01",
  "revenue": 10000,
  "format": "LTDA",
  "gmv": 13000
}

⚠️ Notas Importantes

No ambiente Sandbox, o status retornado depende do último dígito do campo phone_number. Consulte os Casos de Teste em Sandbox.
A atualização de status é comunicada via webhook updated-establishment-status. Consulte os hooks disponíveis.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.