OnrampOrder

Struct OnrampOrder 

Source
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§

Trait Implementations§

Source§

impl Clone for OnrampOrder

Source§

fn clone(&self) -> OnrampOrder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OnrampOrder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OnrampOrder

Source§

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

Source§

fn from(value: &OnrampOrder) -> Self

Converts to this type from the input type.
Source§

impl From<OnrampOrder> for OnrampOrder

Source§

fn from(value: OnrampOrder) -> Self

Converts to this type from the input type.
Source§

impl Serialize for OnrampOrder

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<OnrampOrder> for OnrampOrder

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,