pub struct RefundPaymentRequest {
pub idempotency_key: String,
pub amount_money: Money,
pub app_fee_money: Option<Money>,
pub payment_id: String,
pub reason: Option<String>,
pub payment_version_token: Option<String>,
pub team_member_id: Option<String>,
}
Expand description
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, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS
OAuth permission is required. For
more information, see
Permissions.
payment_id: String
The unique ID of the payment being refunded. Must be provided and non-empty.
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§
Source§impl Clone for RefundPaymentRequest
impl Clone for RefundPaymentRequest
Source§fn clone(&self) -> RefundPaymentRequest
fn clone(&self) -> RefundPaymentRequest
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 RefundPaymentRequest
impl Debug for RefundPaymentRequest
Source§impl Default for RefundPaymentRequest
impl Default for RefundPaymentRequest
Source§fn default() -> RefundPaymentRequest
fn default() -> RefundPaymentRequest
Source§impl PartialEq for RefundPaymentRequest
impl PartialEq for RefundPaymentRequest
Source§impl Serialize for RefundPaymentRequest
impl Serialize for RefundPaymentRequest
impl Eq for RefundPaymentRequest
impl StructuralPartialEq for RefundPaymentRequest
Auto Trait Implementations§
impl Freeze for RefundPaymentRequest
impl RefUnwindSafe for RefundPaymentRequest
impl Send for RefundPaymentRequest
impl Sync for RefundPaymentRequest
impl Unpin for RefundPaymentRequest
impl UnwindSafe for RefundPaymentRequest
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.