Class: Stripe::RefundService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/refund_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

#cancel(refund, params = {}, opts = {}) ⇒ Object

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.



9
10
11
12
13
14
15
16
17
 
# File 'lib/stripe/services/refund_service.rb', line 9

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

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

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.



30
31
32
 
# File 'lib/stripe/services/refund_service.rb', line 30

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

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

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.



35
36
37
 
# File 'lib/stripe/services/refund_service.rb', line 35

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

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

Retrieves the details of an existing refund.



40
41
42
43
44
45
46
47
48
 
# File 'lib/stripe/services/refund_service.rb', line 40

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

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

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.



53
54
55
56
57
58
59
60
61
 
# File 'lib/stripe/services/refund_service.rb', line 53

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