class Stripe::DisputesApi
- Stripe::DisputesApi
- Reference
- Object
Defined in:
stripe/api/disputes_api.crConstant Summary
-
GET_DISPUTES_DISPUTE_MAX_LENGTH_FOR_DISPUTE =
5000 -
GET_DISPUTES_MAX_LENGTH_FOR_CHARGE =
5000 -
GET_DISPUTES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_DISPUTES_MAX_LENGTH_FOR_PAYMENT_INTENT =
5000 -
GET_DISPUTES_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
POST_DISPUTES_DISPUTE_CLOSE_MAX_LENGTH_FOR_DISPUTE =
5000 -
POST_DISPUTES_DISPUTE_MAX_LENGTH_FOR_DISPUTE =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_disputes(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_disputes_dispute(*, dispute : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_disputes_dispute(*, dispute : String | Nil = nil, evidence : Stripe::DisputeEvidenceParams | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, submit : Bool | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_disputes_dispute_close(*, dispute : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_disputes(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::DisputeList
Returns a list of your disputes.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_disputes(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of your disputes.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_disputes_dispute(*, dispute : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Dispute
Retrieves the dispute with the given ID.
@required @param dispute [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_disputes_dispute(*, dispute : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the dispute with the given ID.</p> @required @param dispute [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_disputes_dispute_with_http_info(*, dispute : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Dispute, Int32, Hash(String, Array(String) | String))
<p>Retrieves the dispute with the given ID.</p> @required @param dispute [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_disputes_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payment_intent : String | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::DisputeList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of your disputes.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_disputes_dispute(*, dispute : String | Nil = nil, evidence : Stripe::DisputeEvidenceParams | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, submit : Bool | Nil = nil) : Stripe::Dispute
When you get a dispute, contacting your customer is always the best first step.
-
#post_disputes_dispute(*, dispute : String | Nil = nil, evidence : Stripe::DisputeEvidenceParams | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, submit : Bool | Nil = nil, &block : Crest::Response -> ) : Nil
<p>When you get a dispute, contacting your customer is always the best first step.
-
#post_disputes_dispute_close(*, dispute : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::Dispute
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_responsetolost. -
#post_disputes_dispute_close(*, dispute : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>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.</p> <p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>.
-
#post_disputes_dispute_close_with_http_info(*, dispute : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::Dispute, Int32, Hash(String, Array(String) | String))
<p>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.</p> <p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>.
-
#post_disputes_dispute_with_http_info(*, dispute : String | Nil = nil, evidence : Stripe::DisputeEvidenceParams | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, submit : Bool | Nil = nil) : Tuple(Stripe::Dispute, Int32, Hash(String, Array(String) | String))
<p>When you get a dispute, contacting your customer is always the best first step.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of your disputes.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param payment_intent [String?] Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. @optional @param charge [String?] Only return disputes associated to the charge specified by this charge ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return disputes that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::DisputeList]<p>Returns a list of your disputes.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param payment_intent [String?] Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
@optional @param charge [String?] Only return disputes associated to the charge specified by this charge ID.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return disputes that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the dispute with the given ID.
@required @param dispute [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Dispute]<p>Retrieves the dispute with the given ID.</p> @required @param dispute [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the dispute with the given ID.</p> @required @param dispute [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Dispute, Integer, Hash)] Stripe::Dispute, response status code and response headers
<p>Returns a list of your disputes.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param payment_intent [String?] Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
@optional @param charge [String?] Only return disputes associated to the charge specified by this charge ID.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return disputes that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::DisputeList, Integer, Hash)] Stripe::DisputeList, response status code and response headers
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.
@required @param dispute [String?] @optional @param evidence [Stripe::DisputeEvidenceParams?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param submit [Bool?] Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). @return [Stripe::Dispute]<p>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 <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p> <p>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 <a href="/docs/disputes/categories">guide to dispute types</a>.</p>
@required @param dispute [String?]
@optional @param evidence [Stripe::DisputeEvidenceParams?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param submit [Bool?] Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true (the default).
@return nil
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.
<p>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.</p> <p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>. <em>Closing a dispute is irreversible</em>.</p> @required @param dispute [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>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.</p> <p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>. <em>Closing a dispute is irreversible</em>.</p> @required @param dispute [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Dispute, Integer, Hash)] Stripe::Dispute, response status code and response headers
<p>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 <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p> <p>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 <a href="/docs/disputes/categories">guide to dispute types</a>.</p>
@required @param dispute [String?]
@optional @param evidence [Stripe::DisputeEvidenceParams?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param submit [Bool?] Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true (the default).
@return [Tuple(Stripe::Dispute, Integer, Hash)] Stripe::Dispute, response status code and response headers