Struct squareup::models::RefundPaymentRequest

pub struct RefundPaymentRequest {
    pub idempotency_key: String,
    pub amount_money: Money,
    pub app_fee_money: Option<Money>,
    pub payment_id: Option<String>,
    pub destination_id: Option<String>,
    pub unlinked: Option<bool>,
    pub location_id: Option<String>,
    pub customer_id: Option<String>,
    pub reason: Option<String>,
    pub payment_version_token: Option<String>,
    pub team_member_id: Option<String>,
}

This is a model struct for RefundPaymentRequest type

Fields

idempotency_key: String

A unique string that identifies this RefundPayment request. The key can be any valid string but must be unique for every RefundPayment request.

Keys are limited to a max of 45 characters - however, the number of allowed characters might be less than 45, if multi-byte characters are used.

For more information, see Idempotency.

amount_money: Money

The amount of money to refund.

This amount cannot be more than the total_money value of the payment minus the total amount of all previously completed refunds for this payment.

This amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts.

The currency code must match the currency associated with the business that is charging the card.

app_fee_money: Option<Money>

The amount of money the developer contributes to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents).

The value cannot be more than the amount_money.

You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see Take Payments and Collect Fees.

To set this field, PaymentsWriteAdditionalRecipients OAuth permission is required. For more information, see Permissions.

payment_id: Option<String>

The unique ID of the payment being refunded. Required when unlinked=false, otherwise must not be set.

destination_id: Option<String>

The ID indicating where funds will be refunded to, if this is an unlinked refund. This can be any of the following: A token generated by Web Payments SDK; a card-on-file identifier. Required for requests specifying unlinked=true. Otherwise, if included when unlinked=false, will throw an error.

unlinked: Option<bool>

Indicates that the refund is not linked to a Square payment. If set to true, destination_id and location_id must be supplied while payment_id must not be provided.

location_id: Option<String>

The location ID associated with the unlinked refund. Required for requests specifying unlinked=true. Otherwise, if included when unlinked=false, will throw an error. Max Length 50

customer_id: Option<String>

The Customer ID of the customer associated with the refund. This is required if the destination_id refers to a card on file created using the Cards API. Only allowed when unlinked=true.

reason: Option<String>

A description of the reason for the refund.

Max Length 192

payment_version_token: Option<String>

Used for optimistic concurrency. This opaque token identifies the current Payment version that the caller expects. If the server has a different version of the Payment, the update fails and a response with a VERSION_MISMATCH error is returned. If the versions match, or the field is not provided, the refund proceeds as normal.

team_member_id: Option<String>

An optional [TeamMember] ID to associate with this refund.

Trait Implementations

impl Clone for RefundPaymentRequest

fn clone(&self) -> RefundPaymentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefundPaymentRequest

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

Formats the value using the given formatter.

impl Default for RefundPaymentRequest

fn default() -> RefundPaymentRequest

Returns the “default value” for a type.

impl PartialEq for RefundPaymentRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RefundPaymentRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RefundPaymentRequest

impl StructuralPartialEq for RefundPaymentRequest