Kiwify - Checkout

Eventos da família checkout.* na integração Kiwify.

Eventos Disponíveis

• checkout.abandoned

Estrutura do Payload

{
  "customer": {
    "id": null,
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "5511999999999",
        "area_code": null,
        "international_dialing_code": null
      }
    ],
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    }
  },
  "checkout": {
    "id": "ORDER-123",
    "url": null
  },
  "payment": {
    "currency": "BRL",
    "total": 9970,
    "discount_value": null,
    "shipping_value": null,
    "total_products_value": 9970,
    "payment_method": null,
    "coupons": []
  },
  "shipping": {
    "carrier": null,
    "total_value": null,
    "tracking_url": null,
    "tracking_code": null,
    "method": null,
    "delivery_address": null,
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "status": null,
    "raw_status": null
  },
  "products": [
    {
      "id": "PROD-001",
      "name": "Produto Exemplo",
      "type": "product",
      "offer_type": "main",
      "quantity": 1,
      "unit_value": 9970,
      "total_value": 9970,
      "image_url": null
    }
  ],
  "lead_tracking": {
    "src": "facebook",
    "sck": null,
    "utm_source": "facebook",
    "utm_campaign": "campanha_01",
    "utm_medium": "cpc",
    "utm_content": "banner_01",
    "utm_term": "produto",
    "utm_id": null,
    "meta_fbp": null,
    "google_ga_id": null,
    "google_gclid": null,
    "google_gclsrc": null,
    "google_dclid": null,
    "google_gbraid": null,
    "google_wbraid": null,
    "tiktok_ttlid": null,
    "ip": "192.168.1.1"
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	null	Sempre null
name	string | null	Nome completo do cliente
email	string | null	E-mail do cliente
document	string | null	CPF ou CNPJ
phone_numbers	Collection	Coleção de telefones
address	Address	Endereço do cliente

Telefone

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado
type	null	Sempre null
raw_number	string | null	Número bruto
area_code	null	Sempre null
international_dialing_code	null	Sempre null

Endereço

Campo	Tipo	Descrição
street	string | null	Rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado
country	string | null	País
postal_code	string | null	CEP

---

Checkout

Campo	Tipo	Descrição
id	null	Sempre null
url	null	Sempre null

---

Payment

Campo	Tipo	Descrição
currency	string	Moeda (BRL)
total	integer	Valor total (em centavos)
discount_value	null	Sempre null
shipping_value	null	Sempre null
total_products_value	integer	Valor base dos produtos (em centavos)
payment_method	PaymentMethod	Método de pagamento
coupons	Collection	Coleção de cupons (vazia)

Métodos de Pagamento (PaymentMethod)

A Kiwify retorna os seguintes métodos de pagamento:

Valor	Descrição
credit_card	Cartão de Crédito
pix	PIX
boleto	Boleto Bancário

---

Product

Campo	Tipo	Descrição
id	string | null	ID do produto
name	string | null	Nome do produto
quantity	integer	Sempre 1
unit_value	integer	Valor unitário (em centavos)
total_value	integer	Valor total (em centavos)
image_url	null	Sempre null
type	string	Tipo do produto (product ou subscription_plan)
offer_type	string	Sempre main

---

Lead Tracking

Campo	Tipo	Descrição
src	string | null	Fonte do tracking
sck	string | null	SCK
utm_source	string | null	UTM Source
utm_campaign	string | null	UTM Campaign
utm_medium	string | null	UTM Medium
utm_content	string | null	UTM Content
utm_term	string | null	UTM Term
utm_id	null	Sempre null
meta_fbp	null	Sempre null
google_ga_id	null	Sempre null
google_gclid	null	Sempre null
google_gclsrc	null	Sempre null
google_dclid	null	Sempre null
google_gbraid	null	Sempre null
google_wbraid	null	Sempre null
tiktok_ttlid	null	Sempre null
ip	string | null	Endereço IP do cliente

---

Shipping (vazio)

Campo	Tipo	Descrição
carrier	null	Sempre null
total_value	null	Sempre null
tracking_url	null	Sempre null
tracking_code	null	Sempre null
method	null	Sempre null
delivery_address	[EmptyAddress]	Endereço vazio
estimated_delivery_date	null	Sempre null
estimated_delivery_time_in_days	null	Sempre null
status	null	Sempre null
raw_status	null	Sempre null

Delivery Address (Vazio)

Campo	Tipo	Descrição
street	null	Sempre null
number	null	Sempre null
complement	null	Sempre null
neighborhood	null	Sempre null
city	null	Sempre null
state	null	Sempre null
country	null	Sempre null
postal_code	null	Sempre null

[!NOTE] Essa integração não disponibiliza informações de endereço.

[!NOTE] Essa integração não disponibiliza informações de envio.

---

Voltar para visão geral da integração