CreateOrderRequest

Struct CreateOrderRequest 

Source
pub struct CreateOrderRequest {
Show 16 fields pub cart: RenderedCart, pub currency_code: CurrencyCode, pub order_id: String, pub available_payment_methods: Vec<AvailablePaymentMethod>, pub billing_phone: Option<String>, pub extensions: Option<OrderExtensions>, pub is_prepayment: bool, pub metadata: Option<String>, pub order_source: Option<OrderSource>, pub preferred_payment_method: Option<PreferredPaymentMethod>, pub public_constructor: Option<String>, pub purpose: Option<String>, pub redirect_urls: Option<MerchantRedirectUrls>, pub risk: Option<MerchantRiskInfo>, pub ttl: Option<u32>, pub uniqr_metadata: Option<UniqrMetadata>,
}
Expand description

Fields§

§cart: RenderedCart

Корзина

§currency_code: CurrencyCode

Трехбуквенный код валюты заказа (ISO 4217)

§order_id: String

Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках

§available_payment_methods: Vec<AvailablePaymentMethod>

Доступные методы оплаты на платежной форме Яндекс Пэй. Если вы интегрируете оплату только одним методом, например, Карта — указывается один метод [“CARD”]. Для платежей по банковским картам и через Сплит необходимо передать: [“CARD”, “SPLIT”].

§billing_phone: Option<String>

Номер телефона клиента. Используется для упрощения авторизации, а также может увеличить вероятность одобрения по Сплиту. Для номера телефона предлагаем использовать формат +71234567890 или 71234567890. В строке допустимо наличие других символов, однако все символы, кроме цифр, игнорируются. Если номер телефона начинается с 8, то он обрабатывается как аналогичный номер, где 8 заменена на +7. Например, такие переданные значения 71234567890, +71234567890, 81234567890, +7 (123) 456-78-90 будут обрабатываться как 71234567890.

§extensions: Option<OrderExtensions>

Дополнительные параметры для оформления офлайн заказа

§is_prepayment: bool

Проводить ли заказ по флоу “отложенно оплаты”. Если параметр установлен в true, то заказ будет оформлятся как заказ с отложенной оплатой, смотри раздел “Способы оплаты и платёжные механики”.

§metadata: Option<String>

Произвольные данные по заказу для внутреннего использования Max length: 2048

§order_source: Option<OrderSource>

Поверхность на которой инициализировали создание заказа Необходимо для последующей аналитики WEBSITE: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте APP: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении CRM: Ссылка на оплату сформирована менеджером в CRM или другой админке CASH_REGISTER: Ссылка на оплату сформирована для отображения на оффлайн-кассе CMS_PLUGIN: Ссылка на оплату сформирована в плагине для CMS

§preferred_payment_method: Option<PreferredPaymentMethod>

Предпочтительный метод оплаты. Переданный метод будет автоматически выбран на форме оплаты, если это не противоречит доступным методам оплаты. По умолчанию - Карта.

§public_constructor: Option<String>

Конструктор предвыбранного плана для оплаты в Сплит. Доступно только по согласованию

§purpose: Option<String>

Назначение платежа

§redirect_urls: Option<MerchantRedirectUrls>

Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца

§risk: Option<MerchantRiskInfo>

Дополнительная информация, наличие которой может увеличить вероятность одобрения по Сплиту. Доступно в полной мере только для онлайн-магазинов.

§ttl: Option<u32>

Параметр определяет время, в течение которого пользователь может воспользоваться ссылкой на форму оплаты заказа. По истечении времени пользователь будет видеть сообщение “Вышло время оплаты”. Если пользователь воспользовался ссылкой до истечения времени, то на завершение оплаты отводится дополнительно 15 минут. Если по истечении дополнительного времени оплата не произошла, заказ считается не оплаченным окончательно. Это отражается в изменении статуса заказа Order.paymentStatus на значение FAILED. Также выполняется отправка уведомления об изменении статуса заказа. Если продавец бронировал товар, то после изменения статуса заказ можно отменить. Время жизни (сек): 180 <= ttl <= 604800 Время жизни (при создании ссылки в личном кабинете, сек): 86400

§uniqr_metadata: Option<UniqrMetadata>

Дополнительные данные uniqr

Implementations§

Source§

impl CreateOrderRequest

Source

