Class Dispute

    • Constructor Detail

      • Dispute

        public Dispute()
    • Method Detail

      • 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)
      • 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)
      • update

        public Dispute update​(java.util.Map<java.lang.String,​java.lang.Object> params)
                       throws StripeException
        When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

        Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

        Specified by:
        update in interface MetadataStore<Dispute>
        Throws:
        StripeException
      • update

        public Dispute update​(java.util.Map<java.lang.String,​java.lang.Object> params,
                              RequestOptions options)
                       throws StripeException
        When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

        Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

        Specified by:
        update in interface MetadataStore<Dispute>
        Throws:
        StripeException
      • update

        public Dispute update​(DisputeUpdateParams params)
                       throws StripeException
        When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

        Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

        Throws:
        StripeException
      • update

        public Dispute update​(DisputeUpdateParams params,
                              RequestOptions options)
                       throws StripeException
        When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

        Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

        Throws:
        StripeException
      • close

        public Dispute close()
                      throws StripeException
        Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

        The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

        Throws:
        StripeException
      • close

        public Dispute close​(RequestOptions options)
                      throws StripeException
        Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

        The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

        Throws:
        StripeException
      • close

        public Dispute close​(java.util.Map<java.lang.String,​java.lang.Object> params)
                      throws StripeException
        Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

        The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

        Throws:
        StripeException
      • close

        public Dispute close​(java.util.Map<java.lang.String,​java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
        Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

        The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

        Throws:
        StripeException
      • close

        public Dispute close​(DisputeCloseParams params)
                      throws StripeException
        Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

        The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

        Throws:
        StripeException
      • close

        public Dispute close​(DisputeCloseParams params,
                             RequestOptions options)
                      throws StripeException
        Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

        The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

        Throws:
        StripeException
      • getAmount

        public java.lang.Long getAmount()
        Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
      • getBalanceTransactions

        public java.util.List<BalanceTransaction> getBalanceTransactions()
        List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
      • getCreated

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

        public java.lang.Boolean getIsChargeRefundable()
        If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
      • getLivemode

        public java.lang.Boolean getLivemode()
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.
      • getNetworkReasonCode

        public java.lang.String getNetworkReasonCode()
        Network-dependent reason code for the dispute.
      • getObject

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

        Equal to dispute.

      • getReason

        public java.lang.String getReason()
        Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.
      • getStatus

        public java.lang.String getStatus()
        Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.

        One of charge_refunded, lost, needs_response, under_review, warning_closed, warning_needs_response, warning_under_review, or won.

      • setAmount

        public void setAmount​(java.lang.Long amount)
        Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
      • setBalanceTransactions

        public void setBalanceTransactions​(java.util.List<BalanceTransaction> balanceTransactions)
        List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
      • setCreated

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

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

        public void setIsChargeRefundable​(java.lang.Boolean isChargeRefundable)
        If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
      • setLivemode

        public void setLivemode​(java.lang.Boolean livemode)
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.
      • 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.
      • setNetworkReasonCode

        public void setNetworkReasonCode​(java.lang.String networkReasonCode)
        Network-dependent reason code for the dispute.
      • 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 dispute.

      • setReason

        public void setReason​(java.lang.String reason)
        Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.
      • setStatus

        public void setStatus​(java.lang.String status)
        Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.

        One of charge_refunded, lost, needs_response, under_review, warning_closed, warning_needs_response, warning_under_review, or won.

      • 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<Dispute>