Package io.trippay.sdk.payment.model

Class Refund

java.lang.Object

io.trippay.sdk.payment.model.Refund

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-03T09:25:34.975208328+07:00[Asia/Bangkok]")
public class Refund
extends Object

Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Refund.AllocationEnum	The type of refund determines how the funds are deducted each beneficiary.
static enum	Refund.CancelOnRefundEnum	Whether to cancel the booking alongside requesting a refund.
static enum	Refund.ReasonTypeEnum	A description of the refund that can be displayed to booker
static enum	Refund.RequestStatusEnum	Status of the refund request
static enum	Refund.RequestTypeEnum	The entity making the refund request
static enum	Refund.StatusTypeEnum	Status of the refund

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACQUIRER_REFUND_IDENTIFIER
static final String	JSON_PROPERTY_ALLOCATION
static final String	JSON_PROPERTY_CANCEL_ON_REFUND
static final String	JSON_PROPERTY_CREATED
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_IDENTIFIER
static final String	JSON_PROPERTY_REASON_TYPE
static final String	JSON_PROPERTY_RECEIPT_URL
static final String	JSON_PROPERTY_REFUND
static final String	JSON_PROPERTY_REQUEST_RESPONSE
static final String	JSON_PROPERTY_REQUEST_STATUS
static final String	JSON_PROPERTY_REQUEST_TYPE
static final String	JSON_PROPERTY_REQUESTED_BY_IDENTIFIER
static final String	JSON_PROPERTY_RETRIES
static final String	JSON_PROPERTY_STATUS_TYPE

Constructor Summary

Constructors

Constructor	Description
Refund()

Method Summary

Modifier and Type	Method	Description
Refund	acquirerRefundIdentifier(String acquirerRefundIdentifier)
Refund	allocation(Refund.AllocationEnum allocation)
Refund	cancelOnRefund(Refund.CancelOnRefundEnum cancelOnRefund)
Refund	created(LocalDateTime created)
Refund	description(String description)
boolean	equals(Object o)
String	getAcquirerRefundIdentifier()	The acquirer refund identifier.
Refund.AllocationEnum	getAllocation()	The type of refund determines how the funds are deducted each beneficiary.
@NotNull Refund.CancelOnRefundEnum	getCancelOnRefund()	Whether to cancel the booking alongside requesting a refund.
LocalDateTime	getCreated()	When the amount was refunded
@NotNull String	getDescription()	A description of the refund that can be displayed to booker
@NotNull String	getIdentifier()	A unique identifier
@NotNull Refund.ReasonTypeEnum	getReasonType()	A description of the refund that can be displayed to booker
String	getReceiptUrl()	This is the receipt url that contains a friendly web confirmation page.
@NotNull @Valid CustomMonetaryAmount	getRefund()	Get refund
String	getRequestedByIdentifier()	The SSO person / entity that requested the refund.
@NotNull String	getRequestResponse()	Admin may choose to respond to the refund request made by the hotel
@NotNull Refund.RequestStatusEnum	getRequestStatus()	Status of the refund request
@NotNull Refund.RequestTypeEnum	getRequestType()	The entity making the refund request
Integer	getRetries()	In case a TripPay admin has to go in and re-send the refund request to Stripe, we want to not to the same calculations again when a retry is executed so we keep track of retries here.
@NotNull Refund.StatusTypeEnum	getStatusType()	Status of the refund
int	hashCode()
Refund	identifier(String identifier)
Refund	reasonType(Refund.ReasonTypeEnum reasonType)
Refund	receiptUrl(String receiptUrl)
Refund	refund(CustomMonetaryAmount refund)
Refund	requestedByIdentifier(String requestedByIdentifier)
Refund	requestResponse(String requestResponse)
Refund	requestStatus(Refund.RequestStatusEnum requestStatus)
Refund	requestType(Refund.RequestTypeEnum requestType)
Refund	retries(Integer retries)
void	setAcquirerRefundIdentifier(String acquirerRefundIdentifier)
void	setAllocation(Refund.AllocationEnum allocation)
void	setCancelOnRefund(Refund.CancelOnRefundEnum cancelOnRefund)
void	setCreated(LocalDateTime created)
void	setDescription(String description)
void	setIdentifier(String identifier)
void	setReasonType(Refund.ReasonTypeEnum reasonType)
void	setReceiptUrl(String receiptUrl)
void	setRefund(CustomMonetaryAmount refund)
void	setRequestedByIdentifier(String requestedByIdentifier)
void	setRequestResponse(String requestResponse)
void	setRequestStatus(Refund.RequestStatusEnum requestStatus)
void	setRequestType(Refund.RequestTypeEnum requestType)
void	setRetries(Integer retries)
void	setStatusType(Refund.StatusTypeEnum statusType)
Refund	statusType(Refund.StatusTypeEnum statusType)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_IDENTIFIER

public static final String JSON_PROPERTY_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_ACQUIRER_REFUND_IDENTIFIER

public static final String JSON_PROPERTY_ACQUIRER_REFUND_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_REQUESTED_BY_IDENTIFIER

public static final String JSON_PROPERTY_REQUESTED_BY_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_REFUND

public static final String JSON_PROPERTY_REFUND

See Also:

• Constant Field Values

JSON_PROPERTY_CREATED

public static final String JSON_PROPERTY_CREATED

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_REASON_TYPE

public static final String JSON_PROPERTY_REASON_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_CANCEL_ON_REFUND

public static final String JSON_PROPERTY_CANCEL_ON_REFUND

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS_TYPE

