RefundPaymentRequest (Square 30.0.1.20230608 API)

java.lang.Object
- com.squareup.square.models.RefundPaymentRequest

```
public class RefundPaymentRequest
extends Object
```
This is a model class for RefundPaymentRequest type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RefundPaymentRequest.Builder
Class to build instances of RefundPaymentRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RefundPaymentRequest.Builder` Class to build instances of `RefundPaymentRequest`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	RefundPaymentRequest(String idempotencyKey, Money amountMoney, Money appFeeMoney, io.apimatic.core.types.OptionalNullable<String> paymentId, io.apimatic.core.types.OptionalNullable<String> destinationId, io.apimatic.core.types.OptionalNullable<Boolean> unlinked, io.apimatic.core.types.OptionalNullable<String> locationId, io.apimatic.core.types.OptionalNullable<String> customerId, io.apimatic.core.types.OptionalNullable<String> reason, io.apimatic.core.types.OptionalNullable<String> paymentVersionToken, io.apimatic.core.types.OptionalNullable<String> teamMemberId) Internal initialization constructor.
	`RefundPaymentRequest(String idempotencyKey, Money amountMoney, Money appFeeMoney, String paymentId, String destinationId, Boolean unlinked, String locationId, String customerId, String reason, String paymentVersionToken, String teamMemberId)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Money`	`getAmountMoney()` Getter for AmountMoney.
`Money`	`getAppFeeMoney()` Getter for AppFeeMoney.
`String`	`getCustomerId()` Getter for CustomerId.
`String`	`getDestinationId()` Getter for DestinationId.
`String`	`getIdempotencyKey()` Getter for IdempotencyKey.
`String`	`getLocationId()` Getter for LocationId.
`String`	`getPaymentId()` Getter for PaymentId.
`String`	`getPaymentVersionToken()` Getter for PaymentVersionToken.
`String`	`getReason()` Getter for Reason.
`String`	`getTeamMemberId()` Getter for TeamMemberId.
`Boolean`	`getUnlinked()` Getter for Unlinked.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCustomerId()` Internal Getter for CustomerId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetDestinationId()` Internal Getter for DestinationId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetLocationId()` Internal Getter for LocationId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPaymentId()` Internal Getter for PaymentId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPaymentVersionToken()` Internal Getter for PaymentVersionToken.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetReason()` Internal Getter for Reason.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetTeamMemberId()` Internal Getter for TeamMemberId.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetUnlinked()` Internal Getter for Unlinked.
`RefundPaymentRequest.Builder`	`toBuilder()` Builds a new `RefundPaymentRequest.Builder` object.
`String`	`toString()` Converts this RefundPaymentRequest into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RefundPaymentRequest
```
public RefundPaymentRequest(String idempotencyKey,
                            Money amountMoney,
                            Money appFeeMoney,
                            String paymentId,
                            String destinationId,
                            Boolean unlinked,
                            String locationId,
                            String customerId,
                            String reason,
                            String paymentVersionToken,
                            String teamMemberId)
```
    Initialization constructor.
    
    Parameters:
    
    idempotencyKey - String value for idempotencyKey.
    
    amountMoney - Money value for amountMoney.
    
    appFeeMoney - Money value for appFeeMoney.
    
    paymentId - String value for paymentId.
    
    destinationId - String value for destinationId.
    
    unlinked - Boolean value for unlinked.
    
    locationId - String value for locationId.
    
    customerId - String value for customerId.
    
    reason - String value for reason.
    
    paymentVersionToken - String value for paymentVersionToken.
    
    teamMemberId - String value for teamMemberId.
  - RefundPaymentRequest
```
protected RefundPaymentRequest(String idempotencyKey,
                               Money amountMoney,
                               Money appFeeMoney,
                               io.apimatic.core.types.OptionalNullable<String> paymentId,
                               io.apimatic.core.types.OptionalNullable<String> destinationId,
                               io.apimatic.core.types.OptionalNullable<Boolean> unlinked,
                               io.apimatic.core.types.OptionalNullable<String> locationId,
                               io.apimatic.core.types.OptionalNullable<String> customerId,
                               io.apimatic.core.types.OptionalNullable<String> reason,
                               io.apimatic.core.types.OptionalNullable<String> paymentVersionToken,
                               io.apimatic.core.types.OptionalNullable<String> teamMemberId)
