Skip to navigation

Create a top-up payment link

View as Markdown

Creates a Stripe Checkout link for the amount plus a 5% service fee. Creating the link does not add funds; the wallet is credited only after payment completes. Requires the topup scope. An agent should hand the link to the user, never pay it itself.

Authentication

AuthorizationBearer
An AgentRouter API key or an OAuth access token issued to an MCP host or the CLI.

Request

This endpoint expects an object.
amount_usdstringRequiredformat: "^-?[0-9]+(\.[0-9]+)?$"

Amount added to the wallet (default limits $5-$10,000, whole cents).

Response

The pending top-up and its checkout link

topup_idstring
statusenum
Allowed values:
amount_usdstringformat: "^-?[0-9]+(\.[0-9]+)?$"
Exact USD amount as a decimal string.
fee_usdstringformat: "^-?[0-9]+(\.[0-9]+)?$"
Exact USD amount as a decimal string.
total_usdstringformat: "^-?[0-9]+(\.[0-9]+)?$"
Exact USD amount as a decimal string.
created_atstring
completed_atstring or null
checkout_urlstring
Give this link to the user. Funds arrive only after payment completes.
quoteobject

Errors

400
Bad Request Error
503
Service Unavailable Error