v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB

SDK

Generate a Coinbase onramp buy URL

post/sdk/{environmentId}/onramps/coinbase/buy

Path parameters

environmentIdstring required

Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

assetsNonEmptyStringWith50MaxLength[]

defaultNetworkstring

defaultAssetstring

defaultExperience'buy' | 'send'

Default visual experience. Either transfer funds from Coinbase (send) or buy assets (buy)

defaultPaymentMethodstring

destinationAddressstring required

Valid blockchain wallet address, must be an alphanumeric string without any special characters

fiatCurrencystring

handlingRequestedUrlsboolean

Prevents the widget from opening URLs directly & relies on onRequestedUrl entirely for opening links

networksNonEmptyStringWith50MaxLength[] required

partnerUserRefstring

presetCryptoAmountstring

Digits with optional decimal part

presetFiatAmountstring

Digits with optional decimal part

redirectUrlstring

Example request

{
  "assets": [
    "An example name"
  ],
  "defaultNetwork": "An example name",
  "defaultAsset": "An example name",
  "defaultPaymentMethod": "An example name",
  "destinationAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
  "fiatCurrency": "An example name",
  "networks": [
    "An example name"
  ],
  "partnerUserRef": "An example name",
  "presetCryptoAmount": "100.00",
  "presetFiatAmount": "100.00",
  "redirectUrl": "https://website-sample.com"
}

Response

Successfully generated a Coinbase onramp buy URL

urlstring required

The URL to the hosted widget the user should be redirected to.