Skip to main content

Solicitar Saque

Utilize este endpoint para enviar fundos da sua conta para o cliente ou parceiro.

Ambientes Disponíveis

https://api.unoip.com.br

Endpoint

  • Método: POST
  • Endpoint: /withdrawal
  • Autenticação: Bearer token

Request Body

⚠️ Importante: Valores em Centavos

Todos os valores monetários (amount) devem ser enviados em centavos como números inteiros.

Exemplos:

  • R$ 10,00 = 1000
  • R$ 99,99 = 9999
  • R$ 100,50 = 10050

NÃO use: 99.99, 10.00, valores negativos USE: 9999, 1000 (sempre inteiros)

NomeTipoObrigatórioDescriçãoValidações
amountnumberSimValor do saque (inteiro em centavos)Deve ser inteiro em centavos; mínimo 10 (R$ 0,10) e máximo 10000000 (R$ 100.000,00)
pixKeystringSimChave PIX de destinoDeve ser validada conforme o pixKeyType informado:
  • CPF: 11 dígitos
  • CNPJ: 14 dígitos
  • EMAIL: formato válido
  • PHONE: formato brasileiro (+5511999999999)
  • EVP: UUID válido
pixKeyTypestring (enum) - CPF, CNPJ, EMAIL, PHONE, EVPSimTipo da chaveDeve ser um enum válido
webhookUrlstring (URL)NãoURL HTTPS para receber notificaçõesDeve ser URL válida com https obrigatório; sem fragmento (#); host e TLD obrigatórios; query permitida
externalCodestringNãoSeu código de referênciaDeve ter entre 8 e 255 caracteres
idempotencyKeystringNãoIdentificador único para evitar duplicaçõesDeve ter entre 8 e 255 caracteres

Exemplo de Requisição

curl --request POST \
--url https://api.unoip.com..br/withdrawal \
--header 'Authorization: Bearer seu-token-jwt' \
--header 'Content-Type: application/json' \
--data '{
"amount": 10000,
"pixKey": "12345678910",
"pixKeyType": "CPF",
"webhookUrl": "https://sua-api.com/webhooks/withdrawal",
"externalCode": "SAQUE-123",
"idempotencyKey": "unique-key-12345"
}'

Resposta de Sucesso

CampoTipoObrigatórioDescrição
idstring (UUID)SimIdentificador único do saque
externalCodestringNãoSeu código de referência
amountnumberSimValor do saque (inteiro em centavos)
statusstring (enum) - PENDINGSim
  • PENDING: Saque criado, aguardando processamento

Exemplo de Resposta

{
"id": "553e8400-e29b-41d4-a716-436251480000",
"externalCode": "SAQUE-123",
"amount": 10000,
"status": "PENDING"
}

Possíveis Erros

CódigoDescriçãoSolução
401Credenciais inválidasVerifique suas credenciais
403Sem permissão/autorizaçãoContate o suporte
422Dados inválidos ou faltandoVerifique o formato dos dados
422ValidaçõesContate o suporte
429Muitas requisiçõesAguarde e tente novamente
500Erro internoContate o suporte