Struct InvoicePaymentRequest

Source
pub struct InvoicePaymentRequest {
Show 13 fields pub automatic_payment_source: Option<InvoiceAutomaticPaymentSource>, pub card_id: Option<String>, pub computed_amount_money: Option<Money>, pub due_date: Option<String>, pub fixed_amount_requested_money: Option<Money>, pub percentage_requested: Option<String>, pub reminders: Option<Vec<InvoicePaymentReminder>>, pub request_type: Option<InvoiceRequestType>, pub rounding_adjustment_included_money: Option<Money>, pub tipping_enabled: Option<bool>, pub total_completed_amount_money: Option<Money>, pub uid: Option<String>, pub request_method: Option<InvoiceRequestMethod>,
}
Expand description

Represents a payment request for an [Invoice].

Invoices can specify a maximum of 13 payment requests, with up to 12 INSTALLMENT request types. For more information, see Configuring payment requests.

Adding INSTALLMENT payment requests to an invoice requires an Invoices Plus subscription.

Fields§

§automatic_payment_source: Option<InvoiceAutomaticPaymentSource>

The payment method for an automatic payment.

The default value is NONE.

§card_id: Option<String>

The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer, call ListCards and include the customer_id of the invoice recipient.

Min Length: 1, Max Length: 255

§computed_amount_money: Option<Money>

Read only The amount of the payment request, computed using the order amount and information from the various payment request fields (request_type, fixed_amount_requested_money, and percentage_requested).

§due_date: Option<String>

The due date (in the invoice’s time zone) for the payment request, in YYYY-MM-DD format. This field is required to create a payment request. If an automatic_payment_source is defined for the request, Square charges the payment source on this date.

After this date, the invoice becomes overdue. For example, a payment due_date of 2021-03-09 with a timezone of America/Los_Angeles becomes overdue at midnight on March 9 in America/Los_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).

§fixed_amount_requested_money: Option<Money>

If the payment request specifies DEPOSIT or INSTALLMENT as the request_type, this indicates the request amount. You cannot specify this when request_type is BALANCE or when the payment request includes the percentage_requested field.

§percentage_requested: Option<String>

Specifies the amount for the payment request in percentage:

  • When the payment request_type is DEPOSIT, it is the percentage of the order’s total amount.
  • When the payment request_type is INSTALLMENT, it is the percentage of the order’s total less the deposit, if requested. The sum of the percentage_requested in all installment payment requests must be equal to 100.

You cannot specify this when the payment request_type is BALANCE or when the payment request specifies the fixed_amount_requested_money field.

§reminders: Option<Vec<InvoicePaymentReminder>>

A list of one or more reminders to send for the payment request.

§request_type: Option<InvoiceRequestType>

Identifies the payment request type. This type defines how the payment request amount is determined. This field is required to create a payment request.

§rounding_adjustment_included_money: Option<Money>

Read only If the most recent payment was a cash payment in a currency that rounds cash payments (such as, CAD or AUD) and the payment is rounded from computed_amount_money in the payment request, then this field specifies the rounding adjustment applied. This amount might be negative.

§tipping_enabled: Option<bool>

If set to true, the Square-hosted invoice page (the public_url field of the invoice) provides a place for the customer to pay a tip.

This field is allowed only on the final payment request and the payment request_type must be BALANCE or INSTALLMENT.

§total_completed_amount_money: Option<Money>

Read only The amount of money already paid for the specific payment request. This amount might include a rounding adjustment if the most recent invoice payment was in cash in a currency that rounds cash payments (such as, CAD or AUD).

§uid: Option<String>

The Square-generated ID of the payment request in an [Invoice].

Min Length: 1, Max Length: 255

§request_method: Option<InvoiceRequestMethod>
👎Deprecated

Indicates how Square processes the payment request. DEPRECATED at version 2021-01-21. Replaced by the Invoice.delivery_method and InvoicePaymentRequest.automatic_payment_source fields.

One of the following is required when creating an invoice:

(Recommended) The delivery_method field of the invoice. To configure an automatic payment, the automatic_payment_source field of the payment request is also required. This request_method field. Note that invoice objects returned in responses do not include request_method.

Trait Implementations§

Source§

impl Clone for InvoicePaymentRequest

Source§

fn clone(&self) -> InvoicePaymentRequest

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InvoicePaymentRequest

Source§

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

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

impl Default for InvoicePaymentRequest

Source§

fn default() -> InvoicePaymentRequest

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for InvoicePaymentRequest

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 PartialEq for InvoicePaymentRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for InvoicePaymentRequest

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 Eq for InvoicePaymentRequest

Source§

impl StructuralPartialEq for InvoicePaymentRequest

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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,