Skip to main content
Renamed from fund_wallet in July 2026; the old name keeps working until August 20, 2026.
Adds money to the user’s cash balance. It returns a secure checkout link the user opens to pay with Apple Pay, Google Pay, or card — calling the tool moves no money itself. Use it when the balance is too low for what the agent needs to do next.

Parameters

Returns

An onramp session summary with a checkout URL the user must open to complete payment; check the updated balance with get_balance once payment completes. If the user has no balance yet, the response asks you to call get_balance first, since that provisions the account automatically. It also explains clearly when the amount is outside the allowed range. Funding reuses the user’s completed identity verification — there’s no separate verification step inside checkout. If the user isn’t verified yet, add_funds returns kyc_required: run start_kyc, poll get_kyc_status until verified, then retry. For an already-verified user no extra step is needed — the checkout link comes back directly. If the account is phone-only, funding may return email_required (add an email with link_account first, since a contact email is needed on the order).

Example