public static final String JSON_PROPERTY_STATUS_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST_TYPE

public static final String JSON_PROPERTY_REQUEST_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST_STATUS

public static final String JSON_PROPERTY_REQUEST_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST_RESPONSE

public static final String JSON_PROPERTY_REQUEST_RESPONSE

See Also:

• Constant Field Values

JSON_PROPERTY_RECEIPT_URL

public static final String JSON_PROPERTY_RECEIPT_URL

See Also:

• Constant Field Values

JSON_PROPERTY_RETRIES

public static final String JSON_PROPERTY_RETRIES

See Also:

• Constant Field Values

JSON_PROPERTY_ALLOCATION

public static final String JSON_PROPERTY_ALLOCATION

See Also:

• Constant Field Values

Constructor Details

Refund

public Refund()

Method Details

identifier

public Refund identifier(String identifier)

getIdentifier

@Nonnull
@NotNull
public @NotNull String getIdentifier()

A unique identifier

Returns:

identifier

setIdentifier

public void setIdentifier(String identifier)

acquirerRefundIdentifier

public Refund acquirerRefundIdentifier(String acquirerRefundIdentifier)

getAcquirerRefundIdentifier

@Nullable
public String getAcquirerRefundIdentifier()

The acquirer refund identifier. Will get attached once it comes in on the webhook.

Returns:

acquirerRefundIdentifier

setAcquirerRefundIdentifier

public void setAcquirerRefundIdentifier(String acquirerRefundIdentifier)

requestedByIdentifier

public Refund requestedByIdentifier(String requestedByIdentifier)

getRequestedByIdentifier

@Nullable
public String getRequestedByIdentifier()

The SSO person / entity that requested the refund.

Returns:

requestedByIdentifier

setRequestedByIdentifier

public void setRequestedByIdentifier(String requestedByIdentifier)

refund

public Refund refund(CustomMonetaryAmount refund)

getRefund

@Nonnull
@NotNull
@Valid
public @NotNull @Valid CustomMonetaryAmount getRefund()

Get refund

Returns:

refund

setRefund

public void setRefund(CustomMonetaryAmount refund)

created

public Refund created(LocalDateTime created)

getCreated

@Nonnull
@NotNull
@Valid
public LocalDateTime getCreated()

When the amount was refunded

Returns:

created

setCreated

public void setCreated(LocalDateTime created)

description

public Refund description(String description)

getDescription

@Nonnull
@NotNull
public @NotNull String getDescription()

A description of the refund that can be displayed to booker

Returns:

description

setDescription

public void setDescription(String description)

reasonType

public Refund reasonType(Refund.ReasonTypeEnum reasonType)

getReasonType

@Nonnull
@NotNull
public @NotNull Refund.ReasonTypeEnum getReasonType()

A description of the refund that can be displayed to booker

Returns:

reasonType

setReasonType

public void setReasonType(Refund.ReasonTypeEnum reasonType)

cancelOnRefund

public Refund cancelOnRefund(Refund.CancelOnRefundEnum cancelOnRefund)

getCancelOnRefund

@Nonnull
@NotNull
public @NotNull Refund.CancelOnRefundEnum getCancelOnRefund()

Whether to cancel the booking alongside requesting a refund.

Returns:

cancelOnRefund

setCancelOnRefund

public void setCancelOnRefund(Refund.CancelOnRefundEnum cancelOnRefund)

statusType

public Refund statusType(Refund.StatusTypeEnum statusType)

getStatusType

@Nonnull
@NotNull
public @NotNull Refund.StatusTypeEnum getStatusType()

Status of the refund

Returns:

statusType

setStatusType

public void setStatusType(Refund.StatusTypeEnum statusType)

requestType

public Refund requestType(Refund.RequestTypeEnum requestType)

getRequestType

@Nonnull
@NotNull
public @NotNull Refund.RequestTypeEnum getRequestType()

The entity making the refund request

Returns:

requestType

setRequestType

public void setRequestType(Refund.RequestTypeEnum requestType)

requestStatus

public Refund requestStatus(Refund.RequestStatusEnum requestStatus)

getRequestStatus

@Nonnull
@NotNull
public @NotNull Refund.RequestStatusEnum getRequestStatus()

Status of the refund request

Returns:

requestStatus

setRequestStatus

public void setRequestStatus(Refund.RequestStatusEnum requestStatus)

requestResponse

public Refund requestResponse(String requestResponse)

getRequestResponse

@Nonnull
@NotNull
public @NotNull String getRequestResponse()

Admin may choose to respond to the refund request made by the hotel

Returns:

requestResponse

setRequestResponse

public void setRequestResponse(String requestResponse)

receiptUrl

public Refund receiptUrl(String receiptUrl)

getReceiptUrl

@Nullable
public String getReceiptUrl()

This is the receipt url that contains a friendly web confirmation page. Comes in on the webhook.

Returns:

receiptUrl

setReceiptUrl

public void setReceiptUrl(String receiptUrl)

retries

public Refund retries(Integer retries)

getRetries

@Nullable
public Integer getRetries()

In case a TripPay admin has to go in and re-send the refund request to Stripe, we want to not to the same calculations again when a retry is executed so we keep track of retries here.

Returns:

retries

setRetries

public void setRetries(Integer retries)

allocation

public Refund allocation(Refund.AllocationEnum allocation)

getAllocation

@Nullable
public Refund.AllocationEnum getAllocation()

The type of refund determines how the funds are deducted each beneficiary.

Returns:

allocation

setAllocation

public void setAllocation(Refund.AllocationEnum allocation)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object