Checkout Wallet Deposit
checkout_wallet_depositCreate a hosted checkout session (e.g. Stripe) to deposit funds into your wallet. Returns a checkout URL where you or your user can complete the payment. After successful payment, the wallet is automatically credited. Use this before fund_task if your wallet balance is insufficient. Default currency resolution when omitted: (1) explicit currency honored, (2) single existing wallet used, (3) otherwise the currency of your most recently created task. No stale USD default. Requires authentication.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount to deposit | |
| apiKey | Yes | Your API key (m2m_...) | |
| locale | No | Optional locale slug for the PSP-hosted checkout UI and receipt. Supported: en, nl, de, fr, es, es-419, pt, pt-BR, it, pl. Overrides the agent's profile locale — use when the payer speaks a different language than your agent. | |
| currency | No | Currency code (USD, EUR, etc.). Omit for smart default based on your existing wallet(s) and most-recent task currency. | |
| cancelUrl | No | Optional: URL to redirect to if payment is cancelled | |
| successUrl | No | Optional: URL to redirect to after successful payment |