Referência da API

Gerada do documento OpenAPI 3.1.0 da API (versão 1.0.0), que por sua vez é gerado dos contratos Zod usados pela própria API. O mesmo documento está em https://api.v2.wolfpayteste.online/openapi.json, com o servidor deste ambiente.

Veja também os objetos (schemas) usados nas requisições e respostas.

PaymentIntents

Crie, confirme e acompanhe pagamentos Pix simulado e cartão de teste.

post /v1/payment-intents — Criar PaymentIntent
get /v1/payment-intents/{id} — Consultar PaymentIntent
get /v1/payment-intents/{id}/activity — Linha do tempo do PaymentIntent
post /v1/payment-intents/{id}/confirm — Confirmar PaymentIntent

Refunds

Reembolsos totais ou parciais de pagamentos capturados.

post /v1/payment-intents/{id}/refunds — Reembolsar PaymentIntent
get /v1/refunds/{id} — Consultar reembolso

Simulator

Ferramentas que só existem na edição de simulação: simular o pagamento de um Pix e forçar a reconciliação.

post /v1/simulator/payment-intents/{id}/pix/pay — Simular o pagamento de um Pix
post /v1/simulator/payment-intents/{id}/reconcile — Reconciliar PaymentIntent agora
post /v1/simulator/refunds/{id}/reconcile — Reconciliar reembolso agora

Orders

Pedidos de uma oferta e seus pagamentos.

get /v1/orders — Listar pedidos
post /v1/orders — Criar pedido
get /v1/orders/{id} — Consultar pedido
post /v1/orders/{id}/cancel — Cancelar pedido
post /v1/orders/{id}/expire — Expirar pedido
post /v1/orders/{id}/payment-intents — Criar PaymentIntent do pedido

Products

Catálogo: produtos.

get /v1/products — Listar produtos
post /v1/products — Criar produto
get /v1/products/{id} — Consultar produto
patch /v1/products/{id} — Atualizar a ficha do produto
get /v1/products/{id}/access-links — Listar links de acesso
post /v1/products/{id}/access-links — Adicionar link de acesso
delete /v1/products/{id}/access-links/{linkId} — Remover link de acesso
patch /v1/products/{id}/status — Mudar status do produto

Offers

Catálogo: ofertas (preço de um produto).

get /v1/offers — Listar ofertas
post /v1/offers — Criar oferta
get /v1/offers/{id} — Consultar oferta
patch /v1/offers/{id} — Mudar os métodos aceitos da oferta
get /v1/offers/{id}/bumps — Listar order bumps da oferta
post /v1/offers/{id}/bumps — Criar order bump
patch /v1/offers/{id}/bumps/{bumpId} — Alterar order bump
patch /v1/offers/{id}/status — Mudar status da oferta

Checkout Sessions

Sessões de checkout hospedado criadas pelo seller.

post /v1/checkout-sessions — Criar sessão de checkout

Payment Links

Links de pagamento persistentes de uma oferta.

get /v1/payment-links — Listar Payment Links
post /v1/payment-links — Criar Payment Link
get /v1/payment-links/{id} — Consultar Payment Link
patch /v1/payment-links/{id}/status — Ativar ou desativar Payment Link

Public Checkout

Rotas públicas usadas pelo checkout hospedado (sem API key): ler a sessão, registrar os dados do comprador (etapa 1), pagar, simular o Pix e abrir um Payment Link.

get /v1/public/checkout-sessions/{id} — Ler sessão pública (polling)
post /v1/public/checkout-sessions/{id}/lead — Registrar os dados do comprador (etapa 1)
post /v1/public/checkout-sessions/{id}/pay — Pagar sessão de checkout
post /v1/public/checkout-sessions/{id}/pix/simulate-payment — Simular pagamento do Pix da sessão
post /v1/public/checkout-sessions/{id}/reconcile — Reconciliar pagamento da sessão
get /v1/public/payment-links/{id}/session — Abrir sessão de um Payment Link

Webhooks

Endpoints de webhook, entregas, teste, replay e rotação do segredo.

get /v1/webhooks/deliveries — Listar entregas recentes
post /v1/webhooks/deliveries/{id}/replay — Reenviar entrega (replay)
get /v1/webhooks/endpoints — Listar endpoints
post /v1/webhooks/endpoints — Criar endpoint
patch /v1/webhooks/endpoints/{id} — Atualizar endpoint (status e filtros)
delete /v1/webhooks/endpoints/{id} — Excluir endpoint
post /v1/webhooks/endpoints/{id}/rotate-secret — Rotacionar signing secret
post /v1/webhooks/endpoints/{id}/test — Enviar evento de teste

API Keys

API keys do seller (só por sessão humana do app do seller).

get /v1/api-keys — Listar API keys
post /v1/api-keys — Criar API key
post /v1/api-keys/{id}/revoke — Revogar API key

Organizations

Organizações do usuário autenticado (sessão do app do seller).

get /v1/me/organizations — Listar minhas organizações
get /v1/organization/closure-request — Consultar pedido de encerramento
post /v1/organization/closure-request — Pedir o encerramento da organização
post /v1/organizations — Criar organização
patch /v1/organizations/current — Atualizar a organização atual

Reports

Painel, finanças e checkouts abandonados do seller.

get /v1/dashboard — Painel
get /v1/finance — Saldos e journals
get /v1/finance/fees — Taxas vigentes
get /v1/finance/forecast — Previsão de liberações
get /v1/finance/statement — Extrato do saldo disponível
get /v1/notifications — Notificações ao vivo
get /v1/reports/abandoned-checkouts — Checkouts abandonados
post /v1/reports/abandoned-checkouts/{leadId}/recovery-link — Gerar link de recuperação

Payouts, Settlements & Disputes

Leitura de repasses, liquidações e disputas **sintéticos**.

get /v1/disputes — Listar disputas sintéticas
get /v1/disputes/{id} — Consultar disputa sintética
get /v1/finance/payouts — Histórico de saques
get /v1/payouts — Listar repasses sintéticos
post /v1/payouts — Solicitar saque sintético
get /v1/payouts/{id} — Consultar repasse sintético
get /v1/settlements — Listar liquidações sintéticas
get /v1/settlements/{id} — Consultar liquidação sintética