Enviar PIX (saque)

POST/api/v1/gateway/pix-payment

Envia um PIX do seu saldo para uma chave. O valor e a tarifa de saque são debitados na hora; o saque fica processing até a confirmação e o resultado chega no callbackUrl (sucess ou not paid, com estorno automático do valor e da tarifa).

Antes de usar: libere o saque pela API em Desenvolvedores (exige o PIN). Sem liberação da WeetPay para pagar terceiros, o saque só pode ir para a chave CPF/CNPJ do próprio titular da conta. Acima do valor configurado pela plataforma, o saque passa por aprovação manual antes do envio.

Idempotência: envie o cabeçalho Idempotency-Key (ou requestNumber no corpo). A mesma chave sempre devolve o mesmo saque (resposta com Idempotent-Replayed: true) e nunca debita de novo; a mesma chave com outro valor ou outra chave PIX é recusada com 409. Sem chave, o mesmo valor para a mesma chave PIX em menos de 1 minuto devolve o saque anterior.

Autenticação

vspi<token>

Client ID (ex.: weetpay-100123). Também aceito como x-client-id.

Em: header

vsps<token>

Client secret. Também aceito como x-client-secret. Nunca exponha no front-end.

Em: header

Cabeçalhos

Idempotency-Key?string

Chave única do pedido no seu sistema (também aceita x-idempotency-key). Máximo 100 caracteres.

Tamanholength <= 100

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/gateway/pix-payment" \  -H "Idempotency-Key: saque-2026-10-30-0001" \  -H "Content-Type: application/json" \  -d '{    "amount": 150,    "key": "12345678909",    "typeKey": "CPF",    "document": "12345678909",    "callbackUrl": "https://sualoja.com.br/webhooks/weetpay-saques",    "requestNumber": "saque-0001"  }'
{  "id": "cmh1x9k2m0004ab12xy98zt76",  "status": "processing"}