{"info":{"_postman_id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","name":"Vai de Ticket Integração","description":"

Autenticação via Bearer Token e access_token

Para utilizar esta API, duas formas de autenticação são exigidas em todas as requisições:

🔐 1. Bearer Token

O Bearer Token é obrigatório em todas as requisições e representa o usuário autenticado (por exemplo, uma conta de sistema ou painel administrativo). Ele deve ser enviado no header Authorization, conforme o padrão abaixo:

Authorization: Bearer SEU_TOKEN_JWT\n\n

Todas as empresas cadastradas estarão automaticamente vinculadas ao Bearer Token utilizado, ou seja, o token identifica o \"dono\" ou o escopo de controle das empresas sendo gerenciadas.

🏷️ 2. access_token (API Key da empresa)

Além do Bearer Token, é necessário enviar também o access_token, que representa a API Key específica de uma empresa. Ele identifica qual empresa está sendo utilizada na requisição, e todas as ações (como atualizações ou consultas) serão aplicadas somente a essa empresa.

Deve ser enviado no header assim:

access_token: API_KEY_DA_EMPRESA\n\n

✅ Exemplo de headers completos:

Authorization: Bearer SEU_TOKEN_JWT\naccess_token: API_KEY_DA_EMPRESA\n\n

\n

⚠️ Importante:

O Bearer Token é obrigatório para autenticar o contexto do usuário.
\n
O access_token é obrigatório para identificar e manipular uma empresa específica.
\n
Ambos os tokens devem ser enviados em todas as requisições.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30838247","collectionId":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","publishedId":"2sB2qWHQLT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-05-22T23:57:39.000Z"},"item":[{"name":"business","item":[{"name":"Invitations","item":[{"name":"GET","id":"d66ab5dc-d32b-4776-ad79-48806754cd67","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"

API key da empresa autenticada pelo integrador.

\n"}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"

📋 List Invitations

Este endpoint retorna a lista de convites de usuários vinculados ao business identificado pelo access-token informado.

🔗 Endpoint

GET /invitations\n\n

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access-token`	API Key da empresa. Identifica o business do qual os convites serão listados.

📄 Request Body

Este endpoint não requer corpo (body). Apenas os headers são necessários.

🔍 Observações Importantes

🔐 Apenas convites pertencentes ao business identificado pelo access-token serão retornados.
\n
📋 A resposta inclui todos os convites cadastrados, com seus respectivos status e tipos.
\n

API key da empresa autenticada pelo integrador.

\n"}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/types","description":"

📂 List Invitation Types

Este endpoint retorna todos os tipos de convite disponíveis para uso no business identificado pelo access-token informado.

🔗 Endpoint

GET /invitations/types\n\n

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access-token`	API Key da empresa. Identifica o business do qual os tipos de convite serão listados.

📄 Request Body

Este endpoint não requer corpo (body). Apenas os headers são necessários.

🔍 Observações Importantes

📋 Use este endpoint para obter os IDs dos tipos de convite antes de criar um novo convite via Create Invitation.
\n
🔐 Apenas os tipos de convite disponíveis para o business identificado pelo access-token serão retornados.
\n

API key da empresa autenticada pelo integrador.

\n"}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"

🎟️ Create Invitation

Este endpoint permite criar um novo convite vinculado ao business identificado pelo access-token informado.

🔗 Endpoint

POST /invitations\n\n

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access-token`	API Key da empresa. Identifica o business no qual o convite será criado.

📄 Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
email	`string`	Formato de e-mail válido. Máx. 191 caracteres	Sim	E-mail do convidado para envio do convite.
expires_at	`datetime`	Datetime válido para expiração	Sim	Data de expiração do convite
type	`string`	Tipo válido e listado pelo GET Types	Sim	Tipo válido e listado pelo GET Types

🔍 Observações Importantes

🔐 O convite será criado e vinculado ao business identificado pelo access-token.
\n
📧 O convidado receberá o convite no e-mail informado após a criação.
\n
🎫 O tipo de convite define as permissões e características do acesso concedido.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","name":"Vai de Ticket Integração","type":"collection"}},"urlObject":{"path":["invitations"],"host":["https://sandbox.vaideticket.com.br/api/v1"],"query":[],"variable":[]}},"response":[{"id":"59ca2bde-4341-dbc1-7e13-46bb99c4848d","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"## 🎟️ **Create Invitation**\n\nEste endpoint permite criar um **novo convite** vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nPOST /invitations\n\n ```\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business no qual o convite será criado. |\n\n---\n\n### 📄 **Request Body**\n\n| Campo | Tipo | Regras | Obrigatório | Descrição |\n| --- | --- | --- | --- | --- |\n| **email** | `string` | Formato de e-mail válido. Máx. 191 caracteres | Sim | E-mail do convidado para envio do convite. |\n| **expires_at** | `datetime` | Datetime válido para expiração | Sim | Data de expiração do convite |\n| **type** | `string` | Tipo válido e listado pelo GET Types | Sim | Tipo válido e listado pelo GET Types |\n\n---\n\n## 🔍 **Observações Importantes**\n\n- 🔐 O convite será criado e vinculado ao business identificado pelo `access-token`.\n \n- 📧 O convidado receberá o convite no e-mail informado após a criação.\n \n- 🎫 O tipo de convite define as permissões e características do acesso concedido."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Convite enviado com sucesso!\",\"invitation\":{\"id\":1,\"email\":\"manager@test.com\",\"type\":\"Manager\",\"status\":\"pending\",\"expires_at\":\"2026-05-17 10:00:00\",\"created_at\":\"2026-05-16 10:00:00\",\"updated_at\":\"2026-05-16 10:00:00\"}}"},{"id":"47a6c434-5fd1-75c3-0c22-1e56d2fc6eaa","name":"400 Bad Request - email duplicado pendente","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"## 🎟️ **Create Invitation**\n\nEste endpoint permite criar um **novo convite** vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nPOST /invitations\n\n ```\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business no qual o convite será criado. |\n\n---\n\n### 📄 **Request Body**\n\n| Campo | Tipo | Regras | Obrigatório | Descrição |\n| --- | --- | --- | --- | --- |\n| **email** | `string` | Formato de e-mail válido. Máx. 191 caracteres | Sim | E-mail do convidado para envio do convite. |\n| **expires_at** | `datetime` | Datetime válido para expiração | Sim | Data de expiração do convite |\n| **type** | `string` | Tipo válido e listado pelo GET Types | Sim | Tipo válido e listado pelo GET Types |\n\n---\n\n## 🔍 **Observações Importantes**\n\n- 🔐 O convite será criado e vinculado ao business identificado pelo `access-token`.\n \n- 📧 O convidado receberá o convite no e-mail informado após a criação.\n \n- 🎫 O tipo de convite define as permissões e características do acesso concedido."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Ja existe um convite pendente para este email\"}"},{"id":"08e44c79-677c-aa39-a4e4-2e747780aa5f","name":"400 Bad Request - empresa já possui administrador","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"## 🎟️ **Create Invitation**\n\nEste endpoint permite criar um **novo convite** vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nPOST /invitations\n\n ```\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business no qual o convite será criado. |\n\n---\n\n### 📄 **Request Body**\n\n| Campo | Tipo | Regras | Obrigatório | Descrição |\n| --- | --- | --- | --- | --- |\n| **email** | `string` | Formato de e-mail válido. Máx. 191 caracteres | Sim | E-mail do convidado para envio do convite. |\n| **expires_at** | `datetime` | Datetime válido para expiração | Sim | Data de expiração do convite |\n| **type** | `string` | Tipo válido e listado pelo GET Types | Sim | Tipo válido e listado pelo GET Types |\n\n---\n\n## 🔍 **Observações Importantes**\n\n- 🔐 O convite será criado e vinculado ao business identificado pelo `access-token`.\n \n- 📧 O convidado receberá o convite no e-mail informado após a criação.\n \n- 🎫 O tipo de convite define as permissões e características do acesso concedido."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Esta empresa ja possui um administrador\"}"},{"id":"95359e67-1063-1882-81b7-4dfb331e6ef9","name":"400 Bad Request - administrador pendente já existe","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"## 🎟️ **Create Invitation**\n\nEste endpoint permite criar um **novo convite** vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nPOST /invitations\n\n ```\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business no qual o convite será criado. |\n\n---\n\n### 📄 **Request Body**\n\n| Campo | Tipo | Regras | Obrigatório | Descrição |\n| --- | --- | --- | --- | --- |\n| **email** | `string` | Formato de e-mail válido. Máx. 191 caracteres | Sim | E-mail do convidado para envio do convite. |\n| **expires_at** | `datetime` | Datetime válido para expiração | Sim | Data de expiração do convite |\n| **type** | `string` | Tipo válido e listado pelo GET Types | Sim | Tipo válido e listado pelo GET Types |\n\n---\n\n## 🔍 **Observações Importantes**\n\n- 🔐 O convite será criado e vinculado ao business identificado pelo `access-token`.\n \n- 📧 O convidado receberá o convite no e-mail informado após a criação.\n \n- 🎫 O tipo de convite define as permissões e características do acesso concedido."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Ja existe um convite pendente de administrador para esta empresa\"}"},{"id":"13da8c21-1d06-e8bf-70a5-da8ae9390357","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"## 🎟️ **Create Invitation**\n\nEste endpoint permite criar um **novo convite** vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nPOST /invitations\n\n ```\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business no qual o convite será criado. |\n\n---\n\n### 📄 **Request Body**\n\n| Campo | Tipo | Regras | Obrigatório | Descrição |\n| --- | --- | --- | --- | --- |\n| **email** | `string` | Formato de e-mail válido. Máx. 191 caracteres | Sim | E-mail do convidado para envio do convite. |\n| **expires_at** | `datetime` | Datetime válido para expiração | Sim | Data de expiração do convite |\n| **type** | `string` | Tipo válido e listado pelo GET Types | Sim | Tipo válido e listado pelo GET Types |\n\n---\n\n## 🔍 **Observações Importantes**\n\n- 🔐 O convite será criado e vinculado ao business identificado pelo `access-token`.\n \n- 📧 O convidado receberá o convite no e-mail informado após a criação.\n \n- 🎫 O tipo de convite define as permissões e características do acesso concedido."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"API key is missing\"}"},{"id":"c45b7c44-d23a-4e7a-a507-6d3a0c8daa6e","name":"422 Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{\"email\":\"admin@mail.com\",\"type\":\"BusinessAdmin\",\"expires_at\":\"2026-05-17 10:00:00\"}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations","description":"## 🎟️ **Create Invitation**\n\nEste endpoint permite criar um **novo convite** vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nPOST /invitations\n\n ```\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business no qual o convite será criado. |\n\n---\n\n### 📄 **Request Body**\n\n| Campo | Tipo | Regras | Obrigatório | Descrição |\n| --- | --- | --- | --- | --- |\n| **email** | `string` | Formato de e-mail válido. Máx. 191 caracteres | Sim | E-mail do convidado para envio do convite. |\n| **expires_at** | `datetime` | Datetime válido para expiração | Sim | Data de expiração do convite |\n| **type** | `string` | Tipo válido e listado pelo GET Types | Sim | Tipo válido e listado pelo GET Types |\n\n---\n\n## 🔍 **Observações Importantes**\n\n- 🔐 O convite será criado e vinculado ao business identificado pelo `access-token`.\n \n- 📧 O convidado receberá o convite no e-mail informado após a criação.\n \n- 🎫 O tipo de convite define as permissões e características do acesso concedido."},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"O email e obrigatorio.\"],\"type\":[\"O tipo do convite e obrigatorio.\"]}}"}],"_postman_id":"99b62014-437f-4bfc-800b-25f2fd4b01b9"},{"name":"Get Invitation By Id","id":"1bf05528-2358-4a6b-9275-f3f043f03094","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"

API key da empresa autenticada pelo integrador.

\n"}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"

🔎 Get Invitation By ID

Este endpoint permite consultar os dados completos de um convite específico com base no seu ID.

🔗 Endpoint

GET /invitations/{invitation_id}\n\n

🔗 Parâmetros de URL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Descrição
`invitation_id`	inteiro	ID do convite que se deseja consultar.

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access-token`	API Key da empresa. Identifica o business ao qual o convite pertence.

📄 Request Body

Este endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.

🔍 Observações Importantes

🔐 O convite só será retornado se pertencer ao business identificado pelo access-token.
\n
🧾 A resposta inclui todos os dados do convite, incluindo status, tipo e informações do convidado.
\n

API key da empresa autenticada pelo integrador.

\n"}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"

🗑️ Delete Invitation

Este endpoint permite cancelar/excluir um convite específico vinculado ao business identificado pelo access-token informado.

🔗 Endpoint

DELETE /invitations/{invitation_id}\n\n

🔗 Parâmetros de URL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Descrição
`invitation_id`	inteiro	ID do convite que se deseja excluir.

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access-token`	API Key da empresa. Identifica o business ao qual o convite pertence.

📄 Request Body

Este endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.

⚠️ Observações Importantes

🔐 Apenas convites pertencentes ao business identificado pelo access-token podem ser excluídos.
\n
⚠️ A exclusão é permanente e não pode ser desfeita.
\n
🚫 Convites já utilizados podem não ser elegíveis para exclusão.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","name":"Vai de Ticket Integração","type":"collection"}},"urlObject":{"path":["invitations","{{id}}"],"host":["https://sandbox.vaideticket.com.br/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e1d9cf5b-ebf4-9bb5-cb99-1df606abe3d3","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"## 🗑️ **Delete Invitation**\n\nEste endpoint permite **cancelar**/**excluir um convite** específico vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nDELETE /invitations/{invitation_id}\n\n ```\n\n---\n\n### 🔗 **Parâmetros de URL**\n\n| Parâmetro | Tipo | Descrição |\n| --- | --- | --- |\n| `invitation_id` | inteiro | ID do convite que se deseja excluir. |\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business ao qual o convite pertence. |\n\n---\n\n### 📄 **Request Body**\n\nEste endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.\n\n---\n\n## ⚠️ **Observações Importantes**\n\n- 🔐 Apenas convites pertencentes ao business identificado pelo `access-token` podem ser excluídos.\n \n- ⚠️ A exclusão é **permanente** e não pode ser desfeita.\n \n- 🚫 Convites já utilizados podem não ser elegíveis para exclusão."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Convite revogado com sucesso!\",\"invitation\":{\"id\":1,\"email\":\"manager@test.com\",\"type\":\"Manager\",\"status\":\"cancelled\",\"expires_at\":\"2026-05-17 10:00:00\",\"created_at\":\"2026-05-16 10:00:00\",\"updated_at\":\"2026-05-16 10:00:00\"}}"},{"id":"e868d354-0ee5-055d-38e3-4a50c57d394b","name":"400 Bad Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"## 🗑️ **Delete Invitation**\n\nEste endpoint permite **cancelar**/**excluir um convite** específico vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nDELETE /invitations/{invitation_id}\n\n ```\n\n---\n\n### 🔗 **Parâmetros de URL**\n\n| Parâmetro | Tipo | Descrição |\n| --- | --- | --- |\n| `invitation_id` | inteiro | ID do convite que se deseja excluir. |\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business ao qual o convite pertence. |\n\n---\n\n### 📄 **Request Body**\n\nEste endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.\n\n---\n\n## ⚠️ **Observações Importantes**\n\n- 🔐 Apenas convites pertencentes ao business identificado pelo `access-token` podem ser excluídos.\n \n- ⚠️ A exclusão é **permanente** e não pode ser desfeita.\n \n- 🚫 Convites já utilizados podem não ser elegíveis para exclusão."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Apenas convites pendentes podem ser revogados\"}"},{"id":"b815de3c-89c4-a2c2-5703-38a482c2c7fa","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"## 🗑️ **Delete Invitation**\n\nEste endpoint permite **cancelar**/**excluir um convite** específico vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nDELETE /invitations/{invitation_id}\n\n ```\n\n---\n\n### 🔗 **Parâmetros de URL**\n\n| Parâmetro | Tipo | Descrição |\n| --- | --- | --- |\n| `invitation_id` | inteiro | ID do convite que se deseja excluir. |\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business ao qual o convite pertence. |\n\n---\n\n### 📄 **Request Body**\n\nEste endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.\n\n---\n\n## ⚠️ **Observações Importantes**\n\n- 🔐 Apenas convites pertencentes ao business identificado pelo `access-token` podem ser excluídos.\n \n- ⚠️ A exclusão é **permanente** e não pode ser desfeita.\n \n- 🚫 Convites já utilizados podem não ser elegíveis para exclusão."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"API key is missing\"}"},{"id":"c85bb666-1693-95cc-ea92-6cb786c4fc07","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"## 🗑️ **Delete Invitation**\n\nEste endpoint permite **cancelar**/**excluir um convite** específico vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nDELETE /invitations/{invitation_id}\n\n ```\n\n---\n\n### 🔗 **Parâmetros de URL**\n\n| Parâmetro | Tipo | Descrição |\n| --- | --- | --- |\n| `invitation_id` | inteiro | ID do convite que se deseja excluir. |\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business ao qual o convite pertence. |\n\n---\n\n### 📄 **Request Body**\n\nEste endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.\n\n---\n\n## ⚠️ **Observações Importantes**\n\n- 🔐 Apenas convites pertencentes ao business identificado pelo `access-token` podem ser excluídos.\n \n- ⚠️ A exclusão é **permanente** e não pode ser desfeita.\n \n- 🚫 Convites já utilizados podem não ser elegíveis para exclusão."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Convite não encontrado\"}"},{"id":"65263d64-93ff-d9e1-ed38-e63420a12181","name":"422 Unprocessable Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"access-token","value":"BUSINESS_API_KEY","description":"API key da empresa autenticada pelo integrador."}],"body":{"mode":"raw","raw":"{}"},"url":"https://sandbox.vaideticket.com.br/api/v1/invitations/{{id}}","description":"## 🗑️ **Delete Invitation**\n\nEste endpoint permite **cancelar**/**excluir um convite** específico vinculado ao business identificado pelo `access-token` informado.\n\n---\n\n### 🔗 **Endpoint**\n\n```\nDELETE /invitations/{invitation_id}\n\n ```\n\n---\n\n### 🔗 **Parâmetros de URL**\n\n| Parâmetro | Tipo | Descrição |\n| --- | --- | --- |\n| `invitation_id` | inteiro | ID do convite que se deseja excluir. |\n\n---\n\n### 🔐 **Headers obrigatórios**\n\n| Header | Descrição |\n| --- | --- |\n| `Authorization` | Token JWT de autenticação no formato `Bearer`. Representa o integrador. |\n| `access-token` | API Key da empresa. Identifica o business ao qual o convite pertence. |\n\n---\n\n### 📄 **Request Body**\n\nEste endpoint não requer corpo (body). Apenas os headers e o ID do convite na URL são necessários.\n\n---\n\n## ⚠️ **Observações Importantes**\n\n- 🔐 Apenas convites pertencentes ao business identificado pelo `access-token` podem ser excluídos.\n \n- ⚠️ A exclusão é **permanente** e não pode ser desfeita.\n \n- 🚫 Convites já utilizados podem não ser elegíveis para exclusão."},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"id\":[\"O convite deve ser um identificador valido.\"]}}"}],"_postman_id":"0c061ff7-fbb2-4a40-8df7-3398f280483d"}],"id":"fe59857a-5812-4fed-b28a-46732f5a2fbe","_postman_id":"fe59857a-5812-4fed-b28a-46732f5a2fbe","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","name":"Vai de Ticket Integração","type":"collection"}}},{"name":"Create","id":"833bde39-35cb-4566-9393-6cfc7016df56","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"business_type\": \"CNPJ\",\r\n \"fantasyName\": \"Empresa Teste\",\r\n \"companyName\": \"Empresa Teste LTDA\",\r\n \"cnpj\": \"12345678000199\",\r\n \"cpf\": null,\r\n \"birth_date\": null,\r\n \"type\": \"LIMITED\",\r\n \"email\": \"empresa@teste.com\",\r\n \"phone\": \"11999999999\",\r\n \"phone_comercial\": \"1133334444\",\r\n \"logo\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAusB9Y02K5YAAAAASUVORK5CYII=\",\r\n \"ticketFee\": 10.0,\r\n \"ticketFeePercentage\": 5,\r\n \"ticketValueFree\": 0,\r\n \"send_ticket_whatsapp_free\": 0,\r\n \"ticketValue\": 100.0,\r\n \"fee_send_ticket_whatsapp\": 2.5,\r\n \"address\": {\r\n \"cep\": \"01001000\",\r\n \"state\": 1,\r\n \"city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.vaideticket.com.br/api/v1/business","description":"

Create Business

Este endpoint permite que o usuário cadastre um novo negócio com os dados especificados.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
business_type	`string`	`in:CPF,CNPJ`	Sim	Define o tipo do negócio, se é pessoa física (CPF) ou jurídica (CNPJ).
fantasyName	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CNPJ`.	Condicional	Nome fantasia da empresa, usado para exibição pública.
companyName	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CNPJ`.	Sim	Razão social da empresa, nome jurídico oficial. Em caso de CPF, nome da pessoa.
cnpj	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CNPJ`.	Condicional	Número do CNPJ da empresa, obrigatório para negócios do tipo CNPJ.
cpf	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CPF`.	Condicional	Número do CPF da pessoa física responsável pelo negócio.
birth_date	`string (date)`	Obrigatório se `business_type` for `CPF`. Deve representar uma data válida com pelo menos 18 anos.	Condicional	Data de nascimento da pessoa física, obrigatória em cadastros com CPF.
type	`string`	`in:MEI,LIMITED,INDIVIDUAL,ASSOCIATION`. Obrigatório se `business_type` for `CNPJ`.	Condicional	Tipo de entidade jurídica, usado em negócios com CNPJ.
email	`string`	Máx. 191 caracteres. Formato de e-mail válido.	Sim	E-mail principal da empresa, utilizado para contato e notificações.
phone	`string`	Deve conter exatamente 11 dígitos.	Sim	Telefone celular principal do representante, com DDD.
phone_comercial	`string`	Opcional. Deve conter entre 10 e 11 dígitos.	Não	Telefone comercial da empresa, utilizado na página do evento para contato pelos clientes.
logo	`file (imagem)`	Formatos aceitos: jpeg, png, jpg, webp. Tamanho máximo: 2MB.	Não	base64 da Logo da empresa; Formatos permitidos: jpeg
ticketFee	`number`	Opcional.	Não	Valor fixo da taxa de serviço cobrada por ingresso. Requer permissão especial.
ticketFeePercentage	`number`	Opcional.	Não	Percentual da taxa de serviço por ingresso. Requer permissão especial.
ticketValueFree	`boolean`	Opcional.	Não	Se o envio de ingressos por email será gratuíto ou não. Requer permissão especial.

fee_send_ticket_email	`number`	Opcional.	Não	Valor do envio de ingresso unitário por email para convidados. Requer permissão especial.
fee_send_ticket_whatsapp	`number`	Opcional. Deve ser numérico.	Não	Valor do envio de ingresso unitário por whatsapp para convidados. Requer permissão especial.

address (obrigatório)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
cep	`string`	Exatamente 8 caracteres.	Sim	CEP do endereço
state	`integer`	Mínimo: 1.	Sim	ID do estado (buscar em GET States)
city	`integer`	Mínimo: 1.	Sim	ID da cidade (buscar em GET Cities)
district	`string`	Máx. 191 caracteres.	Sim	Bairro
address	`string`	Máx. 191 caracteres.	Sim	Rua
number	`string`	Máx. 20 caracteres.	Sim	Número do imóvel
complement	`string`	Máx. 191 caracteres. Opcional.	Não	Complemento
local	`string`	Máx. 191 caracteres. Opcional.	Não	Local do endereço, ex: Bloco 02

Permissão para Alteração de Valores Comerciais

Os seguintes campos do corpo da requisição estão relacionados a valores comerciais da empresa e somente serão aceitos caso o integrador possua permissão explícita para alterá-los:

ticketFee
\n
ticketFeePercentage
\n
ticketValueFree
\n
ticketValue
\n
fee_send_ticket_whatsapp
\n

⚠️ Importante:

Esses campos são restritos e exigem uma autorização prévia da equipe Vai de Ticket.

Por padrão, integradores não têm permissão para definir ou modificar esses valores diretamente via API. Para habilitar esse tipo de alteração, é necessário entrar em contato com a equipe Vai de Ticket e formalizar o processo de liberação.

📞 Como solicitar acesso:

Caso sua aplicação precise gerenciar esses campos, entre em contato com nosso time comercial ou de suporte técnico para discutir a habilitação e os critérios necessários.

Buscar Dados da empresa

Este endpoint permite consultar os dados completos de uma empresa vinculada ao access_token informado.

Update empresa

Este endpoint permite que o usuário atualize uma empresa com os dados especificados.

Body

Campo	Tipo	Regras	Obrigatório	Descrição
business_type	`string`	`in:CPF,CNPJ`	Sim	Define o tipo do negócio, se é pessoa física (CPF) ou jurídica (CNPJ).
fantasyName	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CNPJ`.	Condicional	Nome fantasia da empresa, usado para exibição pública.
companyName	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CNPJ`.	Sim	Razão social da empresa, nome jurídico oficial. Em caso de CPF, nome da pessoa.
cnpj	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CNPJ`.	Condicional	Número do CNPJ da empresa, obrigatório para negócios do tipo CNPJ.
cpf	`string`	Máx. 191 caracteres. Obrigatório se `business_type` for `CPF`.	Condicional	Número do CPF da pessoa física responsável pelo negócio.
birth_date	`string (date)`	Obrigatório se `business_type` for `CPF`. Deve representar uma data válida com pelo menos 18 anos.	Condicional	Data de nascimento da pessoa física, obrigatória em cadastros com CPF.
type	`string`	`in:MEI,LIMITED,INDIVIDUAL,ASSOCIATION`. Obrigatório se `business_type` for `CNPJ`.	Condicional	Tipo de entidade jurídica, usado em negócios com CNPJ.
email	`string`	Máx. 191 caracteres. Formato de e-mail válido.	Sim	E-mail principal da empresa, utilizado para contato e notificações.
phone	`string`	Deve conter exatamente 11 dígitos.	Sim	Telefone celular principal do representante, com DDD.
phone_comercial	`string`	Opcional. Deve conter entre 10 e 11 dígitos.	Não	Telefone comercial da empresa, utilizado na página do evento para contato pelos clientes.
logo	`file (imagem)`	Formatos aceitos: jpeg, png, jpg, webp. Tamanho máximo: 2MB.	Não	base64 da Logo da empresa; Formatos permitidos: jpeg
ticketFee	`number`	Opcional.	Não	Valor fixo da taxa de serviço cobrada por ingresso. Requer permissão especial.
ticketFeePercentage	`number`	Opcional.	Não	Percentual da taxa de serviço por ingresso. Requer permissão especial.
ticketValueFree	`number`	Opcional.	Não	Se o envio de ingressos por email será gratuíto ou não. Requer permissão especial.
fee_send_ticket_email	`number`	Opcional.	Não	Valor do envio de ingresso unitário por email para convidados. Requer permissão especial.
fee_send_ticket_whatsapp	`number`	Opcional. Deve ser numérico.	Não	Valor do envio de ingresso unitário por whatsapp para convidados. Requer permissão especial.

address (objeto - obrigatório se informado)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
cep	`string`	Exatamente 8 caracteres.	Sim	CEP do endereço
state	`integer`	Mínimo: 1.	Sim	ID do estado (buscar em GET States)
city	`integer`	Mínimo: 1.	Sim	ID da cidade (buscar em GET Cities)
district	`string`	Máx. 191 caracteres.	Sim	Bairro
address	`string`	Máx. 191 caracteres.	Sim	Rua
number	`string`	Máx. 20 caracteres.	Sim	Número do imóvel
complement	`string`	Máx. 191 caracteres. Opcional.	Não	Complemento
local	`string`	Máx. 191 caracteres. Opcional.	Não	Local do endereço, ex: Bloco 02

Permissão para Alteração de Valores Comerciais

Os seguintes campos do corpo da requisição estão relacionados a valores comerciais da empresa e somente serão aceitos caso o integrador possua permissão explícita para alterá-los:

ticketFee
\n
ticketFeePercentage
\n
ticketValueFree
\n
ticketValue
\n
fee_send_ticket_whatsapp
\n

⚠️ Importante:

Esses campos são restritos e exigem uma autorização prévia da equipe Vai de Ticket.

📞 Como solicitar acesso:

Caso sua aplicação precise gerenciar esses campos, entre em contato com nosso time comercial ou de suporte técnico para discutir a habilitação e os critérios necessários.

💸 Registrar Chave PIX para Recebimento

Este endpoint permite que uma empresa cadastre sua chave PIX para recebimento automático de valores pelas vendas realizadas na plataforma.

🔗 Endpoint

POST /api/business/pix\n\n

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT no formato `Bearer`. Representa o integrador autenticado.
`access_token`	API Key da empresa. Identifica o business no qual a chave será registrada.

📄 Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
pix_key	string	Máx. 191 caracteres	Sim	A chave PIX da empresa. Pode ser CPF, CNPJ, e-mail, telefone ou chave aleatória.
pix_key_type	string	`CPF`, `CNPJ`, `EMAIL`, `PHONE`, `EVP`	Sim	O tipo da chave PIX enviada. Deve estar de acordo com o conteúdo de `pix_key`.
email	string	E-mail válido	Sim	E-mail da empresa utilizado em nosso gateway de pagamento, precisa ser um email único e não utilizado.

Observações Importantes

🧾 Apenas uma chave PIX pode estar ativa por empresa. Um novo registro substituirá o anterior, se existir.
\n
📧 O e-mail informado pode ser utilizado para registro no gateway de pagamento, precisa ser um e-mail ainda não utilizado e resultará em erro caso já tenha sido utiizado previamente.
\n
📤 Os repasses de vendas realizados pela plataforma utilizarão exclusivamente essa chave cadastrada.
\n

🎟️ Create Ticket Type

Este endpoint permite cadastrar os tipos de ingressos vinculados a um evento já existente.

🔗 Endpoint

POST /api/event/{idEvent}/ticket_type\n\n

Parâmetro de rota:
idEvent (obrigatório): ID do evento no qual os ingressos serão cadastrados.

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access_token`	API Key da empresa. Identifica o business ao qual o evento e os ingressos pertencem.

📄 Request Body

O corpo da requisição deve ser um objeto com o array ticketType, contendo um ou mais ingressos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
name	string	Máx. 191 caracteres	Sim	Nome do ingresso (Ex.: \"Pista\", \"Camarote\").
quantity	integer	Maior que 0	Sim	Quantidade total de ingressos disponíveis para venda.
purchasable	boolean	true/false	Sim	Define se o ingresso está disponível para venda.
required_user_data	boolean	true/false	Não	Define se é obrigatório informar dados do convidado (nome, CPF, etc.). Esse campo é utilizado apenas em ingresos para envio (convidados)
purchasable_free	boolean	true/false	Sim	Define se o ingresso pode ser adquirido gratuitamente na página do evento.
price	number	Valor em decimal, ex: 10.50 Valor mínimo de R$5,00	Sim	Preço do ingresso. Obrigatório para ingressos disponíveis para venda.
ticket_purchase_limit	integer	Quantidade máxima por pedido	Sim	Limite de ingressos que podem ser comprados por pedidop.
available_from_date	string (datetime)	Formato: `YYYY-MM-DD HH:mm`	Não	Data e hora de início da venda do ingresso. Obrigatório para ingressos disponíveis para venda.
available_until_date	string (datetime)	Formato: `YYYY-MM-DD HH:mm`	Não	Data e hora de término da venda do ingresso. Obrigatório para ingressos disponíveis para venda.
payer_type	string	`Empresa` ou `Cliente`	Sim	Define quem paga a taxa de serviço (`Empresa` ou `Cliente`).
send_via_whatsapp	boolean	true/false	Não	Se o ingresso será enviado automaticamente via WhatsApp. Esse campo é utilizado apenas em ingresos para envio (convidados)

🔍 Observações Importantes

📌 O evento informado no parâmetro {idEvent} deve estar vinculado à empresa identificada pelo access_token.
\n
🏷️ O valor do ingresso (price) deve ser informado em decimal, exemplo:
\n
→ 10.00 = R$ 10,00
\n
→ 100.00 = R$ 100,00
\n
📅 As datas de venda (available_from_date e available_until_date) definem o período em que o ingresso estará disponível para compra.
\n
🚫 Não é possível cadastrar ingressos para eventos que não pertencem ao integrador (Bearer) ou à empresa (access_token) autenticada.
\n
🔗 Alguns campos como send_via_whatsapp e required_user_data são utilizados apenas para ingressos para envio (convidados).
\n

Listar Tipos de Ingressos para Evento

Este endpoint retorna a lista de tipos de ingressos disponíveis para um evento específico no sistema.

Endpoint

GET /event/{event_id}/ticket_type\n\n

Parâmetros de Requisição

event_id (path parameter): O ID do evento para o qual você deseja listar os tipos de ingressos.

Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.

⚠️ Este endpoint exige o envio do access_token, pois está vinculado a uma empresa específica pelo eventop.

Funcionamento

A requisição retorna uma lista de tipos de ingressos disponíveis para o evento especificado. A resposta será um array JSON que pode estar vazio, indicando que não há tipos de ingressos cadastrados para o evento.

Resposta Esperada

Status: 200 OK
\n
Content-Type: application/json
\n
Body: Um array JSON contendo os tipos de ingressos, onde cada item pode incluir informações como código, descrição e preço.
\n

Utilize esses dados para gerenciar a venda de ingressos para o evento.

Get Ticket Type By ID

Este endpoint é utilizado para recuperar informações sobre um ingresso específico.

Endpoint

GET /event/{event_id}/ticket_type/{ticket_type_id}\n\n

Parâmetros de URL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Descrição
`event_id`	inteiro	ID do evento para o qual se deseja listar os tipos de ingressos.
`ticket_type_id`	inteiro	ID do tipo de ingresso que se deseja consultar.

Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.

⚠️ Este endpoint exige o envio do access_token, pois está vinculado a uma empresa específica.

🎟️ Update Ticket Type Status

Este endpoint permite que o usuário atualize o status de um tipo de ingresso existente.

🔗 Endpoint

PATCH /event/{id_event}/ticket_type/{id_ticket_type}/update_status/{status}\n\n

Substitua _{id_event}_ pelo ID do evento, _{id_ticket_type_``}_ pelo id do tipo de ingresso e _{status}_ pelo novo status do evento (ex: Ativo).

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access_token`	API Key da empresa. Identifica o business ao qual o evento pertence.

📄 Status disponíveis

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
active	Evento ativo disponível para envio de ingressos e compras online
inactive	Evento cancelado

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","id":"a96b96ee-b490-4acf-999d-a7ff4ea8e0da","name":"Vai de Ticket Integração","type":"collection"}},"urlObject":{"path":["event","6","ticket_type","10","update_status","inactive"],"host":["https://sandbox.vaideticket.com.br/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2449bd72-3eec-4d61-9008-ca986fcc1341","name":"Update Ticket","originalRequest":{"method":"POST","header":[{"key":"access_token","value":"BUSINESS_API_KEY","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Teste evento\",\r\n \"dateStart\": \"2025-12-20 20:00\",\r\n \"dateEnd\": \"2025-12-21 00:00\",\r\n \"idEventCategory\": 1,\r\n \"logo\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAusB9Y02K5YAAAAASUVORK5CYII=\",\r\n \"address\": {\r\n \"cep\": \"01001000\",\r\n \"state\": 1,\r\n \"city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.vaideticket.com.br/api/v1/event"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"id\": 10,\r\n \"id_event\": 6,\r\n \"name\": \"Ingresso Teste Pista\",\r\n \"quantity\": 100,\r\n \"purchasable\": 1,\r\n \"price\": \"1000.00\",\r\n \"required_user_data\": 0,\r\n \"ticket_purchase_limit\": 5,\r\n \"payer_type\": \"Empresa\",\r\n \"selling_tickets_fee_value\": \"5.00\",\r\n \"selling_tickets_fee_type\": \"percentage\",\r\n \"send_via_whatsapp\": 1,\r\n \"available_from_date\": \"2025-05-05 12:00:00\",\r\n \"available_until_date\": \"2025-12-05 12:00:00\",\r\n \"status\": \"active\",\r\n \"created_at\": \"2025-06-21T15:12:15.000000Z\",\r\n \"updated_at\": \"2025-06-21T15:12:15.000000Z\",\r\n \"deleted_at\": null\r\n}"}],"_postman_id":"591f9b62-78b4-4d59-b903-8b32867a0a50"},{"name":"Send Tickets","id":"d7422f42-1b19-4837-90da-449c7a180572","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","value":"BUSINESS_API_KEY"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"tickets\":[\r\n {\r\n \"id_ticket_type\":1,\r\n \"name\":\"Matheus Oliveira\",\r\n \"email\":\"matheushro.dev@gmail.com\",\r\n \"phone\":\"11999999999\",\r\n \"amount\":1\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox.vaideticket.com.br/api/v1/event/6/ticket_type/order","description":"

🎫 Enviar Ingressos dos alunos

Este endpoint permite que o integrador envie manualmente um ou mais ingressos para os alunos, informando os dados do destinatário.

🔗 Endpoint

POST /api/event/{idEvent}/ticket_type/order\n\n

Parâmetro de rota:
idEvent (obrigatório): ID do evento para o qual os ingressos serão enviados.

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access_token`	API Key da empresa. Identifica o business ao qual o evento pertence.

📄 Request Body

O corpo da requisição deve conter o array tickets, com os ingressos a serem enviados.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
id_ticket_type	integer	ID de um tipo de ingresso válido	Sim	ID do ingresso a ser enviado. Deve pertencer ao evento informado.
name	string	Máx. 191 caracteres	Sim	Nome completo do aluno.
email	string	E-mail válido	Não	Endereço de e-mail para envio do ingresso. (obrigatório para envio via e-mail).
phone	string	11 dígitos (com DDD)	Não	Número de telefone com DDD (obrigatório para envio via WhatsApp, se configurado).
amount	integer	Mínimo 1	Sim	Quantidade de ingressos a ser enviada para esse aluno.

🔍 Observações Importantes

✅ Após envio do body, receberá como retorno os ingressos pendentes e os dados do pedido com QRCode para pagamento via PIX.
\n
📌 O tipo de ingresso (id_ticket_type) deve pertencer ao evento informado no parâmetro da rota e estar vinculado ao mesmo business (access_token).
\n
⚠️ Caso o valor do envio seja inferior a R$5, será retornada uma chave PIX para transferência, após realizada será necessário enviar uma requisição para nosso endpoint de notificação e aguardar enquanto nossa equipe valida o pagamento.
\n
🔁 É possível enviar múltiplos ingressos (inclusive de diferentes tipos) em uma única requisição, adicionando vários objetos ao array tickets.
\n

Hello World

\",\r\n \"dateStart\": \"2025-12-20 20:00\",\r\n \"dateEnd\": \"2025-12-21 00:00\",\r\n \"idEventCategory\": 1,\r\n \"logo\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAusB9Y02K5YAAAAASUVORK5CYII=\",\r\n \"address\": {\r\n \"cep\": \"01001000\",\r\n \"state\": 1,\r\n \"city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.vaideticket.com.br/api/v1/event/6","description":"

🎟️ Create Event

Este endpoint permite que o usuário cadastre um novo evento vinculado ao business identificado pelo access_token informado.

🔗 Endpoint

POST /api/events\n\n

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access_token`	API Key da empresa. Identifica o business no qual o evento será criado.

📄 Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
name	string	Máx. 191 caracteres	Sim	Nome do evento.
description	string	Formato HTML	Não	Descrição do evento no formato HTML presente na página do evento
dateStart	string (datetime)	Formato: `YYYY-MM-DD HH:mm`	Sim	Data e hora de início do evento.
dateEnd	string (datetime)	Formato: `YYYY-MM-DD HH:mm`	Sim	Data e hora de término do evento.
idEventCategory	integer	ID da categoria do evento	Sim	Categoria do evento (buscar via endpoint de categorias, se existir).
logo	string (base64)	Base64 da imagem. Formato permitido: jpeg, png, jpg, webp	Não	Logo do evento, enviado em formato base64.

🏢 address (Objeto obrigatório)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
cep	string	Exatamente 8 caracteres	Sim	CEP do endereço
state	integer	ID do estado (`GET /states`)	Sim	Código do estado
city	integer	ID da cidade (`GET /cities/{idState}`)	Sim	Código da cidade
district	string	Máx. 191 caracteres	Sim	Bairro
address	string	Máx. 191 caracteres	Sim	Rua ou avenida
number	string	Máx. 20 caracteres	Sim	Número do imóvel
complement	string	Máx. 191 caracteres	Não	Complemento, como sala, bloco, etc.
local	string	Máx. 191 caracteres	Não	Informações adicionais do local, ex.: auditório, setor.

🔍 Observações Importantes

As taxas do evento serão de acordo com as taxas do business anteriormente cadastrado

Hello World

\",\r\n \"alias\": \"teste-evento-20-12-2025\",\r\n \"selling_tickets_fee_percentage_value\": \"5.00\",\r\n \"selling_tickets_fee_value\": \"0.50\",\r\n \"dateStart\": \"2025-12-20 20:00\",\r\n \"dateEnd\": \"2025-12-21 00:00\",\r\n \"logo\": \"images/event/banner_1750508209.png\",\r\n \"status\": \"Pendente\",\r\n \"accepted_terms_of_use\": 0,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T12:16:49.000000Z\",\r\n \"deleted_at\": null,\r\n \"address\": {\r\n \"id\": 18,\r\n \"cep\": \"01001000\",\r\n \"id_state\": 1,\r\n \"id_city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"deleted_at\": null,\r\n \"city\": {\r\n \"id\": 1,\r\n \"id_state\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acrelândia\"\r\n },\r\n \"state\": {\r\n \"id\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acre\"\r\n }\r\n },\r\n \"category\": {\r\n \"id\": 1,\r\n \"name\": \"Outros\",\r\n \"iconPath\": null,\r\n \"alias\": \"\",\r\n \"status\": \"Ativo\",\r\n \"created_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"updated_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n}"}],"_postman_id":"509b138d-ca1b-4ee7-905b-717b12006d4f"},{"name":"Update Status","id":"31212c6e-4304-497c-8a09-02190869e8f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"access-token","value":"BUSINESS_API_KEY"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.vaideticket.com.br/api/v1/event/1/update_status/Ativo","description":"

🎟️ Update Event Status

Este endpoint permite que o usuário atualize o status de um evento existente.

🔗 Endpoint

PATCH /event/{id}/update_status/{status}\n\n

Substitua _{id}_ pelo ID do evento e _{status}_ pelo novo status do evento (ex: Ativo).

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access_token`	API Key da empresa. Identifica o business ao qual o evento pertence.

📄 Status disponíveis

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
Ativo	Evento ativo disponível para envio de ingressos e compras online
Pendente	Evento pendente com informações incompletas, página para compras de ingressos indisponível
Cancelado	Evento cancelado

🔍 Resposta Esperada

A resposta será retornada no formato JSON e incluirá os seguintes campos:

Campo	Tipo	Descrição
id	integer	ID do evento atualizado.
idEventCategory	integer	ID da categoria do evento.
id_business	integer	ID do business associado ao evento.
id_user	integer	ID do usuário que atualizou o evento.
id_address	integer	ID do endereço do evento.
name	string	Nome do evento.
description	string	Descrição do evento.
alias	string	Alias do evento.
selling_tickets_fee_percentage_value	string	Percentual da taxa de venda de ingressos.
selling_tickets_fee_value	string	Valor da taxa de venda de ingressos.
dateStart	string	Data e hora de início do evento.
dateEnd	string	Data e hora de término do evento.
logo	string	Logo do evento.
status	string	Status atual do evento.
accepted_terms_of_use	integer	Indica se os termos de uso foram aceitos.
created_at	string	Data de criação do evento.
updated_at	string	Data da última atualização do evento.
deleted_at	string	Data de exclusão do evento, se aplicável.
address	objeto	Detalhes do endereço do evento, incluindo campos como CEP, estado, cidade, bairro, etc.

🔍 Observações Importantes

O status do evento pode ser atualizado para valores pré-definidos, como \"Ativo\", \"Inativo\", entre outros.
\n
A operação de atualização retornará um status HTTP 200 em caso de sucesso.
\n

Hello World

\",\r\n \"alias\": \"teste-evento-20-12-2025\",\r\n \"selling_tickets_fee_percentage_value\": \"5.00\",\r\n \"selling_tickets_fee_value\": \"0.50\",\r\n \"dateStart\": \"2025-12-20 20:00\",\r\n \"dateEnd\": \"2025-12-21 00:00\",\r\n \"logo\": \"images/event/banner_1750508209.png\",\r\n \"status\": \"Pendente\",\r\n \"accepted_terms_of_use\": 0,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T12:16:49.000000Z\",\r\n \"deleted_at\": null,\r\n \"address\": {\r\n \"id\": 18,\r\n \"cep\": \"01001000\",\r\n \"id_state\": 1,\r\n \"id_city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"deleted_at\": null,\r\n \"city\": {\r\n \"id\": 1,\r\n \"id_state\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acrelândia\"\r\n },\r\n \"state\": {\r\n \"id\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acre\"\r\n }\r\n },\r\n \"category\": {\r\n \"id\": 1,\r\n \"name\": \"Outros\",\r\n \"iconPath\": null,\r\n \"alias\": \"\",\r\n \"status\": \"Ativo\",\r\n \"created_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"updated_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n}"}],"_postman_id":"31212c6e-4304-497c-8a09-02190869e8f6"},{"name":"Create Event","id":"42312715-0417-465b-a061-38087fa431eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","value":"BUSINESS_API_KEY"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Teste evento\",\r\n \"description\": \"

Hello World

🎟️ Create Event

Este endpoint permite que o usuário cadastre um novo evento vinculado ao business identificado pelo access_token informado.

🔗 Endpoint

POST /api/events\n\n

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.
`access_token`	API Key da empresa. Identifica o business no qual o evento será criado.

📄 Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
name	string	Máx. 191 caracteres	Sim	Nome do evento.
description	string	Formato HTML	Não	Descrição do evento no formato HTML presente na página do evento
dateStart	string (datetime)	Formato: `YYYY-MM-DD HH:mm`	Sim	Data e hora de início do evento.
dateEnd	string (datetime)	Formato: `YYYY-MM-DD HH:mm`	Sim	Data e hora de término do evento.
idEventCategory	integer	ID da categoria do evento	Sim	Categoria do evento (buscar via endpoint de categorias, se existir).
logo	string (base64)	Base64 da imagem. Formato permitido: jpeg, png, jpg, webp	Não	Logo do evento, enviado em formato base64.

🏢 address (Objeto obrigatório)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Regras	Obrigatório	Descrição
cep	string	Exatamente 8 caracteres	Sim	CEP do endereço
state	integer	ID do estado (`GET /states`)	Sim	Código do estado
city	integer	ID da cidade (`GET /cities/{idState}`)	Sim	Código da cidade
district	string	Máx. 191 caracteres	Sim	Bairro
address	string	Máx. 191 caracteres	Sim	Rua ou avenida
number	string	Máx. 20 caracteres	Sim	Número do imóvel
complement	string	Máx. 191 caracteres	Não	Complemento, como sala, bloco, etc.
local	string	Máx. 191 caracteres	Não	Informações adicionais do local, ex.: auditório, setor.

🔍 Observações Importantes

As taxas do evento serão de acordo com as taxas do business anteriormente cadastrado

Hello World

\",\r\n \"alias\": \"teste-evento-20-12-2025\",\r\n \"selling_tickets_fee_percentage_value\": \"5.00\",\r\n \"selling_tickets_fee_value\": \"0.50\",\r\n \"dateStart\": \"2025-12-20 20:00\",\r\n \"dateEnd\": \"2025-12-21 00:00\",\r\n \"logo\": \"images/event/banner_1750508209.png\",\r\n \"status\": \"Pendente\",\r\n \"accepted_terms_of_use\": 0,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T12:16:49.000000Z\",\r\n \"deleted_at\": null,\r\n \"address\": {\r\n \"id\": 18,\r\n \"cep\": \"01001000\",\r\n \"id_state\": 1,\r\n \"id_city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"deleted_at\": null,\r\n \"city\": {\r\n \"id\": 1,\r\n \"id_state\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acrelândia\"\r\n },\r\n \"state\": {\r\n \"id\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acre\"\r\n }\r\n },\r\n \"category\": {\r\n \"id\": 1,\r\n \"name\": \"Outros\",\r\n \"iconPath\": null,\r\n \"alias\": \"\",\r\n \"status\": \"Ativo\",\r\n \"created_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"updated_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n}"}],"_postman_id":"42312715-0417-465b-a061-38087fa431eb"},{"name":"Get Event By ID","id":"f083e700-cca2-40b7-83af-c778c33110fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"access-token","value":"BUSINESS_API_KEY"},{"key":"Accept","value":"application/json"}],"url":"https://sandbox.vaideticket.com.br/api/v1/event/1","description":"

Buscar Dados do evento

Este endpoint permite consultar os dados completos de uma evento vinculada ao access_token informado.

Hello World

\",\r\n \"alias\": \"teste-evento-20-12-2025\",\r\n \"selling_tickets_fee_percentage_value\": \"5.00\",\r\n \"selling_tickets_fee_value\": \"0.50\",\r\n \"dateStart\": \"2025-12-20 20:00:00\",\r\n \"dateEnd\": \"2025-12-21 00:00:00\",\r\n \"logo\": \"images/event/banner_1750508209.png\",\r\n \"status\": \"Pendente\",\r\n \"accepted_terms_of_use\": 0,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T12:16:49.000000Z\",\r\n \"deleted_at\": null,\r\n \"address\": {\r\n \"id\": 18,\r\n \"cep\": \"01001000\",\r\n \"id_state\": 1,\r\n \"id_city\": 1,\r\n \"district\": \"Centro\",\r\n \"address\": \"Rua Teste\",\r\n \"number\": \"123\",\r\n \"complement\": \"Sala 1\",\r\n \"local\": null,\r\n \"created_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"updated_at\": \"2025-06-21T11:22:26.000000Z\",\r\n \"deleted_at\": null,\r\n \"city\": {\r\n \"id\": 1,\r\n \"id_state\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acrelândia\"\r\n },\r\n \"state\": {\r\n \"id\": 1,\r\n \"uf\": \"AC\",\r\n \"name\": \"Acre\"\r\n }\r\n },\r\n \"category\": {\r\n \"id\": 1,\r\n \"name\": \"Outros\",\r\n \"iconPath\": null,\r\n \"alias\": \"\",\r\n \"status\": \"Ativo\",\r\n \"created_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"updated_at\": \"2025-04-11T14:14:51.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n}"}],"_postman_id":"f083e700-cca2-40b7-83af-c778c33110fd"},{"name":"Get Event Categories","id":"90e1be68-870b-42eb-bc82-135ce24df257","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.vaideticket.com.br/api/v1/event/categories","description":"

Listar Categorias de Eventos

Este endpoint retorna a lista de categorias de eventos disponíveis no sistema.

Endpoint

GET /event/categories\n\n

Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.

⚠️ Este endpoint não exige o envio do access_token, pois não está vinculado a uma empresa específica.

Funcionamento

Ao realizar a requisição, o sistema retornará uma lista de categorias de eventos. A resposta será uma matriz de objetos, onde cada objeto representa uma categoria de evento com as seguintes propriedades:

id: Identificador único da categoria.
\n
name: Nome da categoria.
\n
iconPath: Caminho do ícone associado à categoria (pode ser nulo).
\n
alias: Alias da categoria.
\n
status: Status da categoria.
\n
created_at: Data de criação da categoria.
\n
updated_at: Data da última atualização da categoria.
\n
deleted_at: Data de exclusão da categoria (pode ser nulo).
\n

Esses dados podem ser utilizados para categorizar eventos dentro do sistema.

🔔 Solicitar Liberação de Pedido Abaixo de R$5

Este endpoint deve ser utilizado exclusivamente para pedidos com valor inferior a R$ 5,00. Ele envia uma notificação para a equipe da plataforma autorizar manualmente a liberação do pedido.

🔗 Endpoint

POST /api/order/{idOrder}/release-order\n\n

Parâmetro de rota:
idOrder (obrigatório): ID do pedido que precisa de liberação.

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT no formato `Bearer`. Representa o integrador autenticado.
`access_token`	API Key da empresa. Identifica o business ao qual o pedido pertence.

📄 Request Body

Este endpoint não requer corpo (body). Apenas os headers e o ID do pedido são necessários.

📌 Fluxo sugerido de uso

💰 Verifique o valor total do pedido:
\n
- Se < R$ 5,00, chame este endpoint após realizar o PIX para conta enviada ao gerar o pedido de envio de ingressos.
  \n
- Se ≥ R$ 5,00, prossiga com o fluxo normal de pagamento/liberação.
  \n
\n
⏳ Aguarde a liberação pela equipe.
\n
✅ Após liberação, o pedido será atualizado automaticamente para o próximo passo no sistema.
\n

📦 Consultar Pedido por ID

Este endpoint permite recuperar todos os dados de um pedido específico com base no seu ID.

🔗 Endpoint

GET /api/order/{idOrder}\n\n

Parâmetro de rota:
idOrder (obrigatório): ID do pedido que será consultado.

🔐 Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT no formato `Bearer`. Representa o integrador autenticado.
`access_token`	API Key da empresa. Identifica o business ao qual o pedido pertence.

📄 Request Body

Este endpoint não requer corpo (body). Apenas os headers e o ID do pedido na URL são necessários.

🔍 Observações Importantes

🔐 O pedido só será retornado se pertencer ao integrador (Bearer Token) e à empresa (access_token) informados.
\n
🧾 A resposta inclui as informações para pagamento e status atual dos ingressos pendentes.
\n

Listar Cidades por Estado

Este endpoint retorna a lista de cidades disponíveis de acordo com o estado informado.

Endpoint

GET/cities/{idState}\n\n

Parâmetro de rota:
idState (obrigatório): o ID do estado (conforme retornado pelo endpoint /api/states)

Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.

⚠️ Este endpoint não exige o envio do access_token, pois não está vinculado a uma empresa específica.

Funcionamento

Ao informar o idState, o sistema retornará a lista de cidades correspondentes àquele estado. Esses dados devem ser utilizados para preencher o campo city no endereço da empresa.

Listar Estados Disponíveis

Este endpoint retorna a lista de estados disponíveis para cadastro de empresas no sistema.

Endpoint

GET/states\n\n

Headers obrigatórios

\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Descrição
`Authorization`	Token JWT de autenticação no formato `Bearer`. Representa o integrador.

⚠️ Este endpoint não exige o envio do access_token, pois não está vinculado a uma empresa específica.

Funcionamento

A requisição retorna uma lista de estados com seus respectivos códigos, siglas e nomes. Esses dados devem ser utilizados no cadastro de endereços de empresas.