Pagali - Order

Eventos da familia order.* na integracao Pagali.

Eventos Disponiveis

• order.paid
• order.waiting_payment
• order.waiting_payment.boleto
• order.waiting_payment.credit_card
• order.waiting_payment.pix
• order.refunded
• order.canceled
• order.expired

Estrutura do Payload

{
  "event": "transaction.paid",
  "data": {
    "id": "ORD-123456",
    "status": "paid",
    "createdAt": 1705319000,
    "updatedAt": 1705319000,
    "paidAt": 1705319000,
    "refundedAt": null,
    "status_history": [],
    "customer": {
      "personName": "Joao Silva",
      "documentNumber": "12345678900",
      "email": "[email protected]",
      "phones": ["11999999999"],
      "address": {
        "line1": "Rua Example",
        "number": "123",
        "complement": "Apto 1",
        "neighborhood": "Bairro",
        "city": "Sao Paulo",
        "state": "SP",
        "country": "BR",
        "zipCode": "01234567"
      }
    },
    "items": [
      {
        "code": "PROD-001",
        "description": "Produto Exemplo",
        "quantity": 1,
        "amount": 10000
      }
    ],
    "payments": [
      {
        "method": "credit_card",
        "method_boleto": null,
        "method_pix": null
      }
    ],
    "method": "credit_card",
    "methodData": null,
    "amount": 10000,
    "shipping": {
      "amount": 0,
      "description": "Entrega digital",
      "estimatedDeliveryDate": null,
      "address": null
    }
  },
  "tracking": {
    "ip": "192.168.1.1"
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descricao
id	null	Sempre null
name	string | null	Nome do cliente
document	string | null	Numero do documento (CPF/CNPJ)
email	string | null	Email do cliente
phoneNumbers	Collection	Colecao de telefones
address	Address	Endereco do cliente

Subcomponentes

Campo	Tipo	Descricao
street	string | null	Nome da rua
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
postalCode	string | null	CEP

---

Telefones

Campo	Tipo	Descricao
formattedPhone	PhoneFactory | null	Telefone formatado
type	null	Sempre null
rawNumber	string | null	Numero bruto
areaCode	null	Sempre null
internationalDialingCode	null	Sempre null

---

Order

Campo	Tipo	Descricao
id	string | null	ID do pedido
status	string	Status normalizado do pedido
rawStatus	string | null	Status original do provider
createdAt	Carbon | null	Data de criacao do pedido
updatedAt	Carbon | null	Data de atualizacao do pedido
paidAt	Carbon | null	Data do pagamento
canceledAt	Carbon | null	Data do cancelamento
refundedAt	Carbon | null	Data do reembolso
warrantyUntil	null	Sempre null

Status Normalizados (OrderStatus)

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

Valor	Descricao
paid	Pago
waiting_payment	Aguardando pagamento
refunded	Reembolsado
expired	Expirado
canceled	Cancelado

---

Payment

Campo	Tipo	Descricao
currency	string | Currency	Sempre BRL
total	int | null	Valor total do pedido
totalProductsValue	int | null	Soma dos valores dos produtos
discountValue	null	Sempre null
shippingValue	int | null	Valor do frete
coupons	Collection	Colecao de cupons
paymentMethod	PaymentMethod | null	Metodo de pagamento

Metodos de Pagamento

Campo	Tipo	Descricao
brand	null	Sempre null
lastDigits	null	Sempre null
expirationMonth	null	Sempre null
expirationYear	null	Sempre null

---

Campo	Tipo	Descricao
digitableLine	string | null	Linha digitavel do boleto
url	string | null	URL do boleto ou PDF
expirationDate	Carbon | null	Data de vencimento

---

Campo	Tipo	Descricao
qrcodeUrl	string | null	URL do QR Code Pix
qrcodeSignature	string | null	Assinatura do QR Code Pix
expirationDate	Carbon | null	Data de expiracao
pixKey	null	Sempre null
pixKeyType	null	Sempre null

---

Product

Campo	Tipo	Descricao
id	string | null	Codigo do produto
name	string | null	Nome do produto
quantity	int	Quantidade (minimo 1)
unitValue	int	Valor unitario em centavos
totalValue	int	Valor total (quantidade x valor unitario)
imageUrl	null	Sempre null
type	string	Sempre product
offerType	string	Sempre main

---

Shipping

Campo	Tipo	Descricao
carrier	null	Sempre null
totalValue	int | null	Valor do frete
trackingUrl	null	Sempre null
trackingCode	null	Sempre null
method	string | null	Descricao do metodo de envio
deliveryAddress	Address	Endereco de entrega
estimatedDeliveryDate	Carbon | null	Data estimada de entrega
estimatedDeliveryTimeInDays	null	Sempre null
rawStatus	null	Sempre null
status	null	Sempre null

Campo	Tipo	Descricao
street	string | null	Nome da rua
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
postalCode	string | null	CEP

---

Checkout

Campo	Tipo	Descricao
id	null	Sempre null
url	null	Sempre null

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

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

---

LeadTracking

Campo	Tipo	Descricao
ip	string | null	IP do cliente

Campo	Tipo	Descrição
src	null	Sempre null
sck	null	Sempre null
utm_source	null	Sempre null
utm_campaign	null	Sempre null
utm_medium	null	Sempre null
utm_content	null	Sempre null
utm_term	null	Sempre null
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	null	Sempre null

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

---

Voltar para visao geral da integracao