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

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/payments/off_session_payment_service.rb

Defined Under Namespace

Classes: CancelParams, CreateParams, ListParams, RetrieveParams

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.



107
108
109
110
111
112
113
114
115
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 107

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

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

Creates an OffSessionPayment object.



118
119
120
121
122
123
124
125
126
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 118

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.



129
130
131
132
133
134
135
136
137
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 129

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

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

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



140
141
142
143
144
145
146
147
148
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 140

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