Pular para o conteúdo principal
  • Versão 1.0 = sistema antigo da Pepper (em produção até 2024)
  • Versão 2.0 = sistema atual da Pepper
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.

Dados enviados no payload do webhook:

currency
string
Moeda utilizada na transação.
payment_engine
string
Nome da plataforma ou empresa responsável pelo processamento do pagamento.
main_transaction
string
Tipo ou identificador da transação principal.
transaction
string
Identificador ou tipo da transação secundária.
abandonmentId
string
Identificador para transações abandonadas (ex.: carrinho).
client_id
string
UUID único do cliente.
payment_type
string
Método de pagamento utilizado (ex.: pix, cartão de crédito).
status
string
Status da transação (ex.: pendente, pago).
prod
number
Código ou valor do produto.
prod_name
string
Nome ou título do produto.
producer_name
string
Nome do produtor ou vendedor.
producer_document
string
Documento do produtor (ex.: CPF).
Natureza jurídica do produtor (ex.: individual, empresa).
purchase_date
string
Data da compra no formato ISO 8601.
confirmation_purchase_date
nullable
Data de confirmação da compra (nulo se não confirmada).
product_support_email
string
E-mail de suporte do produto.
installments_number
number
Número de parcelas do pagamento.
original_offer_price
number
Preço original da oferta.
warranty_date
nullable
Data de garantia (nulo se não aplicável).
order_bump
boolean
Indica se houve um “order bump” (oferta adicional no checkout).
cms_market_place
number
Comissão ou taxa do marketplace.
cms_vendor
number
Comissão ou taxa do vendedor.
off
number
Valor de desconto ou oferta.
price
number
Preço final da transação.
full_price
number
Preço total sem descontos.
email
string
E-mail do cliente.
name
string
Nome completo do cliente.
first_name
string
Primeiro nome do cliente.
last_name
string
Sobrenome do cliente.
doc
string
Documento do cliente (ex.: CPF).
phone_number
string
Número de telefone do cliente.
billet_url
nullable
URL do boleto (nulo se não aplicável).
billet_barcode
nullable
Código de barras do boleto (nulo se não aplicável).
pix_URL
string
URL para pagamento via Pix.
pix_qrcode
string
Código QR para pagamento via Pix.
utm_campaign
string
Nome da campanha de marketing (UTM).
utm_medium
string
Meio da campanha (ex.: social, e-mail).
utm_content
string
Conteúdo da campanha (ex.: banner, link).
utm_source
string
Fonte da campanha (ex.: facebook, google).
utm_term
string
Termo da campanha (ex.: palavra-chave).
sck
string
Identificador de rastreamento (possivelmente um cookie ou sessão).
src
string
Código de origem da transação.

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

{
  "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"
}