Class: Stripe::Terminal::ReaderService

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

Defined Under Namespace

Classes: CancelActionParams, CollectInputsParams, CollectPaymentMethodParams, ConfirmPaymentIntentParams, 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.



418
419
420
421
422
423
424
425
426
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 418

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

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

Initiates an input collection flow on a Reader.



429
430
431
432
433
434
435
436
437
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 429

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

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

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.



440
441
442
443
444
445
446
447
448
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 440

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

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

Finalizes a payment on a Reader.



451
452
453
454
455
456
457
458
459
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 451

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

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

Creates a new Reader object.



462
463
464
465
466
467
468
469
470
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 462

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.



473
474
475
476
477
478
479
480
481
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 473

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.



484
485
486
487
488
489
490
491
492
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 484

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.



495
496
497
498
499
500
501
502
503
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 495

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.



506
507
508
509
510
511
512
513
514
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 506

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



517
518
519
520
521
522
523
524
525
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 517

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.



528
529
530
531
532
533
534
535
536
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 528

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.



539
540
541
542
543
544
545
546
547
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 539

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.



550
551
552
553
554
555
556
557
558
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 550

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