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-01-16T13:59:19.530948343+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.

  • Field Details

  • 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