Pular para o conteúdo principal
POST
/
v1
/
transactions
/
{transactionId}
/
simulate
Simular transacao (Sandbox)
curl --request POST \
  --url https://api-payment.safefypay.com.br/v1/transactions/{transactionId}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "complete"
}
'
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "Completed",
    "simulatedAction": "complete",
    "completedAt": "2025-01-15T15:10:00Z",
    "refundedAt": null,
    "pix": {
      "txId": "SAFEFY2025011512345678901234",
      "qrCode": null,
      "copyAndPaste": null,
      "expiresAt": null
    }
  },
  "message": "Transacao simulada com sucesso.",
  "error": null
}
Simula acoes em uma transacao no ambiente Sandbox. Use para testar fluxos de pagamento sem dinheiro real.
Disponivel apenas no ambiente Sandbox.

​
Parametros de Path

​
transactionId
string
obrigatório
ID da transacao (UUID).

​
Parametros de Body

​
action
string
obrigatório
Acao a simular:
  • pay - Simula o pagamento (muda status para Completed)
  • expire - Simula expiracao (muda status para Expired)
  • fail - Simula falha (muda status para Failed)
  • refund - Simula estorno (muda status para Refunded)
A simulacao dispara webhooks normalmente, permitindo testar seu endpoint de callback.

Autorizações

​
Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de caminho

​
transactionId
string<uuid>
obrigatório

ID da transacao

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Corpo

application/json
​
action
enum<string>
obrigatório

Acao a simular

Opções disponíveis:
complete,
expire,
fail,
refund
Exemplo:

"complete"

Resposta

Simulacao realizada

​
data
object
​
message
string | null
​
error
object