Struct CreateOnrampSessionBody 

pub struct CreateOnrampSessionBody {
    pub client_ip: Option<String>,
    pub country: Option<String>,
    pub destination_address: String,
    pub destination_network: String,
    pub payment_amount: Option<String>,
    pub payment_currency: Option<String>,
    pub payment_method: Option<OnrampQuotePaymentMethodTypeId>,
    pub purchase_currency: String,
    pub redirect_url: Option<String>,
    pub subdivision: Option<String>,
}

CreateOnrampSessionBody

JSON schema

{
 "type": "object",
 "required": [
   "destinationAddress",
   "destinationNetwork",
   "purchaseCurrency"
 ],
 "properties": {
   "clientIp": {
     "description": "The IP address of the end user requesting the onramp transaction.",
     "examples": [
       "127.0.0.1"
     ],
     "type": "string"
   },
   "country": {
     "description": "The ISO 3166-1 two letter country code (e.g. US).",
     "examples": [
       "US"
     ],
     "type": "string"
   },
   "destinationAddress": {
     "description": "The address the purchased crypto will be sent to.",
     "examples": [
       "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
     ],
     "type": "string"
   },
   "destinationNetwork": {
     "description": "The name of the crypto network the purchased currency will be sent on.\n\nUse the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported networks for your user's location.",
     "examples": [
       "base"
     ],
     "type": "string"
   },
   "paymentAmount": {
     "description": "A string representing the amount of fiat the user wishes to pay in exchange for crypto.",
     "examples": [
       "100.00"
     ],
     "type": "string"
   },
   "paymentCurrency": {
     "description": "The fiat currency to be converted to crypto.",
     "examples": [
       "USD"
     ],
     "type": "string"
   },
   "paymentMethod": {
     "$ref": "#/components/schemas/OnrampQuotePaymentMethodTypeId"
   },
   "purchaseCurrency": {
     "description": "The ticker (e.g. `BTC`, `USDC`, `SOL`) or the Coinbase UUID (e.g. `d85dce9b-5b73-5c3c-8978-522ce1d1c1b4`)  of the crypto asset to be purchased.\n\nUse the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported purchase currencies for your user's location.",
     "examples": [
       "USDC"
     ],
     "type": "string"
   },
   "redirectUrl": {
     "description": "URL to redirect the user to when they successfully complete a transaction. This URL will be  embedded in the returned onramp URL as a query parameter.",
     "examples": [
       "https://yourapp.com/success"
     ],
     "type": "string"
   },
   "subdivision": {
     "description": "The ISO 3166-2 two letter state code (e.g. NY). Only required for US.",
     "examples": [
       "NY"
     ],
     "type": "string"
   }
 }
}

Fields

client_ip: Option<String>

The IP address of the end user requesting the onramp transaction.

country: Option<String>

The ISO 3166-1 two letter country code (e.g. US).

destination_address: String

The address the purchased crypto will be sent to.

destination_network: String

The name of the crypto network the purchased currency will be sent on.

    Use the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported networks for your user's location.

payment_amount: Option<String>

A string representing the amount of fiat the user wishes to pay in exchange for crypto.

payment_currency: Option<String>

The fiat currency to be converted to crypto.

payment_method: Option<OnrampQuotePaymentMethodTypeId>

purchase_currency: String

The ticker (e.g. BTC, USDC, SOL) or the Coinbase UUID (e.g. d85dce9b-5b73-5c3c-8978-522ce1d1c1b4) of the crypto asset to be purchased.

    Use the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported purchase currencies for your user's location.

redirect_url: Option<String>

URL to redirect the user to when they successfully complete a transaction. This URL will be embedded in the returned onramp URL as a query parameter.

subdivision: Option<String>

The ISO 3166-2 two letter state code (e.g. NY). Only required for US.

Implementations

impl CreateOnrampSessionBody

pub fn builder() -> CreateOnrampSessionBody

Trait Implementations

impl Clone for CreateOnrampSessionBody

fn clone(&self) -> CreateOnrampSessionBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateOnrampSessionBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateOnrampSessionBody

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CreateOnrampSessionBody> for CreateOnrampSessionBody

fn from(value: &CreateOnrampSessionBody) -> Self

Converts to this type from the input type.

impl From<CreateOnrampSessionBody> for CreateOnrampSessionBody

fn from(value: CreateOnrampSessionBody) -> Self

Converts to this type from the input type.

impl Serialize for CreateOnrampSessionBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateOnrampSessionBody> for CreateOnrampSessionBody

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: CreateOnrampSessionBody) -> Result<Self, ConversionError>

Performs the conversion.