Coinbase Server Wallet icon

Coinbase Server Wallet

Interact with Coinbase Server Wallet API v2 (EVM & Solana)

Actions61

Onramp → Create Onramp Session

AI-generated

Summary

Create an onramp session for purchasing cryptocurrency using specified payment details.

Inputs

  • purchaseCurrency (required) — The ticker or UUID of the crypto asset to be purchased (e.g., BTC, USDC).
  • destinationNetwork (required) — The name of the crypto network for the purchased currency.
  • destinationAddress (required) — The address where the purchased crypto will be sent.
  • paymentAmount — The amount of fiat the user wishes to pay for the crypto.
  • paymentCurrency — The fiat currency to be converted to crypto.
  • paymentMethod — The payment method used to generate the onramp quote.
  • country — The ISO 3166-1 two-letter country code (e.g., US).
  • subdivision — The ISO 3166-2 two-letter state code (e.g., NY). Only required for US.
  • redirectUrl — URL to redirect after successful transaction.
  • clientIp — The IP address of the end user requesting the onramp transaction.
  • requestOptions — Additional options for handling requests, including batching and timeout settings.

Output shape

a single record containing the onramp session details and a redirection URL for the user

The output includes the generated onramp URL that users will follow to complete their purchase.

Discussion