Skip to main content
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
}
Creates a PIX cashout to the informed destination key. The cashout payload uses only pixKeyType and pixKey as destination.
This endpoint requires credential permission cashouts.write. If cashouts.allowAnyPixKey is disabled, arbitrary PIX destination keys are not allowed.
Always use withdrawNowAvailable from GET /v1/balance. If requiresFullWithdrawalNow is true, the cashout amount must be exactly withdrawNowAvailable.

Authorizations

​
Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Body

application/json
​
amount
integer<int64>
required

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

Example:

50000

​
pixKeyType
enum<string>
required

Tipo da chave PIX de destino.

Available options:
CPF,
CNPJ,
Email,
Phone,
Random
Example:

"CPF"

​
pixKey
string
required

Chave PIX de destino.

Example:

"12345678901"

​
externalId
string | null

ID externo no seu sistema para referencia cruzada.

Example:

"saque_001"

​
callbackUrl
string | null

URL para receber webhooks de atualizacao de status do saque.

Example:

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

Response

Saque solicitado com sucesso

​
data
object
​
message
string | null
​
error
object