API Reference
  1. Venit PIX Payment API
  2. Withdrawals (PIX OUT)

Criar Saque

post
https://api.venitip.com.br/functions/v1/withdrawals/cashout

Cria uma nova solicitação de saque via PIX.

⚠️ Importante

  • Use sempre o header Idempotency-Key para evitar saques duplicados
  • Valores devem ser enviados em centavos (ex: 254 = R$ 2,54)
  • O postbackUrl é opcional mas recomendado para receber notificações

Status possíveis na criação

  • pending - Aguardando aprovação manual

  • approved - Aprovado automaticamente para processamento

  • failed - Falha na criação do saque

  • refused - Recusado

  • cancelled - Cancelado

  • processing - Em processamento

Casos de erro comuns

  • 400 - Dados inválidos (chave PIX, valor, etc.)
  • 401 - Credenciais inválidas
  • 429 - Muitas requisições (aguarde 10 segundos)
  • 500 - Erro interno do servidor
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Tipo da chave PIX.

  • CPF - CPF (11 dígitos)
  • CNPJ - CNPJ (14 dígitos)
  • EMAIL - Endereço de EMAIL válido
  • PHONE - Telefone com código do país (+55XXXXXXXXXXX)
  • EVP - Chave aleatória (UUID)
Allowed:
string
required
length between 1 and 255

Valor da chave PIX correspondente ao tipo especificado.

Formatos por tipo:

  • CPF: 11 dígitos (apenas números) - Ex: 99999999999
  • CNPJ: 14 dígitos (apenas números) - Ex: 11222333000181
  • Email: Formato válido - Ex: [email protected]
  • Telefone: Com código do país - Ex: +5511999999999
  • EVP: UUID v4 - Ex: 123e4567-e89b-12d3-a456-426614174000
integer
required
≥ 1

Valor do saque em centavos.

Exemplos:

  • R$ 1,00 = 100
  • R$ 2,54 = 254
  • R$ 100,00 = 10000

Limites:

  • Mínimo: Definido pela configuração da empresa
  • Máximo: Definido pela configuração da empresa
string
length ≤ 255

Descrição opcional do saque.

Útil para identificação e reconciliação posterior.

boolean
required

Indica se é uma transferência da carteira de PIX.

true para carteira de PIX e false para carteira de Cartão.

uri

URL para receber webhooks sobre mudanças de status do saque.

Eventos enviados:

  • withdrawal.created - Saque criado
  • withdrawal.status_changed - Status alterado
  • withdrawal.completed - Saque concluído
  • withdrawal.failed - Saque falhou

Importante: A URL deve aceitar requisições POST e responder com status 200.

Headers
uuid
required

Chave única para garantir idempotência. Use UUID v4.

Importante: Se a mesma chave for enviada novamente, a API retornará o resultado da primeira requisição.

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?