Atualizar estabelecimento

🔼
PUT urlServidor/v1/marketplace/establishments/:id

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

Parâmetros da Requisição

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

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador do estabelecimento a ser atualizado.

Exemplo de header da requisição

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

Estrutura do Payload – Atualizar Estabelecimento

Nome	Tipo	Obrigatório	Descrição
`access_type`	string	Sim	Tipo de acesso do estabelecimento. Valores possíveis: ACQUIRER, BANKING
`first_name`	string	Não	Nome do estabelecimento ou nome do responsável (pessoa física).
`last_name`	string	Não	Nome fantasia do estabelecimento ou sobrenome.
`phone_number`	string	Sim	Telefone de contato do estabelecimento.
`revenue`	string	Sim	Receita mensal estimada do estabelecimento.
`format`	string	Sim	Tipo societário. Valores aceitos: SS, SC, SPE, LTDA, SA, ME, MEI, EI, EIRELI, SLU, ESI.
`email`	string	Sim	E-mail do estabelecimento.
`gmv`	number	Não	Volume bruto de vendas mensal estimado (GMV).
`birthdate`	string	Sim	Data de fundação (para PJ). Formato: AAAA-MM-DD. Data de nascimento não é possível.

Exemplo do body

{
  "access_type": "ACQUIRER",
  "first_name": "Desenvolvedor",
  "last_name": "Solucoes",
  "phone_number": "27992830000",
  "revenue": 9999,
  "format": "SC",
  "email": "[email protected]",
  "gmv": 0,
  "birthdate":  "2022-01-01"
}

Exemplo de resposta de sucesso.

{
    "id": 155100,
    "type": "BUSINESS",
    "first_name": "Desenvolvedor",
    "last_name": "Solucoes",
    "document": "11299221000129",
    "birthdate": "2022-01-01",
    "phone_number": "27992830000"",
    "active": true,
    "revenue": "9999",
    "format": "SC",
    "email": "[email protected]",
  	"risk": "PENDING",
    "status": "RISK_ANALYSIS",
    "address": {
        "zip_code": "29000000",
        "street": "Rua Dos desenvolvedores",
        "number": "01",
        "neighborhood": "Bairro da Programação",
        "city": "Vitória",
        "state": "ES",
        "complement": null
    },
    "category": "Cooperativas Agrícolas",
    "created_at": "2025-03-19T18:27:45.000Z",
    "updated_at": "2025-04-14T18:17:56.000Z",
    "deleted_at": null,
    "responsible": {
        "id": 187,
        "first_name": "EC - API Integrações",
        "email": "[email protected]",
        "document": "76131364001",
        "phone": "27999998888",
        "birthdate": "1987-01-06"
    }
}

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.