> For the complete documentation index, see [llms.txt](https://documentation.themembers.dev.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.themembers.dev.br/webhooks/webhooks-do-checkout/estrutura-dos-webhooks/webhook-de-acesso.md).
# Webhook de acesso
Este webhook é disparado sempre que uma compra é aprovada ou cancelada. Ele é utilizado para gerenciar automaticamente o acesso do cliente à plataforma, permitindo a liberação do acesso em casos de aprovação e a remoção do acesso quando ocorre o cancelamento.
### Eventos
* revoke.access
* release.access
### Payload de exemplo
```json
{
"company": {
"id": "7268299385367167832",
"name": "company",
"email": "company.test@email.com",
"phone": "+55 11999999999",
"document_type": "cnpj",
"document_number": "00000000000000",
"owner": {
"id": "7268299385346197469",
"name": "Lucas da Silva",
"email": "lucas@company.com",
"phone": "+5511999999999",
"document_type": "cpf",
"document_number": "00000000000"
}
},
"payload": {
"id": "7407682939998804964",
"object": "order",
"event": "release.access",
"data": {
"status": "paid",
"customer": {
"id": "7394310639977632991",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"product": {
"id": "7338938162967740629",
"name": "Produto 1",
"price": 10000,
"quantity": 1,
"expires_in": "2026-01-08 18:32:19",
"reference_id": "2931346b-a686-4816-8f64-b476a669ea01",
"platform": {
"id": "7268292516695246618",
"name": "Company plataforma"
}
},
"order": {
"id": "7407682939998804964",
"total": 10000,
"transaction": {
"paid_at": "2026-01-08 18:32:19",
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 11196,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "VISA",
"last_digit": "1234"
}
}
}
}
}
}
```
### Detalhes
####  company
Dados da empresa responsável pelo produto ou serviço.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ---------------------------------------------------- |
| id | string | Sim | Id da empresa |
| name | string | Sim | Nome da empresa |
| email | string | Sim | E-mail de contato da empresa |
| phone | string \| null | Não | Telefone de contato |
| document\_type | string | Sim | Tipo de documento (
cpf
ou
cnpj
)
|
| document\_number | string | Sim | Número do documento da empresa |
| owner | object | Sim | Dados do proprietário |
####  company.owner
Dados do proprietário (responsável legal da empresa).
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ---------------------------------------------------- |
| id | string | Sim | Id |
| name | string | Sim | Nome completo |
| email | string | Sim | E-mail de contato |
| phone | string \| null | Não | Telefone |
| document\_type | string | Sim | Tipo de documento (
cpf
ou
cnpj
)
|
| document\_number | string | Sim | Número do documento |
####  payload
Informações principais do evento de acesso.
| Campo | Tipo | Obrigatório | Descrição |
| ------ | ------ | ----------- | ----------------------------------------------------------------- |
| id | string | Sim | Id |
| object | string | Sim | Tipo do objeto relacionado ao evento. Valor fixo:
order
|
| event | string | Sim | Evento disparado. Exemplo:
release.access
|
####  payload.data
Dados específicos relacionados ao acesso.
| Campo | Tipo | Obrigatório | Descrição |
| -------- | ------ | ----------- | ------------------------------------------------------------------- |
| status | string | Sim | Status atual do pedido (
paid
,
canceled
, etc.)
|
| customer | object | Sim | Dados do cliente |
| product | object | Sim | Dados do produto |
| order | object | Sim | Dados do pedido |
####  payload.data.customer
Dados do cliente.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ---------------------------------------------------- |
| id | string | Sim | Id do cliente |
| name | string | Sim | Nome completo |
| email | string | Sim | E-mail do cliente |
| phone\_country | string \| null | Não | Código do país do telefone |
| phone | string \| null | Não | Telefone do cliente |
| document\_type | string \| null | Não | Tipo de documento (
cpf
ou
cnpj
)
|
| document\_number | string \| null | Não | Número do documento |
####  payload.data.product
Dados do produto adquirido.
| Campo | Tipo | Obrigatório | Descrição |
| ------------- | ----------------- | ----------- | -------------------------------------- |
| id | string | Sim | Id do produto |
| name | string | Sim | Nome do produto |
| price | integer | Sim | Valor do produto (em centavos) |
| quantity | integer | Sim | Quantidade adquirida |
| expires\_in | string (datetime) | Sim | Data de expiração do acesso |
| reference\_id | string | Sim | Id externo do produto |
| platform | object | Sim | Plataforma onde o acesso será liberado |
####  payload.data.product.platform
Dados da plataforma de acesso.
| Campo | Tipo | Obrigatório | Descrição |
| ----- | ------ | ----------- | ------------------ |
| id | string | Sim | Id da plataforma |
| name | string | Sim | Nome da plataforma |
####  payload.data.order
Informações do pedido associado.
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ------ | ----------- | ----------------------------------- |
| id | string | Sim | Identificador do pedido |
| total | number | Sim | Valor total do pedido (em centavos) |
| transaction | object | Sim | Dados da transação |
####  payload.data.order.transaction
Detalhes da transação de pagamento.
| Campo | Tipo | Obrigatório | Descrição |
| --------------- | ----------------- | ----------- | ---------------------------------------------------------------------------------- |
| paid\_at | string (datetime) | Sim | Data e hora do pagamento |
| payment\_method | string | Sim | Método de pagamento (
credit\_card
,
pix
,
boleto
, etc.)
|
| instalments | integer | Sim | Número de parcelas |
| currency | string | Sim | Moeda da transação |
| value | integer | Sim | Valor pago (em centavos) |
| status | string | Sim | Status da transação |
| credit\_card | object \| null | Não | Dados do cartão de crédito |
| pix | object \| null | Não | Dados do pix |
| boleto | object \| null | Não | Dados do boleto |
####  payload.data.order.transaction.credit\_card
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ------ | ----------- | ------------------------- |
| instalments | number | Sim | Número de parcelas |
| brand | string | Sim | Bandeira do cartão |
| last\_digit | string | Sim | Últimos dígitos do cartão |
####  payload.data.order.transaction.pix
| Campo | Tipo | Obrigatório | Descrição |
| ------------ | ------ | ----------- | ------------------------------- |
| qrcode\_url | string | Sim | url do com o pix para pagamento |
| qrcode\_data | string | Sim | código do pix copia e cola |
| expiration | number | Sim | data de expiração |
####  payload.data.order.transaction.boleto
| Campo | Tipo | Obrigatório | Descrição |
| ------------- | ------ | ----------- | ------------------------------- |
| barcode\_url | string | Sim | url do boleto para impressao |
| barcode\_data | string | Sim | código de barras para pagamento |
| expiration | string | Sim | data de expiração |