> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pepper.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Transaction

> Formato do payload enviado no evento: Transaction (versão 1.0)

* **Versão 1.0** = sistema antigo da Pepper (em produção até 2024)
* **Versão 2.0** = sistema atual da Pepper

<Note>Para **garantir a compatibilidade com versões anteriores** já configuradas em outras plataformas, você pode escolher entre a versão 1.0 ou 2.0. Consulte a documentação da plataforma que deseja integrar.</Note>

## Dados enviados no payload do webhook:

<ParamField path="currency" type="string">
  Moeda utilizada na transação.
</ParamField>

<ParamField path="payment_engine" type="string">
  Nome da plataforma ou empresa responsável pelo processamento do pagamento.
</ParamField>

<ParamField path="main_transaction" type="string">
  Tipo ou identificador da transação principal.
</ParamField>

<ParamField path="transaction" type="string">
  Identificador ou tipo da transação secundária.
</ParamField>

<ParamField path="abandonmentId" type="string">
  Identificador para transações abandonadas (ex.: carrinho).
</ParamField>

<ParamField path="client_id" type="string">
  UUID único do cliente.
</ParamField>

<ParamField path="payment_type" type="string">
  Método de pagamento utilizado (ex.: pix, cartão de crédito).
</ParamField>

<ParamField path="status" type="string">
  Status da transação (ex.: pendente, pago).
</ParamField>

<ParamField path="prod" type="number">
  Código ou valor do produto.
</ParamField>

<ParamField path="prod_name" type="string">
  Nome ou título do produto.
</ParamField>

<ParamField path="producer_name" type="string">
  Nome do produtor ou vendedor.
</ParamField>

<ParamField path="producer_document" type="string">
  Documento do produtor (ex.: CPF).
</ParamField>

<ParamField path="producer_legal_nature" type="string">
  Natureza jurídica do produtor (ex.: individual, empresa).
</ParamField>

<ParamField path="purchase_date" type="string">
  Data da compra no formato ISO 8601.
</ParamField>

<ParamField path="confirmation_purchase_date" type="nullable">
  Data de confirmação da compra (nulo se não confirmada).
</ParamField>

<ParamField path="product_support_email" type="string">
  E-mail de suporte do produto.
</ParamField>

<ParamField path="installments_number" type="number">
  Número de parcelas do pagamento.
</ParamField>

<ParamField path="original_offer_price" type="number">
  Preço original da oferta.
</ParamField>

<ParamField path="warranty_date" type="nullable">
  Data de garantia (nulo se não aplicável).
</ParamField>

<ParamField path="order_bump" type="boolean">
  Indica se houve um "order bump" (oferta adicional no checkout).
</ParamField>

<ParamField path="cms_market_place" type="number">
  Comissão ou taxa do marketplace.
</ParamField>

<ParamField path="cms_vendor" type="number">
  Comissão ou taxa do vendedor.
</ParamField>

<ParamField path="off" type="number">
  Valor de desconto ou oferta.
</ParamField>

<ParamField path="price" type="number">
  Preço final da transação.
</ParamField>

<ParamField path="full_price" type="number">
  Preço total sem descontos.
</ParamField>

<ParamField path="email" type="string">
  E-mail do cliente.
</ParamField>

<ParamField path="name" type="string">
  Nome completo do cliente.
</ParamField>

<ParamField path="first_name" type="string">
  Primeiro nome do cliente.
</ParamField>

<ParamField path="last_name" type="string">
  Sobrenome do cliente.
</ParamField>

<ParamField path="doc" type="string">
  Documento do cliente (ex.: CPF).
</ParamField>

<ParamField path="phone_number" type="string">
  Número de telefone do cliente.
</ParamField>

<ParamField path="billet_url" type="nullable">
  URL do boleto (nulo se não aplicável).
</ParamField>

<ParamField path="billet_barcode" type="nullable">
  Código de barras do boleto (nulo se não aplicável).
</ParamField>

<ParamField path="pix_URL" type="string">
  URL para pagamento via Pix.
</ParamField>

<ParamField path="pix_qrcode" type="string">
  Código QR para pagamento via Pix.
</ParamField>

<ParamField path="utm_campaign" type="string">
  Nome da campanha de marketing (UTM).
</ParamField>

<ParamField path="utm_medium" type="string">
  Meio da campanha (ex.: social, e-mail).
</ParamField>

<ParamField path="utm_content" type="string">
  Conteúdo da campanha (ex.: banner, link).
</ParamField>

<ParamField path="utm_source" type="string">
  Fonte da campanha (ex.: facebook, google).
</ParamField>

<ParamField path="utm_term" type="string">
  Termo da campanha (ex.: palavra-chave).
</ParamField>

<ParamField path="sck" type="string">
  Identificador de rastreamento (possivelmente um cookie ou sessão).
</ParamField>

<ParamField path="src" type="string">
  Código de origem da transação.
</ParamField>

## Exemplo de Payload de Transação - v1.0

```json theme={null}
{
  "currency": "BLR",
  "payment_engine": "pepper",
  "main_transaction": "sale",
  "transaction": "order",
  "abandonmentId": "cart123",
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "payment_type": "pix",
  "status": "pending",
  "prod": 12000,
  "prod_name": "Basic Plan",
  "producer_name": "Jane Smith",
  "producer_document": "98765432100",
  "producer_legal_nature": "individual",
  "purchase_date": "2025-04-29T14:30:45+00:00",
  "confirmation_purchase_date": null,
  "product_support_email": "support@example.com",
  "installments_number": 6,
  "original_offer_price": 100.35,
  "warranty_date": null,
  "order_bump": false,
  "cms_market_place": 4.15,
  "cms_vendor": 49.2,
  "off": 120,
  "price": 100.35,
  "full_price": 100.35,
  "email": "jane.smith@example.com",
  "name": "Jane Smith",
  "first_name": "Jane",
  "last_name": "Smith",
  "doc": "98765432100",
  "phone_number": "+1-202-555-5678",
  "billet_url": null,
  "billet_barcode": null,
  "pix_URL": "https://example.com/pix/123456",
  "pix_qrcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
  "utm_campaign": "summer_promo",
  "utm_medium": "social",
  "utm_content": "banner_ad",
  "utm_source": "facebook",
  "utm_term": "plan",
  "sck": "tracking",
  "src": "d4e5f"
}
```
