Package com.stripe.model

Class Refund

    • Constructor Detail

      • Refund

        public Refund()

    • Method Detail

      • getBalanceTransaction

        public java.lang.String getBalanceTransaction()
        Get ID of expandable balanceTransaction object.

      • setBalanceTransaction

        public void setBalanceTransaction​(java.lang.String id)

      • getBalanceTransactionObject

        public BalanceTransaction getBalanceTransactionObject()
        Get expanded balanceTransaction.

      • setBalanceTransactionObject

        public void setBalanceTransactionObject​(BalanceTransaction expandableObject)

      • getCharge

        public java.lang.String getCharge()
        Get ID of expandable charge object.

      • setCharge

        public void setCharge​(java.lang.String id)

      • getChargeObject

        public Charge getChargeObject()
        Get expanded charge.

      • setChargeObject

        public void setChargeObject​(Charge expandableObject)

      • getFailureBalanceTransaction

        public java.lang.String getFailureBalanceTransaction()
        Get ID of expandable failureBalanceTransaction object.

      • setFailureBalanceTransaction

        public void setFailureBalanceTransaction​(java.lang.String id)

      • getFailureBalanceTransactionObject

        public BalanceTransaction getFailureBalanceTransactionObject()
        Get expanded failureBalanceTransaction.

      • setFailureBalanceTransactionObject

        public void setFailureBalanceTransactionObject​(BalanceTransaction expandableObject)

      • getPaymentIntent

        public java.lang.String getPaymentIntent()
        Get ID of expandable paymentIntent object.

      • setPaymentIntent

        public void setPaymentIntent​(java.lang.String id)

      • getPaymentIntentObject

        public PaymentIntent getPaymentIntentObject()
        Get expanded paymentIntent.

      • setPaymentIntentObject

        public void setPaymentIntentObject​(PaymentIntent expandableObject)

      • getSourceTransferReversal

        public java.lang.String getSourceTransferReversal()
        Get ID of expandable sourceTransferReversal object.

      • setSourceTransferReversal

        public void setSourceTransferReversal​(java.lang.String id)

      • getSourceTransferReversalObject

        public TransferReversal getSourceTransferReversalObject()
        Get expanded sourceTransferReversal.

      • setSourceTransferReversalObject

        public void setSourceTransferReversalObject​(TransferReversal expandableObject)

      • getTransferReversal

        public java.lang.String getTransferReversal()
        Get ID of expandable transferReversal object.

      • setTransferReversal

        public void setTransferReversal​(java.lang.String id)

      • getTransferReversalObject

        public TransferReversal getTransferReversalObject()
        Get expanded transferReversal.

      • setTransferReversalObject

        public void setTransferReversalObject​(TransferReversal expandableObject)

      • list

        public static RefundCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params)
                             throws StripeException
        Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
        Throws:
        StripeException

      • list

        public static RefundCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                    RequestOptions options)
                             throws StripeException
        Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
        Throws:
        StripeException

      • list

        public static RefundCollection list​(RefundListParams params)
                             throws StripeException
        Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
        Throws:
        StripeException

      • list

        public static RefundCollection list​(RefundListParams params,
                                    RequestOptions options)
                             throws StripeException
        Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
        Throws:
        StripeException

      • update

        public Refund update​(java.util.Map<java.lang.String,​java.lang.Object> params)
              throws StripeException
        Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        This request only accepts metadata as an argument.

        Specified by:
        update in interface MetadataStore<Refund>
        Throws:
        StripeException

      • update

        public Refund update​(java.util.Map<java.lang.String,​java.lang.Object> params,
                     RequestOptions options)
              throws StripeException
        Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        This request only accepts metadata as an argument.

        Specified by:
        update in interface MetadataStore<Refund>
        Throws:
        StripeException

      • update

        public Refund update​(RefundUpdateParams params)
              throws StripeException
        Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        This request only accepts metadata as an argument.

        Throws:
        StripeException

      • getAmount

        public java.lang.Long getAmount()
        Amount, in %s.

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getDescription

        public java.lang.String getDescription()
        An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)

      • getFailureReason

        public java.lang.String getFailureReason()
        If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to refund.

      • getReason

        public java.lang.String getReason()
        Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

      • getReceiptNumber

        public java.lang.String getReceiptNumber()
        This is the transaction number that appears on email receipts sent for this refund.

      • getStatus

        public java.lang.String getStatus()
        Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled. Refer to our refunds documentation for more details.

      • setAmount

        public void setAmount​(java.lang.Long amount)
        Amount, in %s.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setDescription

        public void setDescription​(java.lang.String description)
        An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)

      • setFailureReason

        public void setFailureReason​(java.lang.String failureReason)
        If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setMetadata

        public void setMetadata​(java.util.Map<java.lang.String,​java.lang.String> metadata)
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

        Equal to refund.

      • setReason

        public void setReason​(java.lang.String reason)
        Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

      • setReceiptNumber

        public void setReceiptNumber​(java.lang.String receiptNumber)
        This is the transaction number that appears on email receipts sent for this refund.

      • setStatus

        public void setStatus​(java.lang.String status)
        Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled. Refer to our refunds documentation for more details.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.String> getMetadata()
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        Specified by:
        getMetadata in interface MetadataStore<Refund>