Skip to main content
POST
Simular transacao (Sandbox)
This endpoint is only available in the Sandbox environment. It does not work with Production credentials.
Simulates a status change for a transaction, allowing you to test your integration without real payments.
Simulating a status change triggers webhooks normally. If the transaction has a callbackUrl, the corresponding webhook will be delivered.

Authorizations

Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Path Parameters

transactionId
string<uuid>
required

ID da transacao

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
action
enum<string>
required

Acao a simular

Available options:
complete,
expire,
fail,
refund
Example:

"complete"

Response

Simulacao realizada

data
object | null
message
string | null
error
object | null