Class: Stripe::Terminal::Reader

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/stripe/resources/terminal/reader.rb

Overview

A Reader represents a physical device for accepting payment details.

Related guide: [Connecting to a reader](stripe.com/docs/terminal/payments/connect-reader)

Defined Under Namespace

Classes: Action, CancelActionParams, CollectInputsParams, CollectPaymentMethodParams, ConfirmPaymentIntentParams, CreateParams, DeleteParams, ListParams, PresentPaymentMethodParams, ProcessPaymentIntentParams, ProcessSetupIntentParams, RefundPaymentParams, RetrieveParams, SetReaderDisplayParams, TestHelpers, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"terminal.reader"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

included

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#action ⇒ Object (readonly)

The most recent action performed by the reader.



716
717
718
 
# File 'lib/stripe/resources/terminal/reader.rb', line 716

def action
  @action
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



740
741
742
 
# File 'lib/stripe/resources/terminal/reader.rb', line 740

def deleted
  @deleted
end

#device_sw_version ⇒ Object (readonly)

The current software version of the reader.



718
719
720
 
# File 'lib/stripe/resources/terminal/reader.rb', line 718

def device_sw_version
  @device_sw_version
end

#device_type ⇒ Object (readonly)

Type of reader, one of ‘bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.



720
721
722
 
# File 'lib/stripe/resources/terminal/reader.rb', line 720

def device_type
  @device_type
end

#id ⇒ Object (readonly)

Unique identifier for the object.



722
723
724
 
# File 'lib/stripe/resources/terminal/reader.rb', line 722

def id
  @id
end

#ip_address ⇒ Object (readonly)

The local IP address of the reader.



724
725
726
 
# File 'lib/stripe/resources/terminal/reader.rb', line 724

def ip_address
  @ip_address
end

#label ⇒ Object (readonly)

Custom label given to the reader for easier identification.



726
727
728
 
# File 'lib/stripe/resources/terminal/reader.rb', line 726

def label
  @label
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



728
729
730
 
# File 'lib/stripe/resources/terminal/reader.rb', line 728

def livemode
  @livemode
end

#location ⇒ Object (readonly)

The location identifier of the reader.



730
731
732
 
# File 'lib/stripe/resources/terminal/reader.rb', line 730

def location
  @location
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



732
733
734
 
# File 'lib/stripe/resources/terminal/reader.rb', line 732

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



734
735
736
 
# File 'lib/stripe/resources/terminal/reader.rb', line 734

def object
  @object
end

#serial_number ⇒ Object (readonly)

Serial number of the reader.



736
737
738
 
# File 'lib/stripe/resources/terminal/reader.rb', line 736

def serial_number
  @serial_number
end

#status ⇒ Object (readonly)

The networking status of the reader. We do not recommend using this field in flows that may block taking payments.



738
739
740
 
# File 'lib/stripe/resources/terminal/reader.rb', line 738

def status
  @status
end

Class Method Details

.cancel_action(reader, params = {}, opts = {}) ⇒ Object

Cancels the current reader action.



753
754
755
756
757
758
759
760
 
# File 'lib/stripe/resources/terminal/reader.rb', line 753

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

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

Initiates an input collection flow on a Reader.



773
774
775
776
777
778
779
780
 
# File 'lib/stripe/resources/terminal/reader.rb', line 773

def self.collect_inputs(reader, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts
  )
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.



793
794
795
796
797
798
799
800
 
# File 'lib/stripe/resources/terminal/reader.rb', line 793

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

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

Finalizes a payment on a Reader.



813
814
815
816
817
818
819
820
 
# File 'lib/stripe/resources/terminal/reader.rb', line 813

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

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

Creates a new Reader object.



823
824
825
826
827
828
829
830
 
# File 'lib/stripe/resources/terminal/reader.rb', line 823

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/terminal/readers",
    params: params,
    opts: opts
  )
end

.delete(id, params = {}, opts = {}) ⇒ Object

Deletes a Reader object.



833
834
835
836
837
838
839
840
 
# File 'lib/stripe/resources/terminal/reader.rb', line 833

def self.delete(id, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/terminal/readers/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

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

Returns a list of Reader objects.



853
854
855
856
857
858
859
860
 
# File 'lib/stripe/resources/terminal/reader.rb', line 853

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/terminal/readers",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/terminal/reader.rb', line 16

def self.object_name
  "terminal.reader"
end

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

Initiates a payment flow on a Reader.



873
874
875
876
877
878
879
880
 
# File 'lib/stripe/resources/terminal/reader.rb', line 873

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

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

Initiates a setup intent flow on a Reader.



893
894
895
896
897
898
899
900
 
# File 'lib/stripe/resources/terminal/reader.rb', line 893

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

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

Initiates a refund on a Reader



913
914
915
916
917
918
919
920
 
# File 'lib/stripe/resources/terminal/reader.rb', line 913

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

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

Sets reader display to show cart details.



933
934
935
936
937
938
939
940
 
# File 'lib/stripe/resources/terminal/reader.rb', line 933

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

.update(id, params = {}, opts = {}) ⇒ Object

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



943
944
945
946
947
948
949
950
 
# File 'lib/stripe/resources/terminal/reader.rb', line 943

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

Instance Method Details

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

Cancels the current reader action.



743
744
745
746
747
748
749
750
 
# File 'lib/stripe/resources/terminal/reader.rb', line 743

def cancel_action(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Initiates an input collection flow on a Reader.



763
764
765
766
767
768
769
770
 
# File 'lib/stripe/resources/terminal/reader.rb', line 763

def collect_inputs(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

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



783
784
785
786
787
788
789
790
 
# File 'lib/stripe/resources/terminal/reader.rb', line 783

def collect_payment_method(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Finalizes a payment on a Reader.



803
804
805
806
807
808
809
810
 
# File 'lib/stripe/resources/terminal/reader.rb', line 803

def confirm_payment_intent(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Deletes a Reader object.



843
844
845
846
847
848
849
850
 
# File 'lib/stripe/resources/terminal/reader.rb', line 843

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Initiates a payment flow on a Reader.



863
864
865
866
867
868
869
870
 
# File 'lib/stripe/resources/terminal/reader.rb', line 863

def process_payment_intent(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Initiates a setup intent flow on a Reader.



883
884
885
886
887
888
889
890
 
# File 'lib/stripe/resources/terminal/reader.rb', line 883

def process_setup_intent(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Initiates a refund on a Reader



903
904
905
906
907
908
909
910
 
# File 'lib/stripe/resources/terminal/reader.rb', line 903

def refund_payment(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Sets reader display to show cart details.



923
924
925
926
927
928
929
930
 
# File 'lib/stripe/resources/terminal/reader.rb', line 923

def set_reader_display(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#test_helpers ⇒ Object 



952
953
954
 
# File 'lib/stripe/resources/terminal/reader.rb', line 952

def test_helpers
  TestHelpers.new(self)
end