Skip to main content
POST
Simulate a Pix Automático Event
Disponível só no sandbox (https://api.sandbox.pagou.ai). Em produção a rota responde 404. No sandbox não existe banco do pagador para autorizar o QR code nem para debitar cada ciclo, então este endpoint faz isso por você. Envie um event por chamada: authorize, reject, pay ou fail. A assinatura muda exatamente como mudaria em produção, e você recebe os mesmos webhooks subscription.*. Funciona só em assinaturas com Pix Automático criadas no sandbox. Um evento que não cabe na autorização ou no status atual responde 409 com SUBSCRIPTION_SIMULATION_NOT_APPLICABLE. Veja Assinaturas com Pix Automático → Sandbox para o que cada evento faz.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string<uuid>
obrigatório

Public subscription id (UUID).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Corpo

application/json
event
enum<string>
obrigatório

authorize: the payer approves the recurring authorization (without a trial, the first cycle is paid too). reject: the payer refuses it. pay: the next debit is paid. fail: the next debit fails.

Opções disponíveis:
authorize,
reject,
pay,
fail

Resposta

Success

success
boolean
obrigatório
requestId
string
obrigatório
data
object
obrigatório