Class: Stripe::V2::Payments::OffSessionPaymentService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/payments/off_session_payment_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(id, params = {}, opts = {}) ⇒ Object

Cancel an OffSessionPayment that has previously been created.



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

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

#capture(id, params = {}, opts = {}) ⇒ Object

Captures an OffSessionPayment that has previously been created.



20
21
22
23
24
25
26
27
28
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 20

def capture(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/payments/off_session_payments/%<id>s/capture", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Creates an OffSessionPayment object.



31
32
33
34
35
36
37
38
39
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 31

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

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

Returns a list of OffSessionPayments matching a filter.



42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 42

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

#pause(id, params = {}, opts = {}) ⇒ Object

Pauses an OffSessionPayment that has previously been created.



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

def pause(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/payments/off_session_payments/%<id>s/pause", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#resume(id, params = {}, opts = {}) ⇒ Object

Resumes an OffSessionPayment that has previously been paused.



64
65
66
67
68
69
70
71
72
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 64

def resume(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/payments/off_session_payments/%<id>s/resume", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Retrieves the details of an OffSessionPayment that has previously been created.



75
76
77
78
79
80
81
82
83
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 75

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