# Coinbase Top-Up Links API **Canonical:** https://apis.io/apis/coinbase/coinbase-top-up-links-api/ **Provider:** Coinbase — https://apis.io/providers/coinbase/ **Base URL:** https://api.coinbase.com **Documentation:** https://www.coinbase.com/developer-platform/products/wallet-sdk Coinbase Top-Up Links API is one of 52 APIs that [Coinbase](https://apis.io/providers/coinbase/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 12 JSON Schema definitions. Tagged areas include Top-Up Links. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 12 JSON Schemas. A Top-Up Link is a shareable hosted URL that lets a payer add funds to their balance. Create a link with **Create a Top-Up Link** and share the returned `topUpUrl` only with the intended payer. The URL identifies the link but does not authorize a top-up; the payer must authenticate and approve it. ## Lifecycle The resource is immutable once created. The link expires 24 hours after creation and funds a single purchase: once a purchase succeeds, the link is spent and cannot be used again. A purchase that fails does not consume the link, so the payer can retry until it expires. A link is not bound to a specific payer. There is no GET: the create response and the `acceptance.top_up_link.created` event are the full resource. ## Amounts - `topUpAmount` is the merchant's fixed suggested net amount for the link's single purchase. The payer can change it in the hosted flow. - `orderTotalAmount` is optional presentation context. It does not replace, change, or cap `topUpAmount`. - The funds-added event reports the actual net amount credited by the purchase that spent the link. It is never cumulative. ## Merchant name Supply `customerDisplay.merchantName` to choose the merchant name for a link's hosted page. The supplied value is limited to 128 Unicode code points before surrounding whitespace is removed. If the name is omitted or empty after trimming, the entity's profile name is used. The create response and creation webhook return the resolved name stored on the immutable link. Later profile changes do not change that name. ## Redirects When `redirectUrl` is supplied, its origin must exactly match an allowed origin. The query key `toppedUpAmount` is reserved because the hosted flow appends it before redirecting the payer. The redirect does not represent success or failure; `toppedUpAmount` may be zero, a partial amount, or the full `topUpAmount`. ## Webhooks Subscribers receive `acceptance.top_up_link.created` when the link is created and `acceptance.top_up_link.funds_added` when a purchase credits funds through the link. Because a link funds a single purchase, it produces at most one funds-added event; deliveries can repeat, so deduplicate on `eventId`. ## Operations (1) | Method | Path | Summary | |---|---|---| | POST | `/v2/top-up-links` | Create a Top-Up Link | ## Machine-readable artifacts (21) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/openapi/coinbase-top-up-links-api-openapi.yml - **Documentation** — https://docs.cdp.coinbase.com/coinbase-app/advanced-trade-apis/rest-api - **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/asyncapi/coinbase-advanced-trade-asyncapi.yml - **Documentation** — https://docs.cdp.coinbase.com/exchange/docs/welcome - **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/asyncapi/coinbase-exchange-asyncapi.yml - **Documentation** — https://docs.cdp.coinbase.com/prime/docs/rest-requests - **Documentation** — https://docs.cdp.coinbase.com/onramp/docs/welcome - **Documentation** — https://commerce.coinbase.com/docs/api - **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/asyncapi/coinbase-commerce-webhooks-asyncapi.yml - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-conversion-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-currency-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-payment-method-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-transfer-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-transaction-summary-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-price-book-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-product-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-candle-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-trade-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-order-book-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-trade-2-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/coinbase/refs/heads/main/json-schema/coinbase-profile-schema.json ## Other Coinbase APIs (12) - [Coinbase Wallet SDK](https://apis.io/apis/coinbase/wallet-sdk/) - [Coinbase Data API](https://apis.io/apis/coinbase/data-api/) - [Coinbase AgentKit](https://apis.io/apis/coinbase/agentkit/) - [Coinbase Accounts API](https://apis.io/apis/coinbase/coinbase-accounts-api/) - [Coinbase Activities API](https://apis.io/apis/coinbase/coinbase-activities-api/) - [Coinbase Address Book API](https://apis.io/apis/coinbase/coinbase-address-book-api/) - [Coinbase Allocations API](https://apis.io/apis/coinbase/coinbase-allocations-api/) - [Coinbase Assets API](https://apis.io/apis/coinbase/coinbase-assets-api/) - [Coinbase Balances API](https://apis.io/apis/coinbase/coinbase-balances-api/) - [Coinbase Buy API](https://apis.io/apis/coinbase/coinbase-buy-api/) - [Coinbase Charges API](https://apis.io/apis/coinbase/coinbase-charges-api/) - [Coinbase Checkouts API](https://apis.io/apis/coinbase/coinbase-checkouts-api/) ## Tags Top-Up Links --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/coinbase/coinbase-top-up-links-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/coinbase/.