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
isDEPOSIT
, it is the percentage of the order’s total amount. - When the payment
request_type
isINSTALLMENT
, it is the percentage of the order’s total less the deposit, if requested. The sum of thepercentage_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>
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
impl Clone for InvoicePaymentRequest
Source§fn clone(&self) -> InvoicePaymentRequest
fn clone(&self) -> InvoicePaymentRequest
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for InvoicePaymentRequest
impl Debug for InvoicePaymentRequest
Source§impl Default for InvoicePaymentRequest
impl Default for InvoicePaymentRequest
Source§fn default() -> InvoicePaymentRequest
fn default() -> InvoicePaymentRequest
Source§impl<'de> Deserialize<'de> for InvoicePaymentRequest
impl<'de> Deserialize<'de> for InvoicePaymentRequest
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>,
Source§impl PartialEq for InvoicePaymentRequest
impl PartialEq for InvoicePaymentRequest
Source§impl Serialize for InvoicePaymentRequest
impl Serialize for InvoicePaymentRequest
impl Eq for InvoicePaymentRequest
impl StructuralPartialEq for InvoicePaymentRequest
Auto Trait Implementations§
impl Freeze for InvoicePaymentRequest
impl RefUnwindSafe for InvoicePaymentRequest
impl Send for InvoicePaymentRequest
impl Sync for InvoicePaymentRequest
impl Unpin for InvoicePaymentRequest
impl UnwindSafe for InvoicePaymentRequest
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.