CoinbaseOnrampOrderCreateRequest

agreementAcceptedAt · string<date-time> · required

The timestamp of when the user acknowledged that by using Coinbase Onramp they are accepting the Coinbase Terms (https://www.coinbase.com/legal/guest-checkout/us), User Agreement (https://www.coinbase.com/legal/user_agreement),and Privacy Policy (https://www.coinbase.com/legal/privacy).

Example:

"2025-04-24T00:00:00.000Z"

destinationAddress · string · required

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

Maximum string length: 255

Pattern: ^[A-Za-z0-9]{18,100}$

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

destinationNetwork · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

partnerUserRef · string · required

Maximum string length: 255

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

paymentCurrency · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

paymentMethod · enum<string> · required

The type of payment method to be used to complete an onramp order.

Available options: GUEST_CHECKOUT_APPLE_PAY

purchaseCurrency · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

domain · string

An RFC 6454 valid url. Must not include any paths. A single wildcard (*) can be used as the first subdomain.

Pattern: ^(https?|chrome-extension|moz-extension):\/\/(?!.*(\*).*(\*).*)[*a-zA-Z0-9._-]{1,256}(:[*0-9]{1,5})?$

Example:

"http://*.example.com"

isQuote · boolean · default: false

If true, this API will return a quote without creating any transaction.

paymentAmount · string

Digits with optional decimal part

Pattern: ^(\d+(\.\d+)?|\.\d+)$

Example:

"100.00"

purchaseAmount · string

Digits with optional decimal part

Pattern: ^(\d+(\.\d+)?|\.\d+)$

Example:

"100.00"