pub struct OnrampOrder {Show 15 fields
pub created_at: String,
pub destination_address: String,
pub destination_network: String,
pub exchange_rate: String,
pub fees: Vec<OnrampOrderFee>,
pub order_id: 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"
],
"type": "string"
},
"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"
},
"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: String
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.
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.
status: OnrampOrderStatus
§tx_hash: Option<String>
The transaction hash of the order (only available once crypto has been sent).
updated_at: String
The date and time the order was last updated.
Implementations§
Source§impl OnrampOrder
impl OnrampOrder
pub fn builder() -> OnrampOrder
Trait Implementations§
Source§impl Clone for OnrampOrder
impl Clone for OnrampOrder
Source§fn clone(&self) -> OnrampOrder
fn clone(&self) -> OnrampOrder
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for OnrampOrder
impl Debug for OnrampOrder
Source§impl<'de> Deserialize<'de> for OnrampOrder
impl<'de> Deserialize<'de> for OnrampOrder
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl From<&OnrampOrder> for OnrampOrder
impl From<&OnrampOrder> for OnrampOrder
Source§fn from(value: &OnrampOrder) -> Self
fn from(value: &OnrampOrder) -> Self
Converts to this type from the input type.
Source§impl From<OnrampOrder> for OnrampOrder
impl From<OnrampOrder> for OnrampOrder
Source§fn from(value: OnrampOrder) -> Self
fn from(value: OnrampOrder) -> Self
Converts to this type from the input type.
Source§impl Serialize for OnrampOrder
impl Serialize for OnrampOrder
Source§impl TryFrom<OnrampOrder> for OnrampOrder
impl TryFrom<OnrampOrder> for OnrampOrder
Source§type Error = ConversionError
type Error = ConversionError
The type returned in the event of a conversion error.
Source§fn try_from(value: OnrampOrder) -> Result<Self, ConversionError>
fn try_from(value: OnrampOrder) -> Result<Self, ConversionError>
Performs the conversion.
Auto Trait Implementations§
impl Freeze for OnrampOrder
impl RefUnwindSafe for OnrampOrder
impl Send for OnrampOrder
impl Sync for OnrampOrder
impl Unpin for OnrampOrder
impl UnwindSafe for OnrampOrder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more