Ambiente de simulação — nenhuma cobrança real. Os pagamentos, Pix e cartões deste sandbox são sintéticos.
W Wolf Sandbox Docs Criar conta
Navegação

Pedidos (Orders)

Um pedido registra a venda de uma oferta — produto e preço — e liga os pagamentos a ela. O checkout hospedado cria o pedido sozinho; pela API você cria e paga pedidos no seu próprio fluxo.

Operações

Fluxo pela API

  1. Crie o pedido de uma oferta active: POST /v1/orders com {"offer_id": "off_..."}. O valor e a moeda vêm da oferta.
  2. Crie o pagamento do pedido: POST /v1/orders/{id}/payment-intents. O PaymentIntent nasce com o valor do pedido e order_id preenchido; um pedido tem no máximo um pagamento vivo.
  3. Confirme o PaymentIntent (Pix ou cartão de teste). Quando ele vira succeeded, a Wolf processa o evento do pagamento e marca o pedido como paid — exatamente uma vez, mesmo com eventos repetidos — e emite order.paid.

Cancelar ou expirar só funciona em pending_payment sem pagamento em andamento (409 INVALID_STATE_TRANSITION caso contrário). Criar, pagar, cancelar e expirar exigem Idempotency-Key.

Pedidos do checkout hospedado

Ao pagar uma sessão de checkout (inclusive as abertas por Payment Links), a Wolf cria um pedido da oferta da sessão — um por sessão — com checkout_session_id preenchido.

Estados

EstadoSignificadoPode ir para
pending_payment Criado a partir de uma oferta; aguarda um pagamento. paid,canceled,expired
paidfinal Um PaymentIntent do pedido foi pago. Acontece exatamente uma vez e emite order.paid. —
canceledfinal Cancelado pelo seller antes do pagamento. —
expiredfinal Expirado antes do pagamento. —

O objeto Order

Objeto Order

Objeto Order
Campo Tipo Detalhes
id obrigatório string

Começa com ord_

offer_id obrigatório string

Começa com off_

product_id obrigatório string

Começa com prd_

checkout_session_id obrigatório string | null
amount_minor obrigatório string
currency obrigatório string

Padrão ^[A-Z]{3}$

status obrigatório string

Valores: pending_payment, paid, canceled, expired

paid_payment_intent_id obrigatório string | null
paid_charge_id obrigatório string | null
created_at obrigatório string
updated_at obrigatório string
paid_at obrigatório string | null
canceled_at obrigatório string | null
expired_at obrigatório string | null
items obrigatório object[]
items[].id obrigatório string

Começa com oi_

items[].kind obrigatório string

Valores: main, bump

items[].offer_id obrigatório string

Começa com off_

items[].product_id obrigatório string

Começa com prd_

items[].offer_bump_id obrigatório string | null
items[].amount_minor obrigatório string
items[].currency obrigatório string

Padrão ^[A-Z]{3}$

items[].position obrigatório integer

de 0 a 3