Skip to main content

CreateOrderParams

Struct CreateOrderParams 

Source
pub struct CreateOrderParams {
    pub amount: i64,
    pub currency: String,
    pub receipt: Option<String>,
    pub notes: Option<Notes>,
    pub payment_capture: Option<u8>,
    pub method: Option<String>,
}
Expand description

Parameters for OrdersClient::create.

Build with CreateOrderParams::new, which takes the two required fields.

Fields§

§amount: i64

Amount in the smallest currency unit (paise for INR). Minimum is 100 (₹1).

§currency: String

ISO 4217 currency code, e.g. INR.

§receipt: Option<String>

Your own reference, typically an internal order id. Max 40 characters.

§notes: Option<Notes>

Metadata to attach; echoed back on the Order and in webhooks.

§payment_capture: Option<u8>

Whether to capture automatically (0) or require explicit capture (1).

Razorpay encodes this as an integer; see CreateOrderParams::manual_capture.

§method: Option<String>

Restrict this order to a single crate::resources::common::PaymentMethod.

Implementations§

Source§

impl CreateOrderParams

Source

pub fn new(amount: i64, currency: impl Into<String>) -> Self

A new order for amount in the smallest unit of currency.

§Examples
use razorpay_api::resources::CreateOrderParams;

// ₹500.00 — amounts are in paise, never rupees.
let params = CreateOrderParams::new(50_000, "INR");
assert_eq!(params.amount, 50_000);
Source

pub fn receipt(self, receipt: impl Into<String>) -> Self

Attach your own reference to this order.

Source

pub fn notes(self, notes: Notes) -> Self

Attach metadata.

Source

pub fn manual_capture(self) -> Self

Require an explicit capture instead of capturing automatically.

Uncaptured payments are auto-refunded by Razorpay after a window, so only choose this if you really do capture later.

Source

pub fn method(self, method: impl Into<String>) -> Self

Restrict the order to a single payment method, e.g. "upi".

Trait Implementations§

Source§

impl Clone for CreateOrderParams

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateOrderParams

Source§

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

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

impl PartialEq for CreateOrderParams

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for CreateOrderParams

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 StructuralPartialEq for CreateOrderParams

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: Sized + 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: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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