Solicitar Saque

Solicita um saque do saldo disponivel da empresa. Se a requisicao incluir uma chave PIX (pixKey), ela sera usada prioritariamente.

POST/api/Withdraw/request

Observacao

Se pixKey for omitida, o sistema automaticamente usara a chave PIX cadastrada na conta bancaria (BankAccount) da empresa.

Request Body

Body

{
  "amount": 2500,
  "currency": "BRL",
  "pixKey": "50651470862",
  "pixKeyType": "CPF",
  "description": "Saque teste via chave custom",
  "metadata": { "origem": "n8n", "pedidoId": 123 }
}

Parametros

Parametro	Tipo	Descricao
`amount`*	number	Valor em centavos (2500 = R$ 25,00)
`currency`*	string	Moeda (BRL)
`pixKey`	string	Chave PIX de destino (opcional)
`pixKeyType`	string	Tipo da chave: CPF, CNPJ, EMAIL, PHONE, EVP
`description`	string	Descricao do saque
`metadata`	object	Dados extras para referencia

amount

Obrigatorionumber

Valor em centavos (2500 = R$ 25,00)

currency

Obrigatoriostring

Moeda (BRL)

pixKey

string

Chave PIX de destino (opcional)

pixKeyType

string

Tipo da chave: CPF, CNPJ, EMAIL, PHONE, EVP

description

string

Descricao do saque

metadata

object

Dados extras para referencia

Exemplo cURL

cURL

curl -X POST 'https://vorexy.com/api/Withdraw/request' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: wd_test_pix_custom' \
  -d '{
    "amount": 1000,
    "currency": "BRL",
    "pixKey": "50651470862",
    "pixKeyType": "CPF",
    "description": "Saque R$10 via chave custom",
    "metadata": { "origem": "n8n", "pedidoId": 123 }
  }'