Payt - Order

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

Eventos Disponíveis

• order.paid
• order.waiting_payment
• order.waiting_payment.pix
• order.waiting_payment.credit_card
• order.waiting_payment.boleto
• order.processing
• order.manufacturing
• order.completed
• order.refunded
• order.disputed
• order.expired
• order.canceled

Estrutura do Payload

{
  "event": "order.paid",
  "cart_id": "CART-123456",
  "transaction_id": "TXN-123456",
  "status": "paid",
  "started_at": 1705319000,
  "updated_at": 1705319000,
  "customer": {
    "code": "CUST-001",
    "name": "João Silva",
    "doc": "12345678900",
    "email": "[email protected]",
    "phone": "11999999999"
  },
  "product": {
    "code": "PROD-001",
    "name": "Produto Exemplo",
    "quantity": 1,
    "price": 10000
  },
  "transaction": {
    "payment_method": "credit_card",
    "total_price": 10000,
    "paid_at": 1705319000,
    "pix_url": null,
    "pix_code": null,
    "bankslip_url": null,
    "bankslip_code": null,
    "expires_at": null
  },
  "shipping": {
    "status": "waiting",
    "price": 0,
    "service": "Correios",
    "tracking_code": null,
    "tracking_url": null
  },
  "link": {
    "url": "https://payt.com/checkout/123",
    "sources": {
      "src": "facebook",
      "utm_source": "facebook",
      "utm_campaign": "campanha",
      "utm_medium": "social",
      "utm_content": "ads",
      "utm_term": "termo"
    },
    "query_params": {
      "gclid": "abc123"
    }
  }
}

---

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	EmptyAddress	Endereço (sempre vazio)

Subcomponentes

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.

---

Telefones

Campo	Tipo	Descrição
formattedPhone	PhoneFactory | null	Telefone formatado
type	null	Sempre null
rawNumber	string | null	Número bruto
areaCode	null	Sempre null
internationalDialingCode	null	Sempre null

---

Order

Campo	Tipo	Descrição
id	string | null	ID da transação
status	OrderStatus | null	Status normalizado do pedido
raw_status	string | null	Status original do provider
created_at	integer | null	Timestamp de criação
updated_at	integer | null	Timestamp de atualização
paid_at	integer | null	Timestamp do pagamento
canceled_at	null	Sempre null
refunded_at	null	Sempre null
warranty_until	null	Sempre null

Status Normalizados (OrderStatus)

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

Valor	Descrição
paid	Pago
completed	Concluído
waiting_payment	Aguardando pagamento
waiting_fulfillment	Aguardando separação
payment_processing	Processando pagamento
refunded	Reembolsado
failed	Falhou
disputed	Em disputa
expired	Expirado
canceled	Cancelado

---

Payment

Campo	Tipo	Descrição
currency	string | Currency	Sempre BRL
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
type	string	Sempre credit_card
brand	null	Sempre null
last_digits	null	Sempre null
expiration_month	null	Sempre null
expiration_year	null	Sempre null

[!NOTE] Essa integração não disponibiliza informações de pagamento Cartão de Crédito.

---

Campo	Tipo	Descrição
qrcode_url	string | null	URL do QR Code Pix
qrcode_signature	string | null	Código Pix
expiration_date	integer | null	Timestamp de expiração
pix_key	null	Sempre null
pix_key_type	null	Sempre null

---

Campo	Tipo	Descrição
digitable_line	string | null	Linha digitável do boleto
url	string | null	URL do boleto
expiration_date	integer | null	Timestamp de vencimento

---

Product

Campo	Tipo	Descrição
id	string | null	Código 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	string | null	Nome da transportadora
totalValue	int | null	Valor do frete
trackingUrl	string | null	URL de rastreamento
trackingCode	string | null	Código de rastreamento
method	null	Sempre null
deliveryAddress	EmptyAddress	Endereço de entrega (sempre vazio)
estimatedDeliveryDate	null	Sempre null
estimatedDeliveryTimeInDays	null	Sempre null
status	ShippingStatus | null	Status normalizado do envio

Status Normalizados (ShippingStatus)

A Payt retorna os seguintes valores normalizados para o status do envio:

Valor	Descrição
fulfilled	Encomenda separada para envio
delivered	Entregue
out_for_delivery	Saiu para entrega
in_transit	Em trânsito
delayed	Atrasado
failed	Falha na entrega
waiting_postage	Aguardando postagem
withdrawal_available	Disponível para retirada

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.

---

Checkout

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

---

LeadTracking

Campo	Tipo	Descrição
src	string | null	Fonte do tráfego
sck	null	Sempre null
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	null	Sempre null
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