🔑Headers

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração fornecida pela Paytime.
`x-token`	string	Sim	Token utilizado para autenticação. Disponível no portal, na guia de integração com a API pública.
`Authorization`	string	Sim	Inserir o Bearer Token, gerado na rota Auth

🔗 Path Parameters

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador único do estabelecimento.

📥 Exemplo de Requisição

curl--request GET \
--location 'urlServidor/v1/marketplace/establishments/:id' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

📤 Response 200 — Sucesso

{
    "id": 0001,
    "type": "BUSINESS",
    "first_name": "Estabelecimento ",
    "last_name": "em SANDBOX",
    "document": "52000701000124",
    "birthdate": "2024-01-01",
    "phone_number": "27990000002",
    "active": true,
    "revenue": "500000",
    "format": "LTDA",
    "email": "[email protected]",
    "risk": "PENDING",
    "status": "RISK_ANALYSIS",
    "representative": {
        "id": 63,
        "active": true,
        "first_name": "EC  Cobranças API",
        "last_name": null,
        "document": "10068114001"
    },
    "address": {
        "zip_code": "82810280",
        "street": "Rua Dos Webhook",
        "number": "1062",
        "neighborhood": "Deploy",
        "city": "Curitiba",
        "state": "PR",
        "complement": null
    },
    "category": "Programação de Computadores, Design de Sistemas Integrados e Serviços de Processamento de Dados",
    "code": "NDU53C1F",
    "created_at": "2025-09-25T19:26:33.000Z",
    "updated_at": "2025-09-25T19:26:34.000Z",
    "deleted_at": null,
    "responsible": {
        "id": 393,
        "first_name": "Nome do respons´avel.",

Detalhes das variáveis

Estabelecimento

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	Identificador único do estabelecimento.
`type`	string	Sim	Tipo do estabelecimento. Valores: `BUSINESS` (Pessoa Jurídica), `INDIVIDUAL` (Pessoa Física).
`first_name`	string	Sim	Nome ou Razão Social.
`last_name`	string	Sim	Sobrenome ou Nome Fantasia.
`document`	string	Sim	CPF ou CNPJ do estabelecimento.
`birthdate`	string (date-time)	Sim	Data de nascimento (PF) ou data de abertura (PJ).
`phone_number`	string	Sim	Número de telefone do estabelecimento.
`active`	boolean	Sim	Indica se o estabelecimento está ativo.
`revenue`	string	Não	Faturamento estimado.
`format`	string	Não	Formato jurídico da empresa. Valores: `SS`, `SC`, `SPE`, `LTDA`, `SA`, `ME`, `MEI`, `EI`, `EIRELI`, `SLU`, `ESI`.
`email`	string	Sim	E-mail principal do estabelecimento.
`risk`	string	Sim	Nível de risco do estabelecimento. Valores: `LOW`, `MEDIUM`, `HIGH`.
`status`	string	Sim	Status atual do estabelecimento. Valores: `PENDING`, `VALIDATION`, `RISK_ANALYSIS`, `APPROVED`, `DISAPPROVED`, `DISCREDITED`, `BACKGROUND_CHECK`.
`category`	string	Não	Código MCC (Merchant Category Code).
`code`	string	Sim	Código identificador alfanumérico único.

📋 Planos Vinculados (plans)

Campo	Tipo	Descrição
`id`	number	Identificador do plano.
`name`	string	Nome do plano.
`active`	boolean	Indica se o plano está ativo.
`gateway_id`	number	Identificador do gateway vinculado.
`plan_id`	number	Identificador do plano base.
`pix`	string	Regra de divisão de cobranças via Pix.
`pix_api`	string	Regra de divisão de cobranças via Pix pela API.
`description`	string	Descrição do plano.
`type`	string	Tipo do plano. Valores: `STANDARD`, `COMMERCIAL`.
`modality`	string	Modalidade do plano. Valores: `PHYSICAL`, `ONLINE`, `TAP_PHONE`.
`allow_anticipation`	boolean	Indica se o plano permite antecipação.
`created_at`	string (date-time)	Data de criação do plano.
`updated_at`	string (date-time)	Data da última atualização.

🔌 Gateways Vinculados (gateways)

Contém informações sobre os gateways ativos do estabelecimento.

Campo	Tipo	Descrição
`id`	number	ID do gateway.
`name`	string	Nome do gateway.
`reference_id`	string	Referência do gateway.
`status`	string	Status do gateway.
`active`	boolean	Indica se o gateway está ativo.
`form_receipt`	string	Forma de recebimento configurada.
`metadata`	object	Metadados adicionais.
`created_at`	string (date-time)	Data de criação.
`updated_at`	string (date-time)	Última atualização.

👤 Representante (representative)

Campo	Tipo	Descrição
`id`	number	ID do representante.
`first_name`	string	Nome ou razão social.
`last_name`	string	Sobrenome ou nome fantasia.
`document`	string	CPF ou CNPJ.
`active`	boolean	Indica se está ativo.

📍 Endereço (address)

Campo	Tipo	Descrição
`street`	string	Logradouro.
`number`	string	Número.
`complement`	string	Complemento.
`neighborhood`	string	Bairro.
`city`	string	Cidade.
`state`	string	UF.
`zip_code`	string	CEP.

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.