pub fn new<'fn_lifetime>() -> CreateOrderRequestBuilder<'fn_lifetime, (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ()>

Creating a builder.

§Required Fields
§cart
  • Type: RenderedCart

Корзина

§order_id
  • Type: Into<String>

Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках

§Optional Fields
§available_payment_methods
  • Type: Vec < AvailablePaymentMethod >
  • Default: vec! [AvailablePaymentMethod::Card]

Доступные методы оплаты на платежной форме Яндекс Пэй. Если вы интегрируете оплату только одним методом, например, Карта — указывается один метод [“CARD”]. Для платежей по банковским картам и через Сплит необходимо передать: [“CARD”, “SPLIT”].

§billing_phone
  • Type: Option < String >
  • Default: None

Номер телефона клиента. Используется для упрощения авторизации, а также может увеличить вероятность одобрения по Сплиту. Для номера телефона предлагаем использовать формат +71234567890 или 71234567890. В строке допустимо наличие других символов, однако все символы, кроме цифр, игнорируются. Если номер телефона начинается с 8, то он обрабатывается как аналогичный номер, где 8 заменена на +7. Например, такие переданные значения 71234567890, +71234567890, 81234567890, +7 (123) 456-78-90 будут обрабатываться как 71234567890.

§currency_code
  • Type: CurrencyCode
  • Default: CurrencyCode :: Rub

Трехбуквенный код валюты заказа (ISO 4217)

§extensions
  • Type: Option < OrderExtensions >
  • Default: None

Дополнительные параметры для оформления офлайн заказа

§is_prepayment
  • Type: bool
  • Default: false

Проводить ли заказ по флоу “отложенно оплаты”. Если параметр установлен в true, то заказ будет оформлятся как заказ с отложенной оплатой, смотри раздел “Способы оплаты и платёжные механики”.

§metadata
  • Type: Option < String >
  • Default: None

Произвольные данные по заказу для внутреннего использования Max length: 2048

§order_source
  • Type: Option < OrderSource >
  • Default: None

Поверхность на которой инициализировали создание заказа Необходимо для последующей аналитики WEBSITE: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте APP: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении CRM: Ссылка на оплату сформирована менеджером в CRM или другой админке CASH_REGISTER: Ссылка на оплату сформирована для отображения на оффлайн-кассе CMS_PLUGIN: Ссылка на оплату сформирована в плагине для CMS

§preferred_payment_method
  • Type: Option < PreferredPaymentMethod >
  • Default: Some(PreferredPaymentMethod :: FullPayment)

Предпочтительный метод оплаты. Переданный метод будет автоматически выбран на форме оплаты, если это не противоречит доступным методам оплаты. По умолчанию - Карта.

§public_constructor
  • Type: Option < String >
  • Default: None

Конструктор предвыбранного плана для оплаты в Сплит. Доступно только по согласованию

§purpose
  • Type: Option < String >
  • Default: None

Назначение платежа

§redirect_urls
  • Type: Option < MerchantRedirectUrls >
  • Default: None

Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца

§risk
  • Type: Option < MerchantRiskInfo >
  • Default: None

Дополнительная информация, наличие которой может увеличить вероятность одобрения по Сплиту. Доступно в полной мере только для онлайн-магазинов.

§ttl
  • Type: Option < u32 >
  • Default: Some(1800)

Параметр определяет время, в течение которого пользователь может воспользоваться ссылкой на форму оплаты заказа. По истечении времени пользователь будет видеть сообщение “Вышло время оплаты”. Если пользователь воспользовался ссылкой до истечения времени, то на завершение оплаты отводится дополнительно 15 минут. Если по истечении дополнительного времени оплата не произошла, заказ считается не оплаченным окончательно. Это отражается в изменении статуса заказа Order.paymentStatus на значение FAILED. Также выполняется отправка уведомления об изменении статуса заказа. Если продавец бронировал товар, то после изменения статуса заказ можно отменить. Время жизни (сек): 180 <= ttl <= 604800 Время жизни (при создании ссылки в личном кабинете, сек): 86400

§uniqr_metadata
  • Type: Option < UniqrMetadata >
  • Default: None

Дополнительные данные uniqr

Trait Implementations§

Source§

impl Clone for CreateOrderRequest

Source§

fn clone(&self) -> CreateOrderRequest

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 CreateOrderRequest

Source§

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

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

impl<'de> Deserialize<'de> for CreateOrderRequest

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 Serialize for CreateOrderRequest

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

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> 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,