Skip to main content
POST
Simulate a Pix Automático Event
Available only in the sandbox (https://api.sandbox.pagou.ai). In production the route returns 404. In the sandbox there is no payer’s bank to authorize the QR code or debit each cycle, so this endpoint does it for you. Send one event per call: authorize, reject, pay, or fail. The subscription moves exactly as it would in production and you receive the same subscription.* webhooks. It works only on Pix Automático subscriptions created in the sandbox. An event that does not fit the current authorization or status returns 409 with SUBSCRIPTION_SIMULATION_NOT_APPLICABLE. See Pix Automático Subscriptions → Sandbox for what each event does.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

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)$

Body

application/json
event
enum<string>
required

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.

Available options:
authorize,
reject,
pay,
fail

Response

Success

success
boolean
required
requestId
string
required
data
object
required