Ticto - Subscription Transaction

Eventos da família subscription_transaction.* na integração Ticto.

Eventos Disponíveis

• subscription_transaction.paid
• subscription_transaction.refunded
• subscription_transaction.disputed
• subscription_transaction.expired
• subscription_transaction.failed
• subscription_transaction.waiting_payment.pix
• subscription_transaction.waiting_payment.boleto
• subscription_transaction.waiting_payment.credit_card
• subscription_transaction.waiting_payment.without_payment_method

Estrutura do Payload

{
  "event": "subscription_transaction.paid",
  "customer": {
    "id": "CUST-001",
    "name": "João Silva",
    "document": "12345678900",
    "email": "[email protected]",
    "phone_numbers": [
      {
        "formatted_phone": "11999999999",
        "type": null,
        "raw_number": "11999999999",
        "area_code": null,
        "international_dialing_code": null
      }
    ],
    "address": {
      "street": "Rua Example",
      "number": "123",
      "complement": "Apto 1",
      "neighborhood": "Bairro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01234567"
    }
  },
  "order": {
    "id": "ORD-ABC123",
    "status": "paid",
    "raw_status": "authorized",
    "created_at": 1705319000,
    "updated_at": 1705319000,
    "paid_at": 1705319000,
    "canceled_at": null,
    "refunded_at": null,
    "warranty_until": null
  },
  "payment": {
    "currency": "BRL",
    "total": 4900,
    "total_products_value": 4900,
    "discount_value": null,
    "shipping_value": 0,
    "coupons": [],
    "payment_method": {
      "type": "credit_card",
      "brand": "visa",
      "last_digits": "1234",
      "expiration_month": null,
      "expiration_year": null
    }
  },
  "product": {
    "id": "PROD-001",
    "name": "Plano Mensal",
    "quantity": 1,
    "unit_value": 4900,
    "total_value": 4900,
    "image_url": null,
    "type": "subscription_plan",
    "offer_type": "main"
  },
  "shipping": {
    "carrier": null,
    "total_value": 0,
    "tracking_url": null,
    "tracking_code": null,
    "method": "digital",
    "delivery_address": {
      "street": "Rua Example",
      "number": "123",
      "complement": "Apto 1",
      "neighborhood": "Bairro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01234567"
    },
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "raw_status": null,
    "status": null
  },
  "checkout": {
    "id": null,
    "url": "https://checkout.ticto.com.br/abc123"
  },
  "lead_tracking": {
    "src": "facebook",
    "sck": null,
    "utm_source": "facebook",
    "utm_campaign": "campanha",
    "utm_medium": "social",
    "utm_content": "ads",
    "utm_term": "termo",
    "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": null
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	string | null	Código do cliente
name	string | null	Nome do cliente
document	string | null	Número do documento (CPF/CNPJ)
email	string | null	Email do cliente
phoneNumbers	Collection	Coleção de telefones
address	Address	Endereço do cliente

Subcomponentes

Campo	Tipo	Descrição
street	string | null	Nome da rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (UF)
country	string | null	País
postalCode	string | null	CEP

---

Telefones

Campo	Tipo	Descrição
formattedPhone	PhoneFactory | null	Telefone formatado
type	null	Sempre null
rawNumber	string | null	Número bruto
areaCode	string | null	Código de área (DDD)
internationalDialingCode	string | null	Código DDI

---

Order

Campo	Tipo	Descrição
id	string | null	ID do pedido
status	OrderStatus | null	Status normalizado do pedido
rawStatus	string | null	Status original do provider
createdAt	Carbon | null	Data de criação do pedido
updatedAt	Carbon | null	Data de atualização
paidAt	Carbon | null	Data do pagamento
canceledAt	null	Sempre null
refundedAt	Carbon | null	Data do reembolso
warrantyUntil	null	Sempre null

Status Normalizados (OrderStatus)

A Ticto retorna os seguintes valores normalizados para o status do pedido:

Valor	Descrição
paid	Pago
waiting_payment	Aguardando pagamento
refunded	Reembolsado
disputed	Em disputa
expired	Expirado
failed	Falhou
abandoned	Abandonado

---

Payment

Campo	Tipo	Descrição
currency	string | null	Moeda
total	int | null	Valor total do pedido
totalProductsValue	int | null	Valor dos produtos
discountValue	null	Sempre null
shippingValue	int | null	Valor do frete
coupons	Collection	Coleção de cupons
paymentMethod	PaymentMethod | null	Método de pagamento

Métodos de Pagamento

Campo	Tipo	Descrição
brand	string | null	Bandeira do cartão
lastDigits	string | null	Últimos 4 dígitos
expirationMonth	null	Sempre null
expirationYear	null	Sempre null

---

Campo	Tipo	Descrição
qrcodeUrl	string | null	URL do QR Code Pix
qrcodeSignature	string | null	Código QR Pix
expirationDate	null	Sempre null
pixKey	null	Sempre null
pixKeyType	null	Sempre null

---

Campo	Tipo	Descrição
digitableLine	string | null	Linha digitável do boleto
url	string | null	URL do boleto
expirationDate	null	Sempre null

---

Product

Campo	Tipo	Descrição
id	string | null	ID do produto
name	string | null	Nome do produto
quantity	int | null	Quantidade
unitValue	int | null	Valor unitário em centavos
totalValue	int | null	Valor total
imageUrl	null	Sempre null
type	string	Sempre product
offerType	string	Sempre main

---

Shipping

Campo	Tipo	Descrição
carrier	null	Sempre null
totalValue	int | null	Valor do frete
trackingUrl	null	Sempre null
trackingCode	null	Sempre null
method	string | null	Método de envio
deliveryAddress	Address	Endereço de entrega
estimatedDeliveryDate	null	Sempre null
estimatedDeliveryTimeInDays	int | null	Dias estimados para entrega
rawStatus	null	Sempre null
status	null	Sempre null

Campo	Tipo	Descrição
street	string | null	Nome da rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (UF)
country	string | null	País
postalCode	string | null	CEP

---

Checkout

Campo	Tipo	Descrição
id	null	Sempre null
url	string | null	URL do checkout

---

LeadTracking

Campo	Tipo	Descrição
src	string | null	Fonte do tráfego
sck	string | null	SCK
utmSource	string | null	Fonte UTM
utmCampaign	string | null	Campanha UTM
utmMedium	string | null	Meio UTM
utmContent	string | null	Conteúdo UTM
utmTerm	string | null	Termo UTM
utmId	null	Sempre null
metaFbp	string | null	Meta FBP
googleGaId	null	Sempre null
googleGclid	string | null	Google GCLID
googleGclsrc	null	Sempre null
googleDclid	null	Sempre null
googleGbraid	null	Sempre null
googleWbraid	null	Sempre null
tiktokTtlid	null	Sempre null
ip	null	Sempre null

---

Voltar para visão geral da integração