Send PIX (payout)

POST/api/v1/gateway/pix-payment

Sends a PIX from your balance to a PIX key. The amount and payout fee are debited immediately; the payout stays processing until confirmed and the result is sent to callbackUrl (sucess or not paid, with the amount and fee automatically refunded).

Before using it: enable API payouts under Developers (requires your PIN). Unless WeetPay has enabled third-party payouts on your account, payouts can only go to the CPF/CNPJ key of the account holder. Above the platform-defined amount, the payout goes through manual approval before being sent.

Idempotency: send the Idempotency-Key header (or requestNumber in the body). The same key always returns the same payout (response with Idempotent-Replayed: true) and never debits twice; the same key with a different amount or PIX key is rejected with 409. Without a key, the same amount to the same PIX key within 1 minute returns the previous payout.

Authorization

vspi<token>

Client ID (e.g. weetpay-100123). Also accepted as x-client-id.

In: header

vsps<token>

Client secret. Also accepted as x-client-secret. Never expose it in front-end code.

In: header

Header Parameters

Idempotency-Key?string

Unique request key from your system (x-idempotency-key is also accepted). Up to 100 characters.

Lengthlength <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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"}