Pular para o conteúdo principal
POST
/
v1
/
cashouts
Solicitar saque
curl --request POST \
  --url https://api-payment.safefypay.com.br/v1/cashouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 50000,
  "pixKeyType": "CPF",
  "pixKey": "123.456.789-09"
}
'
{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "externalId": "saque_001",
    "amount": 50000,
    "fee": 200,
    "netAmount": 49800,
    "currency": "BRL",
    "status": "Pending",
    "environment": "Sandbox",
    "pix": {
      "pixKeyType": "CPF",
      "pixKey": "***456789**",
      "endToEndId": null
    },
    "requestedAt": "2025-01-15T16:00:00Z",
    "processedAt": null,
    "completedAt": null,
    "failureReason": null,
    "createdAt": "2025-01-15T16:00:00Z"
  },
  "message": "Saque solicitado com sucesso.",
  "error": null
}
Solicita um saque PIX para a chave informada. O payload de saque usa apenas pixKeyType e pixKey como destino.
Este endpoint depende de permissão de credencial em cashouts.write. Se cashouts.allowAnyPixKey estiver desabilitado, a integração não poderá enviar chave PIX arbitrária.
Para criar saque, use withdrawNowAvailable retornado em GET /v1/balance. Se requiresFullWithdrawalNow for true, o valor do saque deve ser exatamente withdrawNowAvailable.

Autorizações

​
Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Corpo

application/json
​
amount
integer<int64>
obrigatório

Valor do saque em centavos. Exemplo: R$ 500,00 = 50000.

Exemplo:

50000

​
pixKeyType
enum<string>
obrigatório

Tipo da chave PIX de destino.

Opções disponíveis:
CPF,
CNPJ,
Email,
Phone,
Random
Exemplo:

"CPF"

​
pixKey
string
obrigatório

Chave PIX de destino.

Exemplo:

"12345678901"

​
externalId
string | null

ID externo no seu sistema para referencia cruzada.

Exemplo:

"saque_001"

​
callbackUrl
string | null

URL para receber webhooks de atualizacao de status do saque.

Exemplo:

"https://seusite.com.br/webhook/cashout"

Resposta

Saque solicitado com sucesso

​
data
object
​
message
string | null
​
error
object