v10

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

Saques

Simular saque (Sandbox)

Simula o processamento de um saque no ambiente Sandbox.

post/v1/cashouts/{id}/simulate

Path parameters

idstring uuid required

Example:b2c3d4e5-f6a7-8901-bcde-f23456789012

ID do saque

Request body

action1 | 2 | 3 required

Acao: 1=Complete, 2=Fail, 3=Reject

Example request

{
  "action": 1
}

Response

Simulacao realizada

messagestring nullable

Example response

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "externalId": "saque_001",
    "amount": 50000,
    "fee": 200,
    "netAmount": 49800,
    "currency": "BRL",
    "status": "Completed",
    "environment": "Sandbox",
    "pix": {
      "pixKeyType": "CPF",
      "pixKey": "***456789**",
      "endToEndId": "E12345678202501151600xyz789abc012",
      "acquirerTransactionId": "SANDBOX_TXN_001"
    },
    "requestedAt": "2025-01-15T16:00:00Z",
    "processedAt": "2025-01-15T16:02:00Z",
    "completedAt": "2025-01-15T16:05:00Z",
    "createdAt": "2025-01-15T16:00:00Z"
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}