cdp_sdk::api::types

Struct OnrampOrder

pub struct OnrampOrder {Show 17 fields
    pub created_at: String,
    pub destination_address: BlockchainAddress,
    pub destination_network: String,
    pub exchange_rate: String,
    pub fees: Vec<OnrampOrderFee>,
    pub order_id: String,
    pub partner_id: Option<String>,
    pub partner_user_ref: Option<String>,
    pub payment_currency: String,
    pub payment_method: OnrampOrderPaymentMethodTypeId,
    pub payment_subtotal: String,
    pub payment_total: String,
    pub purchase_amount: String,
    pub purchase_currency: String,
    pub status: OnrampOrderStatus,
    pub tx_hash: Option<String>,
    pub updated_at: String,
}

Expand description

An Onramp order.

JSON schema

{
 "description": "An Onramp order.",
 "type": "object",
 "required": [
   "createdAt",
   "destinationAddress",
   "destinationNetwork",
   "exchangeRate",
   "fees",
   "orderId",
   "paymentCurrency",
   "paymentMethod",
   "paymentSubtotal",
   "paymentTotal",
   "purchaseAmount",
   "purchaseCurrency",
   "status",
   "updatedAt"
 ],
 "properties": {
   "createdAt": {
     "description": "The date and time the order was created.",
     "examples": [
       "2025-04-24T00:00:00Z"
     ],
     "type": "string"
   },
   "destinationAddress": {
     "description": "The destination address to send the crypto to.",
     "examples": [
       "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/BlockchainAddress"
       }
     ]
   },
   "destinationNetwork": {
     "description": "The network to send the crypto on.",
     "examples": [
       "base"
     ],
     "type": "string"
   },
   "exchangeRate": {
     "description": "The exchange rate used to convert fiat to crypto i.e. the crypto value of one fiat.",
     "examples": [
       "1"
     ],
     "type": "string"
   },
   "fees": {
     "description": "The fees associated with the order.",
     "examples": [
       [
         {
           "amount": "0.5",
           "currency": "USD",
           "type": "FEE_TYPE_EXCHANGE"
         },
         {
           "amount": "0.25",
           "currency": "USD",
           "type": "FEE_TYPE_NETWORK"
         }
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/OnrampOrderFee"
     }
   },
   "orderId": {
     "description": "The ID of the onramp order.",
     "examples": [
       "123e4567-e89b-12d3-a456-426614174000"
     ],
     "type": "string"
   },
   "partnerId": {
     "description": "The Onramp-issued identifier of the end partner this order was scoped to via the X-Onramp-Partner-Id header. Only present for orders created by an aggregator on behalf of a registered end partner.",
     "examples": [
       "1f1c19e8-d0e9-6443-b706-92a4d033d043"
     ],
     "type": "string"
   },
   "partnerUserRef": {
     "description": "The partner user reference ID.",
     "examples": [
       "user123"
     ],
     "type": "string"
   },
   "paymentCurrency": {
     "description": "The fiat currency to be converted to crypto.",
     "examples": [
       "USD"
     ],
     "type": "string"
   },
   "paymentMethod": {
     "$ref": "#/components/schemas/OnrampOrderPaymentMethodTypeId"
   },
   "paymentSubtotal": {
     "description": "The amount of fiat to be converted to crypto.",
     "examples": [
       "100"
     ],
     "type": "string"
   },
   "paymentTotal": {
     "description": "The total amount of fiat to be paid, inclusive of any fees.",
     "examples": [
       "100.75"
     ],
     "type": "string"
   },
   "purchaseAmount": {
     "description": "The amount of crypto to be purchased.",
     "examples": [
       "100.000000"
     ],
     "type": "string"
   },
   "purchaseCurrency": {
     "description": "The crypto currency to be purchased.",
     "examples": [
       "USDC"
     ],
     "type": "string"
   },
   "status": {
     "$ref": "#/components/schemas/OnrampOrderStatus"
   },
   "txHash": {
     "description": "The transaction hash of the order (only available once crypto has been sent).",
     "examples": [
       "0x363cd3b3d4f49497cf5076150cd709307b90e9fc897fdd623546ea7b9313cecb"
     ],
     "type": "string"
   },
   "updatedAt": {
     "description": "The date and time the order was last updated.",
     "examples": [
       "2025-04-24T00:00:00Z"
     ],
     "type": "string"
   }
 }
}

Fields§

§created_at: String

The date and time the order was created.

§destination_address: BlockchainAddress

The destination address to send the crypto to.

§destination_network: String

The network to send the crypto on.

§exchange_rate: String

The exchange rate used to convert fiat to crypto i.e. the crypto value of one fiat.

§fees: Vec<OnrampOrderFee>

The fees associated with the order.

§order_id: String

The ID of the onramp order.

§partner_id: Option<String>

The Onramp-issued identifier of the end partner this order was scoped to via the X-Onramp-Partner-Id header. Only present for orders created by an aggregator on behalf of a registered end partner.

§partner_user_ref: Option<String>

The partner user reference ID.

§payment_currency: String

The fiat currency to be converted to crypto.

§payment_method: OnrampOrderPaymentMethodTypeId§payment_subtotal: String

The amount of fiat to be converted to crypto.

§payment_total: String

The total amount of fiat to be paid, inclusive of any fees.

§purchase_amount: String

The amount of crypto to be purchased.

§purchase_currency: String

The crypto currency to be purchased.