Actions11
Withdraw → Create
AI-generatedSummary
Create a PIX withdrawal
Inputs
- amount (required) — Withdrawal amount in cents (minimum: 350 = R$ 3.50)
- pixKeyType (required) — PIX key type to receive the withdrawal
- pixKey (required) — PIX key to receive the withdrawal
- externalId (required) — Unique withdrawal identifier in your system
- description — Optional withdrawal description
Output shape
a single withdrawal object representing the created withdrawal
Returns the created withdrawal data; errors are thrown unless continueOnFail is enabled
Examples
Example 1: Create a PIX withdrawal of R$ 10.00 to a CPF key
amount=1000, pixKeyType=CPF, pixKey=123.456.789-01, externalId=withdraw-123, description=Monthly payout