Pular para o conteúdo principal
POST
/
v1
/
cashouts
/
{id}
/
simulate
Simular saque (Sandbox)
curl --request POST \
  --url https://api-payment.safefypay.com.br/v1/cashouts/{id}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": 1
}'
{
  "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",
    "failureReason": null,
    "createdAt": "2025-01-15T16:00:00Z"
  },
  "message": "Saque simulado com sucesso.",
  "error": null
}
Simula o processamento de um saque no ambiente Sandbox. Use para testar fluxos de saque sem dinheiro real.
Disponivel apenas no ambiente Sandbox.

​
Parametros de Path

​
id
string
obrigatório
ID do saque (UUID).

​
Parametros de Body

​
action
integer
obrigatório
Acao a simular:
  • 1 - Simula conclusao com sucesso (Completed)
  • 2 - Simula falha (Failed)
  • 3 - Simula rejeicao (Rejected)

Autorizações

​
Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de caminho

​
id
string<uuid>
obrigatório

ID do saque

Exemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

Corpo

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

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

Opções disponíveis:
1,
2,
3
Exemplo:

1

Resposta

Simulacao realizada

​
data
object
​
message
string | null
​
error
object