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
},
"crypto": 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
}{
"data": null,
"message": null,
"error": {
"message": "Saldo insuficiente para realizar o saque.",
"code": "insufficient_balance"
}
}{
"data": null,
"message": null,
"error": {
"message": "Token invalido ou expirado.",
"code": "unauthorized"
}
}{
"data": null,
"message": null,
"error": {
"message": "Erro ao processar o saque. Tente novamente.",
"code": "internal_error"
}
}Saques
Solicitar saque
Solicite um saque PIX ou para uma carteira cripto
POST
/
v1
/
cashouts
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
},
"crypto": 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
}{
"data": null,
"message": null,
"error": {
"message": "Saldo insuficiente para realizar o saque.",
"code": "insufficient_balance"
}
}{
"data": null,
"message": null,
"error": {
"message": "Token invalido ou expirado.",
"code": "unauthorized"
}
}{
"data": null,
"message": null,
"error": {
"message": "Erro ao processar o saque. Tente novamente.",
"code": "internal_error"
}
}Solicita um saque do saldo disponível para uma chave PIX ou para uma carteira cripto previamente cadastrada e verificada.
Informe exatamente um dos destinos:
pixKeyType+pixKeypara saque PIX;cryptoPayoutAccountIdpara saque cripto via XGate.
Carteiras cripto precisam ser cadastradas e verificadas no painel Safefy antes do saque. A API não aceita um endereço de carteira arbitrário no corpo da requisição.
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
Token JWT obtido via /v1/auth/token
Corpo
application/json
- Option 1
- Option 2
Valor do saque em centavos. Exemplo: R$ 500,00 = 50000.
Exemplo:
50000
Tipo da chave PIX de destino.
Opções disponíveis:
CPF, CNPJ, Email, Phone, Random Exemplo:
"CPF"
Chave PIX de destino.
Exemplo:
"12345678901"
ID de uma carteira cripto ativa e verificada. Exclusivo com pixKeyType/pixKey; a XGate é selecionada automaticamente.
Exemplo:
"8d08f5d2-c6f6-4df9-b42f-6944aec3b177"
ID externo no seu sistema para referencia cruzada.
Exemplo:
"saque_001"
URL para receber webhooks de atualizacao de status do saque.
Exemplo:
"https://seusite.com.br/webhook/cashout"