Class: Stripe::Terminal::ReaderService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/terminal/reader_service.rb

Defined Under Namespace

Classes: CancelActionParams, CreateParams, DeleteParams, ListParams, ProcessPaymentIntentParams, ProcessSetupIntentParams, RefundPaymentParams, RetrieveParams, SetReaderDisplayParams, UpdateParams

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_action(reader, params = {}, opts = {}) ⇒ Object

Cancels the current reader action.



274
275
276
277
278
279
280
281
282
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 274

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

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

Creates a new Reader object.



285
286
287
288
289
290
291
292
293
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 285

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

#delete(reader, params = {}, opts = {}) ⇒ Object

Deletes a Reader object.



296
297
298
299
300
301
302
303
304
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 296

def delete(reader, params = {}, opts = {})
  request(
    method: :delete,
    path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Returns a list of Reader objects.



307
308
309
310
311
312
313
314
315
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 307

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

#process_payment_intent(reader, params = {}, opts = {}) ⇒ Object

Initiates a payment flow on a Reader.



318
319
320
321
322
323
324
325
326
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 318

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

#process_setup_intent(reader, params = {}, opts = {}) ⇒ Object

Initiates a setup intent flow on a Reader.



329
330
331
332
333
334
335
336
337
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 329

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

#refund_payment(reader, params = {}, opts = {}) ⇒ Object

Initiates a refund on a Reader



340
341
342
343
344
345
346
347
348
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 340

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

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

Retrieves a Reader object.



351
352
353
354
355
356
357
358
359
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 351

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

#set_reader_display(reader, params = {}, opts = {}) ⇒ Object

Sets reader display to show cart details.



362
363
364
365
366
367
368
369
370
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 362

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

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

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



373
374
375
376
377
378
379
380
381
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 373

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