NAME

Net::API::Stripe::Terminal::Reader - A Stripe Terminal Reader Object

SYNOPSIS

my $reader = $stripe->reader({
    device_sw_version => '1.0.2',
    device_type => 'verifone_P400',
    ip_address => '1.2.3.4',
    label => 'Blue Rabbit',
    # Anywhere
    location => undef,
    registration_code => 'puppies-plug-could',
    serial_number => '123-456-789',
});

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

v0.101.0

DESCRIPTION

A Reader represents a physical device for accepting payment details.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Terminal::Reader object. It may also take an hash like arguments, that also are method of the same name.

METHODS

id string

Unique identifier for the object.

object string, value is "terminal.reader"

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

action object

The most recent action performed by the reader.

This is a Net::API::Stripe::Payout object.

device_sw_version string

The current software version of the reader.

device_type string

Type of reader, e.g., verifone_P400 or bbpos_chipper2x.

ip_address string

The local IP address of the reader.

label string

Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.

livemode boolean

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

location string

The location to assign the reader to. If no location is specified, the reader will be assigned to the account’s default location.

metadata hash

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

serial_number string

Serial number of the reader.

status string

The networking status of the reader.

API SAMPLE

{
  "id": "tmr_P400-123-456-789",
  "object": "terminal.reader",
  "device_sw_version": null,
  "device_type": "verifone_P400",
  "ip_address": "192.168.2.2",
  "label": "Blue Rabbit",
  "livemode": false,
  "location": "tml_1234",
  "metadata": {},
  "serial_number": "123-456-789",
  "status": "online",
  "registration_code": "puppies-plug-could"
}

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/terminal/readers, https://stripe.com/docs/terminal/readers/connecting

COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.