API Reference

Criar um novo saque

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

Cria uma nova solicitação de saque PIX ou cartão.

Idempotência

Use o header Idempotency-Key para evitar duplicatas (obrigatório).

Status do Saque

  • pending: Aguardando aprovação manual
  • approved: Aprovado e processado
  • failed: Falhou durante processamento
  • cancelled: Cancelado manualmente
Body Params
uuid

ID da chave PIX salva no sistema (alternativa a pixkeytype + pixkey).
Use OU este campo OU a combinação pixkeytype + pixkey.

string
enum

Tipo da chave PIX. Obrigatório se pixkeyid não for fornecido.

  • cpf: CPF do destinatário
  • cnpj: CNPJ do destinatário
  • email: Email do destinatário
  • phone: Telefone do destinatário
  • evp: Chave aleatória (EVP)
Allowed:
string

Valor da chave PIX. Obrigatório se pixkeyid não for fornecido.
Formato deve estar de acordo com o tipo:

  • CPF: apenas números (11 dígitos)
  • CNPJ: apenas números (14 dígitos)
  • Email: formato válido de email
  • Phone: formato +5511999999999
  • EVP: UUID válido
integer
required
100 to 100000000

Valor solicitado em centavos (R$ 1,00 = 100 centavos).
Deve respeitar os limites mínimo e máximo da empresa.

string
required
length between 1 and 255

Descrição ou motivo do saque

boolean
required

Indica o tipo de saque:

  • true: Saque da carteira PIX
  • false: Saque da carteira de cartão
uri

URL para recebimento de webhooks sobre eventos do saque.
Deve usar HTTPS em produção.

Headers
string
required

Chave única para garantir idempotência da requisição

Responses

Updated 8 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago