Com esta rota de API, você poderá enviar Push Notifications para um grupo de alunos que possuem assinaturas nos mesmos produtos.
**Headers**
| Name | Value |
| ------------ | ------------------ |
| Content-Type | `application/json` |
| Accept | `application/json` |
**Body**
| Name | Type | Description |
|---|
| title | string | Titulo do Push Notification |
| body | string | Mensagem do Push Notification |
| product_ids | array | Um ou mais IDs de produto |
| developer_token | string | token_do_desenvolvedor |
| platform_token | string | token_da_plataforma |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"message": "Push notification sent successfully"
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Bad Request"
}
```
{% endtab %}
{% endtabs %}
# Webhooks da Área de Membros
Este documento descreve como integrar e consumir os webhooks enviados pela plataforma TheMembers. Os webhooks permitem que sistemas de clientes recebam notificações em tempo real sobre eventos relevantes, como conclusão de aulas, emissão de certificados, publicação de conteúdo e inatividade de usuários.
***
## Visão Geral
A plataforma TheMembers envia requisições HTTP POST para os endpoints de webhook registrados pelos clientes sempre que determinados eventos ocorrem. O payload enviado está no formato JSON e contém informações detalhadas sobre o evento.
Características principais:
* Protocolo: HTTP POST
* Formato: JSON
* Autenticação: HMAC-SHA256
* Timeout: 30 segundos
* Tentativas: Até 3 tentativas em caso de falha
* Intervalo entre tentativas: 30s, 60s, 120s
***
## Autenticação e Segurança
Cada requisição enviada para o webhook do cliente contém um cabeçalho de autenticação HMAC para garantir a integridade e autenticidade dos dados:
* Cabeçalho: X-Webhook-Signature
* Valor: Assinatura HMAC-SHA256 do corpo da requisição, usando o client\_token do cliente
* Cabeçalho adicional: X-Webhook-Event — Nome do evento disparado
Como validar:
1. Calcule o HMAC-SHA256 do corpo da requisição recebida (JSON bruto, sem formatação extra) usando seu client\_token como chave.
Importante: O JSON é serializado usando as seguintes regras:
* Barras / não são escapadas (sem \\/)
* Caracteres Unicode não são escapados (ex: á ao invés de \u00e1)
2. Certifique-se de que sua serialização JSON corresponda a esse comportamento.
3. Codifique o resultado em hexadecimal (hash\_hmac com raw\_output = false).
4. Compare com o valor do cabeçalho X-Webhook-Signature.
{% hint style="info" %}
A assinatura só corresponderá se o JSON for serializado exatamente conforme as regras acima (sem barras ou unicode escapados).
{% endhint %}
Exemplo em PHP:
{% code title="webhook-validate.php" %}
```php
{
req.rawBody = buf.toString('utf8');
}
}));
app.post('/webhook', (req, res) => {
const clientToken = 'seu_client_token_aqui';
const providedSignature = req.headers['x-webhook-signature'];
const expectedSignature = crypto
.createHmac('sha256', clientToken)
.update(req.rawBody)
.digest('hex');
if (expectedSignature !== providedSignature) {
return res.status(401).send('Assinatura inválida');
}
// Processar o payload
const payload = req.body;
console.log('Evento recebido:', payload.event);
res.status(200).send('OK');
});
app.listen(3000, () => {
console.log('Servidor webhook rodando na porta 3000');
});
```
{% endcode %}
***
## Exemplo de Assinatura
Abaixo está um exemplo de corpo de requisição de webhook e o valor esperado para o cabeçalho X-Webhook-Signature, assumindo que o client\_token seja mySecretKey123.
Corpo da Requisição de Exemplo:
```json
{
"type": "class_history",
"event": "class.completed",
"created": "2025-01-13T14:30:00.000000Z",
"data": {
"datetime": "2025-01-13T14:25:00.000000Z",
"platform_id": 1,
"platform_name": "Minha Plataforma",
"student": {
"id": 12345,
"reference_id": "EXT-001",
"name": "João da Silva",
"email": "joao@exemplo.com",
"phone": "+5511999999999",
"document": "12345678900",
"gender": "male"
},
"course": {
"id": 100,
"name": "Curso de Programação",
"module": {
"id": 10,
"name": "Módulo 1 - Fundamentos",
"class": {
"id": 1,
"name": "Introdução ao PHP"
}
}
}
}
}
```
Assinatura Esperada
Para o corpo acima e client\_token mySecretKey123, o valor do cabeçalho X-Webhook-Signature será (exemplo ilustrativo):
4a3d8c1e2f5b6a7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c
Nota: A assinatura acima é ilustrativa. O valor real dependerá da serialização exata do JSON e da chave secreta.
Importante: A assinatura só corresponderá se o JSON for serializado exatamente como acima, sem barras ou unicode escapados.
***
## Eventos Enviados
{% stepper %}
{% step %}
### Conclusão de Aula (class.completed)
Enviado quando um aluno conclui uma aula (progresso = 100% ou marcada como finalizada).
* Tipo de Evento: class.completed
* Tipo de Payload: class\_history
Exemplo de Payload:
```json
{
"type": "class_history",
"event": "class.completed",
"created": "2025-01-13T14:30:00.000000Z",
"data": {
"datetime": "2025-01-13T14:25:00.000000Z",
"platform_id": 1,
"platform_name": "Minha Plataforma",
"student": {
"id": 12345,
"reference_id": "EXT-001",
"name": "João da Silva",
"email": "joao@exemplo.com",
"phone": "+5511999999999",
"document": "12345678900",
"gender": "male"
},
"course": {
"id": 100,
"name": "Curso de Programação",
"module": {
"id": 10,
"name": "Módulo 1 - Fundamentos",
"class": {
"id": 1,
"name": "Introdução ao PHP"
}
}
}
}
}
```
Campos principais:
* type (string): Tipo do payload, sempre class\_history para este evento
* event (string): Nome do evento, sempre class.completed
* created (string): Data/hora de criação do evento (ISO 8601)
* data (object): Dados do evento, incluindo:
* datetime (string): Data/hora em que a aula foi concluída (ISO 8601)
* platform\_id (integer)
* platform\_name (string)
* student (object): id, reference\_id, name, email, phone, document, gender
* course (object): id, name, module (com id, name, class com id e name)
{% endstep %}
{% step %}
### Publicação de Aula (class.published)
Enviado quando uma nova aula é publicada na plataforma (no momento da criação ou publicação manual).
* Tipo de Evento: class.published
* Tipo de Payload: class
Exemplo de Payload:
```json
{
"type": "class",
"event": "class.published",
"created": "2025-01-13T14:30:00.000000Z",
"data": {
"datetime": "2025-01-13T14:30:00.000000Z",
"platform_id": 1,
"platform_name": "Minha Plataforma",
"course": {
"id": 100,
"name": "Curso de Programação",
"module": {
"id": 10,
"name": "Módulo 1 - Fundamentos",
"class": {
"id": 1,
"name": "Introdução ao PHP"
}
}
}
}
}
```
Campos principais:
* type (string): Tipo do payload, sempre class para este evento
* event (string): Nome do evento, sempre class.published
* created (string): Data/hora de criação do evento (ISO 8601)
* data (object): Inclui datetime, platform\_id, platform\_name, course (id, name, status, module com id, name, status, class com id e name)
{% endstep %}
{% step %}
### Certificado Emitido (certificate.issued)
Enviado quando um certificado é emitido para um aluno.
* Tipo de Evento: certificate.issued
* Tipo de Payload: certificate
Exemplo de Payload:
```json
{
"type": "certificate",
"event": "certificate.issued",
"created": "2025-01-13T14:30:00.000000Z",
"data": {
"datetime": "2025-01-13T14:30:00.000000Z",
"platform_id": 1,
"platform_name": "Minha Plataforma",
"student": {
"id": 12345,
"reference_id": "EXT-001",
"name": "João da Silva",
"email": "joao@exemplo.com",
"phone": "+5511999999999",
"document": "12345678900",
"gender": "male"
},
"course": {
"id": 100,
"name": "Curso de Programação"
},
"certificate": {
"id": 50,
"name": "Certificado de Conclusão"
}
}
}
```
Campos principais:
* type (string): Tipo do payload, sempre certificate para este evento
* event (string): Nome do evento, sempre certificate.issued
* created (string): Data/hora de criação do evento (ISO 8601)
* data (object): Inclui datetime, platform\_id, platform\_name, student (id, reference\_id, name, email, phone, document, gender), course (id, name), certificate (id, name)
{% endstep %}
{% step %}
### Usuário Inativo por 7 Dias (user.inactive\_for\_7\_days)
Enviado quando um usuário está inativo por exatamente 7 dias (sem login nos últimos 7 dias ou sem login desde a criação da conta).
Observação: Usuários inativos que permanecem inativos continuarão recebendo este evento a cada 7 dias.
* Tipo de Evento: user.inactive\_for\_7\_days
* Tipo de Payload: login\_history
Exemplo de Payload:
```json
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "login_history",
"event": "user.inactive_for_7_days",
"created": "2025-01-13T14:30:00.000000Z",
"data": {
"datetime": "2025-01-06T14:30:00.000000Z",
"inactive_days": 7,
"platform_id": 1,
"platform_name": "Minha Plataforma",
"student": {
"id": 12345,
"reference_id": "EXT-001",
"name": "João da Silva",
"email": "joao@exemplo.com",
"phone": "+5511999999999",
"document": "12345678900",
"gender": "female"
}
}
}
```
Campos principais:
* id (string): UUID único do evento
* type (string): Tipo do payload, sempre login\_history para este evento
* event (string): Nome do evento, sempre user.inactive\_for\_7\_days
* created (string): Data/hora de criação do evento (ISO 8601)
* data (object): Inclui datetime, inactive\_days, platform\_id, platform\_name, student (id, reference\_id, name, email, phone, document, gender)
{% endstep %}
{% endstepper %}
***
## Formato do Payload
* Todas as requisições são enviadas com o cabeçalho Content-Type: application/json
* Campos de data/hora seguem o padrão ISO 8601 (ex: 2025-01-13T14:30:00.000000Z)
* Campos podem conter valores null quando não aplicável
* O telefone é formatado no padrão E.164 quando disponível (ex: +5511999999999)
* Documentos (CPF/CNPJ) são retornados apenas com números, sem formatação
***
## Boas Práticas e Observações
Segurança
* Sempre valide a assinatura HMAC antes de processar o payload
* Mantenha seu client\_token seguro e não o compartilhe
* O client\_token é único para cada URL de webhook registrado
* Use HTTPS em seu endpoint de webhook
Resposta
* Responda rapidamente com HTTP 200 para evitar reenvio do evento
* Processe o evento de forma assíncrona se necessário
* Não execute operações demoradas na thread principal
Confiabilidade
* Implemente idempotência - o mesmo evento pode ser enviado mais de uma vez
* Registre logs de eventos recebidos para facilitar troubleshooting
* O endpoint deve estar disponível publicamente e aceitar requisições HTTPS
Tratamento de Erros
* Em caso de falha no envio, o sistema tentará reenviar o evento até 3 vezes
* Intervalos entre tentativas: 30s, 60s, 120s
* Após 3 falhas, o evento será marcado como falho e não será reenviado
Timeout
* O timeout da requisição é de 30 segundos
* Certifique-se de que seu endpoint responda dentro desse tempo
Performance
* O webhook pode receber múltiplos eventos em sequência
* Processe cada evento de forma independente e idempotente
* Considere usar filas para processar eventos de forma assíncrona
# Webhooks do Checkout
[https://dashboard.themembers.com.br](https://dashboard.themembers.com.br/)
Para realizar a configuração, acesse o caminho:
Checkout → Ferramentas → Webhooks
{% stepper %}
{% step %}
### Definir o nome do webhook
Nome descritivo para identificar o webhook.
{% endstep %}
{% step %}
### Informar a URL de destino
URL que receberá os eventos enviados pela plataforma.
{% endstep %}
{% step %}
### Selecionar os produtos
Escolha os produtos que deverão disparar notificações para esse webhook.
{% endstep %}
{% step %}
### Selecionar os eventos
Defina quais eventos serão enviados para a URL informada.
{% endstep %}
{% step %}
### Configurar o token de segurança
Token utilizado para validação da origem das requisições.
{% endstep %}
{% endstepper %}
Após a configuração, a plataforma passará a enviar automaticamente os eventos selecionados para a URL informada sempre que ocorrerem ações relacionadas aos produtos configurados.
{% hint style="info" %}
Observações importantes
* Todos os valores monetários estão em centavos
* Datas seguem o padrão YYYY-MM-DD HH:MM:SS
* Campos podem retornar `null` quando não aplicável
{% endhint %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/b81b773b333dfb033326287953b4a1e8c594fdc7" %}
[Eventos de webhook](/webhooks/webhooks-do-checkout/eventos-de-webhook)
{% endcontent-ref %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/beac88ea3788736eda978cf6ae18d2f6e9ab02f9" %}
[Segurança](/webhooks/webhooks-do-checkout/seguranca)
{% endcontent-ref %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/2e2d65fd7b442c40aaeb5bf48a6d0d4751855cc6" %}
[Estrutura dos webhooks](/webhooks/webhooks-do-checkout/estrutura-dos-webhooks)
{% endcontent-ref %}
# Eventos de webhook
Abaixo estão listados os eventos disparados.
### Eventos de pedido
* `order.canceled` — Pedido cancelado
* `order.expired` — Pedido expirado
* `order.completed` — Pedido concluído
### Eventos de transação
* `transaction.approved` — Pedido aprovado
* `transaction.failed` — Pedido reprovado
* `transaction.refunded` — Pedido Reembolsado
* `transaction.charged\_back` — Chargeback de pedido
* `transaction.pending_refund` — Pedido com reembolso pendente
* `transaction.payment_cc_initiated` — Pagamento com cartão de crédito iniciado
* `transaction.pix_generated` — Pix gerado
* `transaction.boleto_generated` — Boleto gerado
### Eventos de acesso
* `release.access` — Liberar Acesso
* `revoke.access` — Revogar Acesso
### Eventos de compra
* `abandoned` — Abandono de carrinho
# Segurança
## **🔐 Validação de Assinatura de Webhooks**
Para garantir a **autenticidade** e a **integridade** das notificações enviadas pelo nosso sistema, todos os webhooks são assinados utilizando um segredo compartilhado (*webhook secret*), que realiza a assinatura do payload via HMAC SHA-256.
#### **📌 Como funciona**
Cada requisição enviada contém:
* O **payload** (corpo da requisição)
* Um header HTTP:
```
X-Signature: {assinatura}
```
Essa assinatura é gerada aplicando um **HMAC SHA-256** sobre o payload bruto utilizando o *token de segurança* configurado:
***
#### **🎯 Objetivo da validação**
O sistema receptor deve validar a assinatura para garantir:
* ✔️ Que o payload **não foi alterado** (integridade)
* ✔️ Que a requisição foi **enviada por um remetente confiável** (autenticidade)
* ✔️ Que a comunicação é **segura contra ataques de replay ou spoofing**
***
### **⚙️ Passo a passo para validação**
Ao receber o webhook, seu sistema deve:
1. **Ler o payload bruto da requisição**
* Importante: não utilize payload já parseado (ex: JSON decodificado)
2. **Obter o header `X-Signature`**
3. **Gerar uma nova assinatura localmente**
* Utilizando:
* O payload bruto
* O *secret* compartilhado
4. **Comparar as assinaturas**
* Utilize comparação segura (*timing-safe comparison*)
5. **Rejeitar a requisição caso a assinatura seja inválida**
* Retorne HTTP `403 Forbidden`
***
### **💻 Exemplo em PHP (Laravel)**
```php
$newPayload = json_encode(
json_decode(trim($payload)),
JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES
);
$expectedSignature = hash_hmac(
'sha256',
$webhookURL . ':' . $newPayload,
$secret
);
```
### **💻 Exemplo em NodeJS**
```javascript
const normalizedPayload = JSON.stringify(JSON.parse(req.body.toString('utf8')));
const data = `${webhookUrl}:${normalizedPayload}`;
const receivedSignature = req.headers['x-signature'];
const expected = crypto
.createHmac('sha256', secret)
.update(data, 'utf8')
.digest('hex');
if (expected.length !== receivedSignature.length) {
return false;
}
return crypto.timingSafeEqual(
Buffer.from(expected, 'utf8'),
Buffer.from(receivedSignature, 'utf8'),
);
```
***
### ⚠️ Boas práticas (importante)
#### 1. Use sempre o payload bruto
Qualquer transformação (ex: `json_decode` → `json_encode`) pode invalidar a assinatura.
***
#### 2. Nunca use comparação simples (`===`)
Utilize sempre:
```
hash_equals()
```
***
#### 3. Proteja seu webhook secret
* Nunca exponha no frontend
* Armazene em variáveis de ambiente seguras
***
#### 4. Valide antes de processar
A validação da assinatura deve ser o **primeiro passo** antes de qualquer lógica de negócio
# Estrutura dos webhooks
### Estrutura do webhook
{% code title="webhook.json" overflow="wrap" lineNumbers="true" expandable="true" %}
```json
{
"webhookUrl": "https://hook.us2.make.com/",
"httpVerb": "post",
"proxy": null,
"tries": 3,
"requestTimeout": 3,
"cert": null,
"certPassphrase": null,
"sslKey": null,
"sslKeyPassphrase": null,
"backoffStrategyClass": "BackoffStrategy",
"signerClass": null,
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"x-signature": "{token}"
},
"verifySsl": true,
"throwExceptionOnFailure": false,
"queue": "queue",
"payload": {
...
},
"meta": [],
"tags": {
"event": "order.completed",
"relay": true
},
"uuid": "13ad0881-4756-402a-b3c3-3c10c9825f95",
"outputType": "JSON",
"response": null,
"errorType": null,
"errorMessage": null,
"transferStats": null,
"job": null,
"connection": null,
"delay": null,
"afterCommit": null,
"middleware": [],
"chained": [],
"chainConnection": null,
"chainQueue": null,
"chainCatchCallbacks": null
}
```
{% endcode %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/a1140aaaec16c2058cd8a92b83482cd3daee7d1a" %}
[Webhook de carrinho abandonado](/webhooks/webhooks-do-checkout/estrutura-dos-webhooks/webhook-de-carrinho-abandonado)
{% endcontent-ref %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/36a33166866b3f6f47deb13cbbf149b93fad50f3" %}
[Webhook de acesso](/webhooks/webhooks-do-checkout/estrutura-dos-webhooks/webhook-de-acesso)
{% endcontent-ref %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/76f027b216f03da1558750fbd3e33d53b275b166" %}
[Webhook de Pedido](/webhooks/webhooks-do-checkout/estrutura-dos-webhooks/webhook-de-pedido)
{% endcontent-ref %}
{% content-ref url="/spaces/mbuonzfEbI223CTyjCzW/pages/0ebfeb8231647b643b6508580e661e29c32f9a90" %}
[Webhook de Transação](/webhooks/webhooks-do-checkout/estrutura-dos-webhooks/webhook-de-transacao)
{% endcontent-ref %}
# Webhook de carrinho abandonado
Este webhook é disparado sempre que um carrinho de compras é identificado como abandonado. Ele permite que sistemas integrados sejam notificados automaticamente para ações como recuperação de vendas, envio de comunicações ao cliente ou análises de comportamento.
### Evento
abandoned
### Payload
```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": "712",
"object": "shopping_cart",
"event": "abandoned",
"created_at": "2026-01-07 18:17:08",
"data": {
"products": [
{
"product_id": "2931346b-a686-4816-8f64-b476a669ea01",
"product_name": "Produto 1",
"category": "oneoff",
"price": 100
}
],
"customer": {
"name": null,
"cpf": null,
"email": "cliente@example.com",
"phone": null
},
"checkout": {
"checkout_link": "https://checkout.thebank.com.br/pt-BR/7338938162967740000"
}
}
}
}
```
### Detalhes
 company
Dados da empresa.
| 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 responsável legal da empresa.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ---------------------------------------------------- |
| id | string | Sim | Id do proprietário |
| 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 carrinho abandonado.
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ----------------- | ----------- | ------------------------------------------------------------------ |
| id | string | Sim | Id do utm |
| object | string | Sim | Tipo do objeto relacionado ao evento. Ex:
shopping\_cart
|
| event | string | Sim | Evento disparado. (
abandoned
)
|
| created\_at | string (datetime) | Sim | Data e hora em que o evento foi gerado |
| data | object | Sim | Dados específicos do carrinho abandonado. |
 payload.data
Dados específicos do carrinho abandonado.
| Campo | Tipo | Obrigatório | Descrição |
| -------- | ------ | ----------- | ---------------------------------------- |
| products | object | Sim | Lista de produtos presentes no carrinho. |
| customer | object | Sim | Dados do cliente (quando disponíveis). |
| checkout | object | Sim | Informações de acesso ao checkout. |
 payload.data.products
Lista de produtos presentes no carrinho.
| Campo | Tipo | Obrigatório | Descrição |
| ------------- | ------ | ----------- | ----------------------------------------------------------------------- |
| product\_id | string | Sim | Identificador do produto |
| product\_name | string | Sim | Nome do produto |
| category | string | Sim | Categoria do produto (
oneoff
,
subscription
, etc.)
|
| price | number | Sim | Valor do produto (em centavos) |
 payload.data.customer
Dados do cliente (quando disponíveis).
| Campo | Tipo | Obrigatório | Descrição |
| ----- | ------ | ----------- | ---------------------------- |
| name | string | Não | Nome do cliente |
| cpf | string | Não | CPF do cliente |
| email | string | Não | E-mail informado no checkout |
| phone | string | Não | Telefone do cliente |
{% hint style="warning" %}
Alguns campos podem ser null caso o cliente não tenha finalizado o preenchimento dos dados no checkout.
{% endhint %}
 payload.data.checkout
Informações de acesso ao checkout.
| Campo | Tipo | Obrigatório | Descrição |
| -------------- | ------------ | ----------- | ------------------------------------------------- |
| checkout\_link | string (URL) | Sim | Link do checkout associado ao carrinho abandonado |
# 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 |
# Webhook de Pedido
Este webhook é enviado sempre que ocorre uma operação relacionada a um pedido na plataforma. Ele é disparado automaticamente a cada evento associado ao ciclo de vida do pedido, permitindo que sistemas integrados acompanhem e processem alterações de status em tempo real.
### Eventos
* order.canceled
* order.expired
* order.completed
### Payload de exemplo
{% code title="payload.json" %}
```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": {
"object": "order",
"event": "order.completed",
"created_at": "2026-01-07 15:08:42",
"data": {
"customer": {
"id": "7407269030890449654",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"main_product": {
"id": 7338938162967740000,
"title": "Produto 1",
"price": 10000
},
"order_bump": [
{
"product_id": 7338938162967740000,
"title": "Produto 1",
"price": 10000,
"order_bump": true
}
],
"transactions": [
{
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 11400,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "VISA",
"last_digit": "1234"
}
}
],
"utms": []
}
}
}
```
{% endcode %}
### Detalhes
| Campo | Tipo | Descrição |
| ------- | ------ | --------------------------------------------- |
| company | object | Informações da empresa responsável pela venda |
| payload | object | Dados do evento disparado |
#### 🏢 company
Dados da empresa (organização) proprietária do pedido.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | -------------------------------- |
| id | string | Sim | Id da empresa |
| name | string | Sim | Nome da empresa |
| email | string \| null | Não | Email principal da empresa |
| phone | string \| null | Não | Telefone de contato |
| document\_type | string | Sim | Tipo de documento (cnpj ou cpf) |
| document\_number | string | Sim | Número do documento |
| owner | object | Sim | Dados do proprietário da empresa |
#### 👤 company.owner
Dados do proprietário (responsável legal).
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ------------------------------- |
| id | string | Sim | Id do proprietário |
| name | string | Sim | Nome completo |
| email | string | Sim | Email 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 do evento disparado.
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ------ | ----------- | -------------------------------------------- |
| object | string | Sim | Tipo do objeto relacionado ao evento (order) |
| event | string | Sim | Nome do evento (order.completed) |
| created\_at | string | Sim | Data e hora de criação do evento (UTC) |
| data | object | Sim | Dados específicos do pedido |
#### 🧾 payload.data
Dados detalhados do pedido.
| Campo | Tipo | Obrigatório | Descrição |
| ------------- | ------ | ----------- | ----------------------------------------------------- |
| customer | object | Sim | Informações do comprador. |
| main\_product | object | Sim | Produto principal do pedido. |
| order\_bump | object | Sim | Lista de produtos adicionais (order bump). |
| transactions | object | Sim | Lista de transações financeiras associadas ao pedido. |
| utms | array | Sim | Informações de UTM para rastreamento de campanha. |
#### 👤 payload.data.customer
Informações do comprador.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ----------------------------- |
| id | string | Sim | Id do cliente |
| name | string | Sim | Nome completo |
| email | string | Sim | Email 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, cnpj) |
| document\_number | string \| null | Não | Número do documento |
#### 📦 payload.data.main\_product
Produto principal do pedido.
| Campo | Tipo | Obrigatório | Descrição |
| ----- | ------- | ----------- | ---------------------------- |
| id | number | Sim | Id do produto |
| title | string | Sim | Nome do produto |
| price | integer | Sim | Preço do produto em centavos |
#### ➕ payload.data.order\_bump
Lista de produtos adicionais (order bump).
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ------- | ----------- | ------------------------- |
| product\_id | number | Sim | Id do produto |
| title | string | Sim | Nome do produto |
| price | number | Sim | Preço em centavos |
| order\_bump | boolean | Sim | Indica se é um order bump |
{% hint style="info" %}
Pode ser um array vazio caso não existam produtos adicionais.
{% endhint %}
#### 💳 payload.data.transactions
Lista de transações financeiras associadas ao pedido.
| Campo | Tipo | Obrigatório | Descrição |
| --------------- | ------ | ----------- | ----------------------------------------------- |
| payment\_method | string | Sim | Método de pagamento (credit\_card, pix, boleto) |
| instalments | number | Sim | Número de parcelas |
| currency | string | Sim | Moeda da transação (BRL) |
| value | number | Sim | Valor total pago em centavos |
| status | string | Sim | Status da transação (approved, failed, etc.) |
| credit\_card | object | Condicional | Dados do cartão (apenas se método for cartão) |
| pix | object | Condicional | Dados do pix (apenas se método for pix) |
| boleto | object | Condicional | Dados do boleto (apenas se método for boleto) |
#### 💳 payload.data.transactions.credit\_card
Detalhes do cartão de crédito.
| 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 4 dígitos do cartão |
#### 💰 payload.data.transactions.pix
Informações do 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.transactions.boleto
Informações do 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 |
#### 📊 payload.data.utms
Informações de UTM para rastreamento de campanha.
| Campo | Tipo | Obrigatório | Descrição |
| ----- | ----- | ----------- | ---------------------------------------- |
| utms | array | Não | Lista de parâmetros UTM (pode ser vazio) |
# Webhook de Transação
Este webhook é enviado sempre que ocorre uma transação relacionada ao pagamento de um pedido. Ele é disparado tanto para eventos de pagamento concluído quanto para a geração de meios de pagamento, como QR Code de Pix e boleto, permitindo o acompanhamento completo do fluxo de pagamento.
### Eventos
* transaction.approved
* transaction.failed
* transaction.refunded
* transaction.charged\_back
* transaction.pending\_refund
* transaction.payment\_cc\_initiated
* transaction.pix\_generated
* transaction.boleto\_generated
### Payload (produto com assinatura)
```json
{
"object": "transaction",
"event": "transaction.approved",
"created_at": "2026-01-03 08:00:13",
"data": {
"id": 7405759151497423000,
"paid_at": "2026-01-03T11:00:13+00:00",
"status": "approved",
"transaction": {
"currency": "brl",
"amount": 12333,
"buyer_fees": 0,
"total_amount": 12333,
"cupom": ""
},
"payment_details": {
"payment_method": "credit_card",
"credit_card": {
"instalments": 1,
"brand": "discover",
"last_digit": 1234
}
},
"comissions": [],
"order": null,
"subscription": {
"code": "SB1B4H1HJ",
"periodicity": "monthly",
"periodicity_interval": 1,
"price": 12333,
"status": "active",
"started_at": "2025-12-02 20:02:23",
"next_billing_at": "2026-02-02 20:02:23",
"suspended_at": null,
"canceled_at": null,
"created_at": "2025-12-02 20:02:23",
"subscriber": {
"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": 7394309835643586000,
"title": "Produto de assinatura",
"price": 12333
},
"invoice": {
"code": "SBIN1B4H1M1",
"attempts": 2,
"status": "paid",
"paid_at": "2026-01-03 11:00:13",
"refunded_at": null,
"charged_back_at": null,
"billing_date": "2026-01-02 20:02:23",
"created_at": "2026-01-03 11:00:09"
},
"transactions": [
{
"paid_at": "2026-01-03T11:00:13+00:00",
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 12333,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "discover",
"last_digit": 1234
}
},
{
"paid_at": "2026-01-03T11:00:13+00:00",
"payment_method": "credit_card",
"instalments": 1,
"currency": "BRL",
"value": 12333,
"status": "approved",
"credit_card": {
"instalments": 1,
"brand": "discover",
"last_digit": 1234
}
}
]
}
}
}
```
### Payload (produto de venda única)
```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": {
"object": "transaction",
"event": "transaction.approved",
"created_at": "2026-01-02 16:48:57",
"data": {
"id": 7405530052968814000,
"paid_at": "2026-01-02T19:48:57+00:00",
"status": "approved",
"transaction": {
"currency": "brl",
"amount": 10260,
"buyer_fees": 0,
"total_amount": 10260,
"cupom": ""
},
"payment_details": {
"payment_method": "credit_card",
"credit_card": {
"instalments": 1,
"brand": "mastercard",
"last_digit": 7600
}
},
"comissions": [],
"order": {
"id": 7405530048429536000,
"customer": {
"id": "7394310639977632991",
"name": "João da Silva",
"email": "joao@example.com",
"phone_country": null,
"phone": "+55 11999999999",
"document_type": "cpf",
"document_number": "00000000000"
},
"main_product": {
"id": 7338938162967740000,
"title": "Produto 1",
"price": 10000
},
"order_bump": [
{
"product_id": 7338938162967740000,
"title": "Produto 1",
"price": 10000,
"order_bump": true
}
],
"utms": []
},
"subscription": null
}
}
}
```
### Detalhes
####  Payload principal
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ----------------- | ----------- | ----------------------------------------------------------------- |
| object | string | Sim | Tipo do objeto relacionado ao evento (
transaction
)
|
| event | string | Sim | Nome do evento (
transaction.approved
)
|
| created\_at | string (datetime) | Sim | Data e hora de criação do webhook |
###  data
Informações detalhadas da transação.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | ----------------- | ----------- | ------------------------------------------------------------------------ |
| id | number | Sim | Id único da transação |
| paid\_at | string (ISO 8601) | Sim | Data e hora da confirmação do pagamento |
| status | string | Sim | Status atual da transação (
approved
,
failed
, etc.)
|
| transaction | object | Sim | Dados da transação |
| payment\_details | object | Sim | Dados do pagamento |
| comissions | object | Sim | Dados de comissão |
| order | object \| null | Não | Dados do pedido (é null quando é um produto de assinatura) |
| subscription | object \| null | Não | Dados da assinatura (é null quando é um produto de venda única) |
###  data.transaction
Dados financeiros da transação.
| Campo | Tipo | Obrigatório | Descrição |
| ------------- | -------------- | ----------- | ------------------------------------------------ |
| currency | string | Sim | Moeda da transação (ISO 4217). Ex:
BRL
|
| amount | number | Sim | Valor original da transação (em centavos) |
| buyer\_fees | number | Sim | Taxas aplicadas ao comprador |
| total\_amount | number | Sim | Valor total cobrado (em centavos) |
| cupom | string \| null | Não | Código do cupom aplicado, se houver |
###  data.payment\_details
Detalhes do meio de pagamento utilizado.
| Campo | Tipo | Obrigatório | Descrição |
| --------------- | -------------- | ----------- | ---------------------------------------------------------------------------------- |
| payment\_method | string | Sim | Método de pagamento (
credit\_card
,
pix
,
boleto
, etc.)
|
| credit\_card | object \| null | Não | Dados do cartão (apenas se método for cartão) |
| pix | object \| null | Não | Dados do pix (apenas se método for pix) |
| boleto | object \| null | Não | Dados do boleto (apenas se método for boleto) |
####  data.payment\_details.credit\_card
Informações do cartão de crédito.
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ------ | ----------- | --------------------------- |
| instalments | number | Sim | Número de parcelas |
| brand | string | Sim | Bandeira do cartão |
| last\_digit | number | Sim | Últimos 4 dígitos do cartão |
###  data.payment\_details.pix
Informações do 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 |
###  data.payment\_details.boleto
Informações do 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 |
###  data.comissions
Lista de comissões relacionadas à transação.
| Campo | Tipo | Obrigatório | Descrição |
| ---------- | ----- | ----------- | ------------------------------------ |
| comissions | array | Não | Lista de comissões. Pode estar vazia |
###  data.order
Informações do pedido associado.
| Campo | Tipo | Obrigatório | Descrição |
| ----- | -------------- | ----------- | ------------------------------------------------------------------------------- |
| order | object \| null | Não | Dados do pedido. (Retorna
null
quando a transação é de assinatura)
|
###  data.subscription
Dados da assinatura vinculada à transação.
| Campo | Tipo | Obrigatório | Descrição |
| --------------------- | ------------------------- | ----------- | ----------------------------------------------------------------------- |
| code | string | Sim | Código identificador da assinatura |
| periodicity | string | Sim | Periodicidade da cobrança (
monthly
,
yearly
, etc.)
|
| periodicity\_interval | number | Sim | Intervalo entre cobranças |
| price | number | Sim | Valor da assinatura (em centavos) |
| status | string | Sim | Status atual da assinatura |
| started\_at | string (datetime) \| null | Não | Data de início da assinatura |
| next\_billing\_at | string (datetime) \| null | Não | Próxima data de cobrança |
| suspended\_at | string (datetime) \| null | Não | Data de suspensão da assinatura |
| canceled\_at | string (datetime) \| null | Não | Data de cancelamento da assinatura |
| created\_at | string (datetime) \| null | Não | Data de criação da assinatura |
| subscriber | object | Sim | Dados do assinante |
###  data.subscription.subscriber
Dados do assinante.
| Campo | Tipo | Obrigatório | Descrição |
| ---------------- | -------------- | ----------- | ---------------------------------------------------- |
| id | string | Sim | Id do assinante |
| name | string | Sim | Nome completo |
| email | string | Sim | E-mail do assinante |
| phone\_country | string \| null | Não | Código do país do telefone |
| phone | string \| null | Não | Número de telefone |
| document\_type | string \| null | Não | Tipo de documento (
cpf
ou
cnpj
)
|
| document\_number | string \| null | Não | Número do documento |
###  data.subscription.product
Produto vinculado à assinatura.
| Campo | Tipo | Obrigatório | Descrição |
| ----- | ------ | ----------- | ------------------------------ |
| id | number | Sim | Id do produto |
| title | string | Sim | Nome do produto |
| price | number | Sim | Valor do produto (em centavos) |
###  data.subscription.invoice
Dados da fatura gerada para a assinatura.
| Campo | Tipo | Obrigatório | Descrição |
| ----------------- | ------------------------- | ----------- | ------------------------------------ |
| code | string | Sim | Código da fatura |
| attempts | number | Sim | Quantidade de tentativas de cobrança |
| status | string | Sim | Status da fatura |
| paid\_at | string (datetime) \| null | Não | Data de pagamento |
| refunded\_at | string (datetime) \| null | Não | Data de estorno |
| charged\_back\_at | string (datetime) \| null | Não | Data de chargeback |
| billing\_date | string (datetime) \| null | Sim | Data de vencimento |
| created\_at | string (datetime) \| null | Sim | Data de criação da fatura |
###  data.subscription.transactions
Histórico de tentativas de pagamento da fatura.
| Campo | Tipo | Obrigatório | Descrição |
| --------------- | ------------------------- | ----------- | ---------------------------------- |
| paid\_at | string (datetime) \| null | Não | Data de pagamento |
| payment\_method | string | Sim | Método de pagamento |
| instalments | number | Sim | Número de parcelas |
| currency | string | Sim | Moeda |
| value | number | Sim | Valor da transação (em centavos) |
| status | string | Sim | Status da tentativa |
| credit\_card | object \| null | Não | Dados do cartão (quando aplicável) |
| pix | object \| null | Não | Dados do pix (quando aplicável) |
| boleto | object \| null | Não | Dados do boleto (quando aplicável) |
####  data.subscription.transactions.credit\_card
| Campo | Tipo | Obrigatório | Descrição |
| ----------- | ------ | ----------- | --------------------------- |
| instalments | number | Sim | Número de parcelas |
| brand | string | Sim | Bandeira do cartão |
| last\_digit | number | Sim | Últimos 4 dígitos do cartão |
####  data.subscription.transactions.pix
Informações do 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 |
####  data.subscription.transactions.boleto
Informações do 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 |
# Webhooks de Assinatura
{% hint style="warning" %}
É importante ficar atento à diferença entre os webhooks de compra e de renovação de assinaturas. Na compra, o webhook
transaction.approved
se refere ao pedido; já na renovação, ele se refere ao invoice. Por isso, os dados são enviados em campos diferentes.
{% endhint %}
No momento da compra de um produto de assinatura, é criado um pedido (order) e são enviados dois webhooks:
* Transação Aprovada (transaction.approved)
* Liberação de Acesso (release.access)
O primeiro webhook, referente à compra, está associado ao pedido, portanto as informações da compra estarão disponíveis no campo `order`:
{% stepper %}
{% step %}
### Compra (pedido criado)
Payload de exemplo (os dados principais aparecem em `order`):
```json
{"company":{...},"payload":{"object":"transaction","event":"transaction.approved","created_at":"2026-01-02 16:48:57","data":{...},"payment_details":{...},"comissions":[],"order":{"id":7405530048429536000,"customer":{"id":"7394310639977632991","name":"João da Silva","email":"joao@example.com","phone_country":null,"phone":"+55 11999999999","document_type":"cpf","document_number":"00000000000"},"main_product":{...},"order_bump":[...],"utms":[...]},"subscription":null}}
```
{% endstep %}
{% step %}
### Renovação (invoice)
Na renovação da assinatura, será enviado apenas o webhook de Transação Aprovada (transaction.approved), disparado quando o pagamento da renovação for realizado. Nesse caso, o webhook estará associado ao invoice gerado, e as informações da renovação estarão disponíveis no campo `subscription`:
```json
{"company":{...},"payload":{"object":"transaction","event":"transaction.approved","created_at":"2026-01-02 16:48:57","data":{...},"payment_details":{...},"comissions":[],"order":null,"main_product":{...},"order_bump":[...],"utms":[...]},"subscription":{"code":"SB1B4H1HJ","periodicity":"monthly","periodicity_interval":1,"price":12333,"status":"active","started_at":"2025-12-02 20:02:23","next_billing_at":"2026-02-02 20:02:23","suspended_at":null,"canceled_at":null,"created_at":"2025-12-02 20:02:23","subscriber":{"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":7394309835643586000,"title":"Produto de assinatura","price":12333},"invoice":{"code":"SBIN1B4H1M1","attempts":2,"status":"paid","paid_at":"2026-01-03 11:00:13","refunded_at":null,"charged_back_at":null,"billing_date":"2026-01-02 20:02:23","created_at":"2026-01-03 11:00:09"},"transactions":[{"paid_at":"2026-01-03T11:00:13+00:00","payment_method":"credit_card","instalments":1,"currency":"BRL","value":12333,"status":"approved","credit_card":{"instalments":1,"brand":"discover","last_digit":1234}},{"paid_at":"2026-01-03T11:00:13+00:00","payment_method":"credit_card","instalments":1,"currency":"BRL","value":12333,"status":"approved","credit_card":{"instalments":1,"brand":"discover","last_digit":1234}}]}}
```
{% endstep %}
{% endstepper %}
