Class: Stripe::Issuing::DisputeService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/issuing/dispute_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#create(params = {}, opts = {}) ⇒ Object

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.



8
9
10
11
12
13
14
15
16
 
# File 'lib/stripe/services/issuing/dispute_service.rb', line 8

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/issuing/disputes",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.



19
20
21
22
23
24
25
26
27
 
# File 'lib/stripe/services/issuing/dispute_service.rb', line 19

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/issuing/disputes",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(dispute, params = {}, opts = {}) ⇒ Object

Retrieves an Issuing Dispute object.



30
31
32
33
34
35
36
37
38
 
# File 'lib/stripe/services/issuing/dispute_service.rb', line 30

def retrieve(dispute, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/issuing/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#submit(dispute, params = {}, opts = {}) ⇒ Object

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see [Dispute reasons and evidence](stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).



41
42
43
44
45
46
47
48
49
 
# File 'lib/stripe/services/issuing/dispute_service.rb', line 41

def submit(dispute, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(dispute) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(dispute, params = {}, opts = {}) ⇒ Object

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.



52
53
54
55
56
57
58
59
60
 
# File 'lib/stripe/services/issuing/dispute_service.rb', line 52

def update(dispute, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/issuing/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end