Assiny - Order

Eventos da família order.* na integração Assiny.

Eventos Disponiveis

Evento	Descricao
order.paid	Pagamento aprovado
order.waiting_payment.pix	Aguardando pagamento PIX
order.waiting_payment.boleto	Aguardando pagamento Boleto
order.completed	Pedido completado
order.canceled	Pedido cancelado
order.refunded	Pedido reembolsado
order.disputed	Pedido em disputa
order.failed	Pagamento recusado
order.expired	Pagamento expirado

Estrutura do Payload

{
  "customer": {
    "id": "cli_123456",
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "999999999",
        "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"
    }
  },
  "order": {
    "id": "txn_789012",
    "status": "paid",
    "raw_status": "paid",
    "created_at": 1705319000,
    "updated_at": 1705319100,
    "paid_at": null,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "payment": {
    "currency": "BRL",
    "total": 29900,
    "discount_value": null,
    "shipping_value": null,
    "total_products_value": 29900,
    "payment_method": {
      "type": "pix",
      "qrcode_url": null,
      "qrcode_signature": "00020101021226820014br.gov.bcb.pix...",
      "expiration_date": null,
      "pix_key": null,
      "pix_key_type": null
    },
    "coupons": []
  },
  "products": [
    {
      "id": "prod_456",
      "name": "Produto Exemplo",
      "type": "product",
      "quantity": 1,
      "unit_value": 29900,
      "total_value": 29900,
      "image_url": null,
      "offer_type": "main"
    }
  ],
  "lead_tracking": {
    "src": "facebook",
    "sck": null,
    "utm_source": "facebook",
    "utm_campaign": "black_friday",
    "utm_medium": "cpc",
    "utm_content": null,
    "utm_term": null,
    "utm_id": null,
    "meta_fbp": "fb.1.1234567890",
    "google_ga_id": null,
    "google_gclid": null,
    "google_gclsrc": null,
    "google_dclid": null,
    "google_gbraid": null,
    "google_wbraid": null,
    "tiktok_ttlid": null,
    "ip": "189.123.45.67"
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descricao
id	string | null	ID do cliente
name	string | null	Nome completo (tenta full_name, depois first_name + last_name)
email	string | null	E-mail do cliente
document	string | null	CPF ou CNPJ do cliente
phone_numbers	Phone[] | null	Colecao de telefones do cliente
address	Address	Endereco do cliente

Address

Campo	Tipo	Descricao
street	string | null	Logradouro
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado/UF
country	string | null	Pais
postal_code	string | null	CEP

Phone

Telefone do cliente.

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado em E.164
type	null	Sempre null
raw_number	string | null	Número sem formatação
area_code	null	Sempre null
international_dialing_code	null	Sempre null

---

Order

Campo	Tipo	Descrição
id	string | null	ID da transação
status	string | null	Status normalizado do pedido
raw_status	string | null	Status original da Assiny
created_at	Carbon | null	Data de criação da transação
updated_at	Carbon | null	Data de última atualização
paid_at	null	Sempre null
warranty_until	null	Sempre null
canceled_at	null	Sempre null
refunded_at	null	Sempre null

Status Normalizados (OrderStatus)

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

Valor	Descrição
paid	Pagamento aprovado
completed	Pedido completado
canceled	Pedido cancelado
waiting_payment	Aguardando pagamento
refunded	Pedido reembolsado
disputed	Em disputa (chargeback)
failed	Pagamento recusado
expired	Pagamento expirado
abandoned	Checkout abandonado

---

Payment

Campo	Tipo	Descrição
currency	string | null	Moeda (ex: BRL)
total	int | null	Valor total da transação
total_products_value	int | null	Valor total dos produtos
discount_value	null	Sempre null
shipping_value	null	Sempre null
payment_method	PaymentMethod | null	Método de pagamento utilizado
coupons	Collection	Coleção vazia (não há suporte a cupons)

PaymentMethod

O tipo de pagamento é identificado pelo campo data.transaction.payment_type:

payment_type	Enum	Classe
credit	credit	CreditCard
bank_slip	bank_slip	Boleto
pix	pix	Pix
transaction	transaction	Deposit

Pix

Campo	Tipo	Descricao
type	string	Sempre pix
qrcode_url	null	Sempre null
qrcode_signature	string | null	QR Code signature (copia e cola)
expiration_date	null	Sempre null
pix_key	null	Sempre null
pix_key_type	null	Sempre null

Boleto

Campo	Tipo	Descricao
type	string	Sempre boleto
digitable_line	string | null	Linha digitavel do boleto
url	string | null	URL para visualizacao do boleto
expiration_date	null	Sempre null

Deposit

Campo	Tipo	Descricao
type	string	Sempre deposit

[!NOTE] O driver Assiny nao captura dados adicionais do deposito. Este componente nao possui campos alem do schema base.

---

Product

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

Tipo de Produto

O campo type pode ser:

• product - Produto padrão
• subscription_plan - Plano de assinatura (quando existe subscription.id)

---

LeadTracking

Campo	Tipo	Descricao
src	string | null	Fonte do trafego (data.metadata.url_parameters.src)
sck	null	Sempre null
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	string | null	Facebook Pixel ID
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	Endereco IP do cliente

---

Voltar para visão geral da integração