v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB

Transacoes

Simular transacao (Sandbox)

Simula acoes em uma transacao no ambiente Sandbox.

post/v1/transactions/{transactionId}/simulate

Path parameters

transactionIdstring uuid required

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

ID da transacao

Request body

action'complete' | 'expire' | 'fail' | 'refund' required

Acao a simular

Example request

{
  "action": "complete"
}

Response

Simulacao realizada

messagestring nullable

Example response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "Completed",
    "simulatedAction": "complete",
    "completedAt": "2025-01-15T15:10:00Z",
    "pix": {
      "txId": "SAFEFY2025011512345678901234",
      "copyAndPaste": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890...",
      "expiresAt": "2025-01-15T15:30:00Z"
    }
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}