Package com.broadleafcommerce.braintree.domain

Class BraintreeResponse.Refund

java.lang.Object
com.broadleafcommerce.braintree.domain.BraintreeResponse.Refund
All Implemented Interfaces:
Serializable
Enclosing class:
BraintreeResponse
public static class BraintreeResponse.Refund extends Object implements Serializable
A refund of a charge on a payment method, representing an attempt to send money from a previous transaction back to the customer.
See Also:

  • Constructor Details

    • Refund

      public Refund()

  • Method Details

    • setId

      public void setId(String id)
      Unique identifier.

    • setStatus

      public void setStatus(String status)
      The current status of this refund.

    • setAmount

      public void setAmount(BraintreeResponse.Amount amount)
      The amount that will be refunded, which can be less than or equal to the original charge amount.

    • setOrderId

      public void setOrderId(String orderId)
      The order ID for this refund. For PayPal transactions, the PayPal Invoice ID.

    • setCreatedAt

      public void setCreatedAt(Instant createdAt)
      Date and time when the refund was created.

    • setMerchantAccountId

      public void setMerchantAccountId(String merchantAccountId)
      The ID of the merchant account that processed this refund.

    • setSource

      public void setSource(String source)
      How the refund was created.

    • setRefundedTransaction

      public void setRefundedTransaction(BraintreeResponse.Transaction refundedTransaction)
      The original transaction that this refunds. If this is not present, then this refund represents a refund of a transaction that does not belong to this Braintree gateway account.

    • setPaymentMethod

      public void setPaymentMethod(BraintreeResponse.PaymentMethod paymentMethod)
      he multi-use payment method that will receive the refund. Only present if a multi-use payment method was used to create the original transaction and it has not been since deleted. The details of this PaymentMethod may have changed since the transaction was created; details used for the transaction can be found in the paymentMethodSnapshot field.

    • getId

      public String getId()
      Unique identifier.

    • getStatus

      public String getStatus()
      The current status of this refund.

    • getAmount

      public BraintreeResponse.Amount getAmount()
      The amount that will be refunded, which can be less than or equal to the original charge amount.

    • getOrderId

      public String getOrderId()
      The order ID for this refund. For PayPal transactions, the PayPal Invoice ID.

    • getCreatedAt

      public Instant getCreatedAt()
      Date and time when the refund was created.

    • getMerchantAccountId

      public String getMerchantAccountId()
      The ID of the merchant account that processed this refund.

    • getSource

      public String getSource()
      How the refund was created.

    • getRefundedTransaction

      public BraintreeResponse.Transaction getRefundedTransaction()
      The original transaction that this refunds. If this is not present, then this refund represents a refund of a transaction that does not belong to this Braintree gateway account.

    • getPaymentMethod

      public BraintreeResponse.PaymentMethod getPaymentMethod()
      he multi-use payment method that will receive the refund. Only present if a multi-use payment method was used to create the original transaction and it has not been since deleted. The details of this PaymentMethod may have changed since the transaction was created; details used for the transaction can be found in the paymentMethodSnapshot field.