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

post/v1/simulator/payment-intents/{id}/pix/pay

Simular o pagamento de um Pix (simulatePixPayment)

Gera o evento de provedor pix.paid do PaymentIntent confirmado com Pix: o pagamento vira succeeded (Charge, ledger e webhooks payment.* na mesma transação). Repetir não faz nada. Só existe na edição de simulação. Com o Pix desligado no ambiente (kill switch PIX_SIMULATION_ENABLED) → 409 PAYMENT_METHOD_UNAVAILABLE.

só na edição de simulação rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: payments:write
URL: https://api.v2.wolfpayteste.online/v1/simulator/payment-intents/{id}/pix/pay

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do PaymentIntent (`pi_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do PaymentIntent (pi_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

PaymentIntent após o pagamento simulado.

Objeto PaymentIntent

Resposta 200 de simulatePixPayment
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pi_`
`order_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`provider_id` obrigatório	string
`latest_provider_attempt_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null
`payment_method_types` obrigatório	string[]	Valores: `card`, `pix` 1 a n itens
`payment_method_type` obrigatório	string \| null
`description` obrigatório	string \| null
`metadata` obrigatório	mapa de string
`payer` obrigatório	PayerView \| null
`next_action` obrigatório	PaymentNextAction \| null
`expires_at` obrigatório	string \| null
`cancellation_reason` obrigatório	string \| null

Exemplo de resposta 200 json

{
  "id": "pi_3b9f0c2d1e4a5b6c7d8e9f0a1b2c3d4e",
  "order_id": null,
  "amount_minor": "9900",
  "currency": "BRL",
  "provider_id": "simulator",
  "failure_code": null,
  "payment_method_types": [
    "pix",
    "card"
  ],
  "description": "Curso de fotografia",
  "metadata": {
    "pedido_interno": "A-1001"
  },
  "payer": {
    "name": "Ana Compradora",
    "email": "ana@example.com",
    "phone": "+5511987654321",
    "document": {
      "type": "cpf",
      "last2": "25"
    }
  },
  "cancellation_reason": null,
  "status": "succeeded",
  "latest_provider_attempt_id": "pat_5d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a",
  "payment_method_type": "pix",
  "next_action": null,
  "expires_at": "2026-11-06T12:30:00.000Z"
}

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — INVALID_STATE_TRANSITION,PAYMENT_METHOD_UNAVAILABLE,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/simulator/payment-intents/{id}/reconcile

Reconciliar PaymentIntent agora (reconcilePaymentIntent)

Consulta o provedor simulado pela tentativa em estado desconhecido e aplica o resultado, sem esperar o ciclo automático de reconciliação.

só na edição de simulação rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: payments:write
URL: https://api.v2.wolfpayteste.online/v1/simulator/payment-intents/{id}/reconcile

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do PaymentIntent (`pi_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do PaymentIntent (pi_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Resultado definitivo aplicado.

Objeto PaymentIntent

Resposta 200 de reconcilePaymentIntent
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pi_`
`order_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`provider_id` obrigatório	string
`latest_provider_attempt_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null
`payment_method_types` obrigatório	string[]	Valores: `card`, `pix` 1 a n itens
`payment_method_type` obrigatório	string \| null
`description` obrigatório	string \| null
`metadata` obrigatório	mapa de string
`payer` obrigatório	PayerView \| null
`next_action` obrigatório	PaymentNextAction \| null
`expires_at` obrigatório	string \| null
`cancellation_reason` obrigatório	string \| null

Resposta 202

O provedor ainda não tem resultado definitivo.

Objeto PaymentIntent

Resposta 202 de reconcilePaymentIntent
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pi_`
`order_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`provider_id` obrigatório	string
`latest_provider_attempt_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null
`payment_method_types` obrigatório	string[]	Valores: `card`, `pix` 1 a n itens
`payment_method_type` obrigatório	string \| null
`description` obrigatório	string \| null
`metadata` obrigatório	mapa de string
`payer` obrigatório	PayerView \| null
`next_action` obrigatório	PaymentNextAction \| null
`expires_at` obrigatório	string \| null
`cancellation_reason` obrigatório	string \| null

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
402 — PAYMENT_DECLINED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/simulator/refunds/{id}/reconcile

Reconciliar reembolso agora (reconcileRefund)

só na edição de simulação rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: payments:write
URL: https://api.v2.wolfpayteste.online/v1/simulator/refunds/{id}/reconcile

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do reembolso (`rfd_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do reembolso (rfd_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Resultado definitivo aplicado.

Objeto Refund

Resposta 200 de reconcileRefund
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `rfd_`
`payment_intent_id` obrigatório	string	Começa com `pi_`
`charge_id` obrigatório	string	Começa com `chg_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `created`, `processing`, `succeeded`, `failed`, `unknown`
`provider_id` obrigatório	string
`external_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null

Resposta 202

O provedor ainda não tem resultado definitivo.

Objeto Refund

Resposta 202 de reconcileRefund
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `rfd_`
`payment_intent_id` obrigatório	string	Começa com `pi_`
`charge_id` obrigatório	string	Começa com `chg_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `created`, `processing`, `succeeded`, `failed`, `unknown`
`provider_id` obrigatório	string
`external_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — REFUND_FAILED,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR