Skip to main content
POST
/
api
/
withdraws
Criar Saque
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/withdraws \
  --header 'API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amountCents": 5000,
  "pixKey": "joao@example.com",
  "pixKeyType": "email",
  "description": "<string>",
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "message": "Requisicao de saque criada com sucesso",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amountCents": 5000,
    "feeCents": 350,
    "netAmount": 4650,
    "status": "PENDING",
    "pixKeyType": "cpf",
    "pixKey": "<string>",
    "externalId": "<string>",
    "failureReason": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "processedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "failedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
​
amountCents
integer
required

Valor em centavos (min. R$ 1,00)

Required range: 100 <= x <= 10000000
Example:

5000

​
pixKey
string
required

Chave PIX de destino

Example:

"joao@example.com"

​
pixKeyType
enum<string>
required
Available options:
cpf,
cnpj,
email,
phone,
random
Example:

"email"

​
description
string

Descricao opcional

​
idempotencyKey
string<uuid>

Chave de idempotencia — evita criacao duplicada em retentativas

Response

Saque criado com sucesso

​
message
string
Example:

"Requisicao de saque criada com sucesso"

​
data
object