1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Model struct for GiftCardActivityRefund type

use serde::{Deserialize, Serialize};

use super::Money;

/// Represents details about a `REFUND` [gift card activity type](GiftCardActivityType).
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct GiftCardActivityRefund {
    /// The amount added to the gift card for the refund. This value is a positive integer.
    ///
    /// This field is required when creating a `REFUND` activity. The amount can represent a full or
    /// partial refund.
    pub amount_money: Option<Money>,
    /// **Read only** The ID of the refunded payment. Square populates this field if the refund is
    /// for a payment processed by Square and one of the following conditions is true:
    /// - The Refunds API is used to refund a gift card payment to the same gift card.
    /// - A seller initiated the refund from Square Point of Sale or the Seller Dashboard. The
    /// payment source can be the same gift card or a cross-tender payment from a credit card or a
    /// different gift card.
    pub payment_id: Option<String>,
    /// The ID of the refunded `REDEEM` gift card activity. Square populates this field if the
    /// `payment_id` in the corresponding
    /// [RefundPayment](https://developer.squareup.com/reference/square/refunds-api/refund-payment)
    /// request represents a redemption made by the same gift card. Note that you must use
    /// `RefundPayment` to refund a gift card payment to the same gift card if the payment was
    /// processed by Square.
    ///
    /// For applications that use a custom payment processing system, this field is required when
    /// creating a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same
    /// gift card.
    pub redeem_activity_id: Option<String>,
    /// A client-specified ID that associates the gift card activity with an entity in another
    /// system.
    pub reference_id: Option<String>,
}