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)

{
  "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": "[email protected]",
        "phone_country": null,
        "phone": "[phone]",
        "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)

{
  "company": {
    "id": "7268299385367167832",
    "name": "company",
    "email": "[email protected]",
    "phone": "[phone]",
    "document_type": "cnpj",
    "document_number": "00000000000000",
    "owner": {
      "id": "7268299385346197469",
      "name": "Lucas da Silva",
      "email": "[email protected]",
      "phone": "[phone]",
      "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": "[email protected]",
          "phone_country": null,
          "phone": "[phone]",
          "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