```
    Internal initialization constructor.
- Method Detail
  - getIdempotencyKey
```
public String getIdempotencyKey()
```
    Getter for IdempotencyKey. 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](https://developer.squareup.com/docs/working-with-apis/idempotency).
    
    Returns:
    
    Returns the String
  - getAmountMoney
```
public Money getAmountMoney()
```
    Getter for AmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getAppFeeMoney
```
public Money getAppFeeMoney()
```
    Getter for AppFeeMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - internalGetPaymentId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPaymentId()
```
    Internal Getter for PaymentId. The unique ID of the payment being refunded. Required when unlinked=false, otherwise must not be set.
    
    Returns:
    
    Returns the Internal String
  - getPaymentId
```
public String getPaymentId()
```
    Getter for PaymentId. The unique ID of the payment being refunded. Required when unlinked=false, otherwise must not be set.
    
    Returns:
    
    Returns the String
  - internalGetDestinationId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetDestinationId()
```
    Internal Getter for DestinationId. 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.
    
    Returns:
    
    Returns the Internal String
  - getDestinationId
```
public String getDestinationId()
```
    Getter for DestinationId. 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.
    
    Returns:
    
    Returns the String
  - internalGetUnlinked
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetUnlinked()
```
    Internal Getter for Unlinked. 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.
    
    Returns:
    
    Returns the Internal Boolean
  - getUnlinked
```
public Boolean getUnlinked()
```
    Getter for Unlinked. 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.
    
    Returns:
    
    Returns the Boolean
  - internalGetLocationId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetLocationId()
```
    Internal Getter for LocationId. The location ID associated with the unlinked refund. Required for requests specifying `unlinked=true`. Otherwise, if included when `unlinked=false`, will throw an error.
    
    Returns:
    
    Returns the Internal String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The location ID associated with the unlinked refund. Required for requests specifying `unlinked=true`. Otherwise, if included when `unlinked=false`, will throw an error.
    
    Returns:
    
    Returns the String
  - internalGetCustomerId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCustomerId()
```
    Internal Getter for CustomerId. The [Customer](entity: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`.
    
    Returns:
    
    Returns the Internal String
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The [Customer](entity: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`.
    
    Returns:
    
    Returns the String
  - internalGetReason
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetReason()
```
    Internal Getter for Reason. A description of the reason for the refund.
    
    Returns:
    
    Returns the Internal String
  - getReason
```
public String getReason()
```
    Getter for Reason. A description of the reason for the refund.
    
    Returns:
    
    Returns the String
  - internalGetPaymentVersionToken
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPaymentVersionToken()
```
    Internal Getter for PaymentVersionToken. 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.
    
    Returns:
    
    Returns the Internal String
  - getPaymentVersionToken
```
public String getPaymentVersionToken()
```
    Getter for PaymentVersionToken. 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.
    
    Returns:
    
    Returns the String
  - internalGetTeamMemberId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetTeamMemberId()
```
    Internal Getter for TeamMemberId. An optional [TeamMember](entity:TeamMember) ID to associate with this refund.
    
    Returns:
    
    Returns the Internal String
  - getTeamMemberId
```
public String getTeamMemberId()
```
    Getter for TeamMemberId. An optional [TeamMember](entity:TeamMember) ID to associate with this refund.
    
    Returns:
    
    Returns the String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this RefundPaymentRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public RefundPaymentRequest.Builder toBuilder()
```
    Builds a new RefundPaymentRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new RefundPaymentRequest.Builder object

Class RefundPaymentRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RefundPaymentRequest

RefundPaymentRequest

Method Detail

getIdempotencyKey

getAmountMoney

getAppFeeMoney

internalGetPaymentId

getPaymentId

internalGetDestinationId

getDestinationId

internalGetUnlinked

getUnlinked

internalGetLocationId

getLocationId

internalGetCustomerId

getCustomerId

internalGetReason

getReason

internalGetPaymentVersionToken

getPaymentVersionToken

internalGetTeamMemberId

getTeamMemberId

hashCode

equals

toString

toBuilder