Package com.stripe.model.terminal

Class Reader

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.terminal.Reader

All Implemented Interfaces:

HasId, MetadataStore<Reader>, StripeActiveObject, StripeObjectInterface

public class Reader
extends ApiResource
implements HasId, MetadataStore<Reader>

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Reader.Action	Represents an action performed by the reader.
static class	Reader.TestHelpers

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Reader()

Method Summary

Modifier and Type	Method	Description
Reader	cancelAction()	Cancels the current reader action.
Reader	cancelAction(RequestOptions options)	Cancels the current reader action.
Reader	cancelAction(ReaderCancelActionParams params)	Cancels the current reader action.
Reader	cancelAction(ReaderCancelActionParams params, RequestOptions options)	Cancels the current reader action.
Reader	cancelAction(Map<String,Object> params)	Cancels the current reader action.
Reader	cancelAction(Map<String,Object> params, RequestOptions options)	Cancels the current reader action.
protected boolean	canEqual(Object other)
Reader	collectInputs(ReaderCollectInputsParams params)	Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Reader	collectInputs(ReaderCollectInputsParams params, RequestOptions options)	Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Reader	collectInputs(Map<String,Object> params)	Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Reader	collectInputs(Map<String,Object> params, RequestOptions options)	Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Reader	collectPaymentMethod(ReaderCollectPaymentMethodParams params)	Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Reader	collectPaymentMethod(ReaderCollectPaymentMethodParams params, RequestOptions options)	Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Reader	collectPaymentMethod(Map<String,Object> params)	Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Reader	collectPaymentMethod(Map<String,Object> params, RequestOptions options)	Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Reader	confirmPaymentIntent(ReaderConfirmPaymentIntentParams params)	Finalizes a payment on a Reader.
Reader	confirmPaymentIntent(ReaderConfirmPaymentIntentParams params, RequestOptions options)	Finalizes a payment on a Reader.
Reader	confirmPaymentIntent(Map<String,Object> params)	Finalizes a payment on a Reader.
Reader	confirmPaymentIntent(Map<String,Object> params, RequestOptions options)	Finalizes a payment on a Reader.
static Reader	create(ReaderCreateParams params)	Creates a new Reader object.
static Reader	create(ReaderCreateParams params, RequestOptions options)	Creates a new Reader object.
static Reader	create(Map<String,Object> params)	Creates a new Reader object.
static Reader	create(Map<String,Object> params, RequestOptions options)	Creates a new Reader object.
Reader	delete()	Deletes a Reader object.
Reader	delete(RequestOptions options)	Deletes a Reader object.
Reader	delete(Map<String,Object> params)	Deletes a Reader object.
Reader	delete(Map<String,Object> params, RequestOptions options)	Deletes a Reader object.
boolean	equals(Object o)
Reader.Action	getAction()	The most recent action performed by the reader.
Boolean	getDeleted()	Always true for a deleted object.
String	getDeviceSwVersion()	The current software version of the reader.
String	getDeviceType()	Device type of the reader.
String	getId()	Unique identifier for the object.
String	getIpAddress()	The local IP address of the reader.
String	getLabel()	Custom label given to the reader for easier identification.
Long	getLastSeenAt()	The last time this reader reported to Stripe backend.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getLocation()	Get ID of expandable location object.
Location	getLocationObject()	Get expanded location.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getSerialNumber()	Serial number of the reader.
String	getStatus()	The networking status of the reader.
Reader.TestHelpers	getTestHelpers()	The quantity of the line item.
int	hashCode()
static ReaderCollection	list(ReaderListParams params)	Returns a list of Reader objects.
static ReaderCollection	list(ReaderListParams params, RequestOptions options)	Returns a list of Reader objects.
static ReaderCollection	list(Map<String,Object> params)	Returns a list of Reader objects.
static ReaderCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of Reader objects.
Reader	processPaymentIntent(ReaderProcessPaymentIntentParams params)	Initiates a payment flow on a Reader.
Reader	processPaymentIntent(ReaderProcessPaymentIntentParams params, RequestOptions options)	Initiates a payment flow on a Reader.
Reader	processPaymentIntent(Map<String,Object> params)	Initiates a payment flow on a Reader.
Reader	processPaymentIntent(Map<String,Object> params, RequestOptions options)	Initiates a payment flow on a Reader.
Reader	processSetupIntent(ReaderProcessSetupIntentParams params)	Initiates a SetupIntent flow on a Reader.
Reader	processSetupIntent(ReaderProcessSetupIntentParams params, RequestOptions options)	Initiates a SetupIntent flow on a Reader.
Reader	processSetupIntent(Map<String,Object> params)	Initiates a SetupIntent flow on a Reader.
Reader	processSetupIntent(Map<String,Object> params, RequestOptions options)	Initiates a SetupIntent flow on a Reader.
Reader	refundPayment()	Initiates an in-person refund on a Reader.
Reader	refundPayment(RequestOptions options)	Initiates an in-person refund on a Reader.
Reader	refundPayment(ReaderRefundPaymentParams params)	Initiates an in-person refund on a Reader.
Reader	refundPayment(ReaderRefundPaymentParams params, RequestOptions options)	Initiates an in-person refund on a Reader.
Reader	refundPayment(Map<String,Object> params)	Initiates an in-person refund on a Reader.
Reader	refundPayment(Map<String,Object> params, RequestOptions options)	Initiates an in-person refund on a Reader.
static Reader	retrieve(String reader)	Retrieves a Reader object.
static Reader	retrieve(String reader, RequestOptions options)	Retrieves a Reader object.
static Reader	retrieve(String reader, ReaderRetrieveParams params, RequestOptions options)	Retrieves a Reader object.
static Reader	retrieve(String reader, Map<String,Object> params, RequestOptions options)	Retrieves a Reader object.
void	setAction(Reader.Action action)	The most recent action performed by the reader.
void	setDeleted(Boolean deleted)	Always true for a deleted object.
void	setDeviceSwVersion(String deviceSwVersion)	The current software version of the reader.
void	setDeviceType(String deviceType)	Device type of the reader.
void	setId(String id)	Unique identifier for the object.
void	setIpAddress(String ipAddress)	The local IP address of the reader.
void	setLabel(String label)	Custom label given to the reader for easier identification.
void	setLastSeenAt(Long lastSeenAt)	The last time this reader reported to Stripe backend.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setLocation(String id)
void	setLocationObject(Location expandableObject)
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
Reader	setReaderDisplay(ReaderSetReaderDisplayParams params)	Sets the reader display to show cart details.
Reader	setReaderDisplay(ReaderSetReaderDisplayParams params, RequestOptions options)	Sets the reader display to show cart details.
Reader	setReaderDisplay(Map<String,Object> params)	Sets the reader display to show cart details.
Reader	setReaderDisplay(Map<String,Object> params, RequestOptions options)	Sets the reader display to show cart details.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setSerialNumber(String serialNumber)	Serial number of the reader.
void	setStatus(String status)	The networking status of the reader.
Reader	update(ReaderUpdateParams params)	Updates a Reader object by setting the values of the parameters passed.
Reader	update(ReaderUpdateParams params, RequestOptions options)	Updates a Reader object by setting the values of the parameters passed.
Reader	update(Map<String,Object> params)	Updates a Reader object by setting the values of the parameters passed.
Reader	update(Map<String,Object> params, RequestOptions options)	Updates a Reader object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Reader

public Reader()

Method Details

getLocation

public String getLocation()

Get ID of expandable location object.

setLocation

public void setLocation(String id)

getLocationObject

public Location getLocationObject()

Get expanded location.

setLocationObject

public void setLocationObject(Location expandableObject)

cancelAction

public Reader cancelAction()
                    throws StripeException

Cancels the current reader action. See Programmatic Cancellation for more details.

Throws:

StripeException

cancelAction

public Reader cancelAction(RequestOptions options)
                    throws StripeException

Cancels the current reader action. See Programmatic Cancellation for more details.

Throws:

StripeException

cancelAction

public Reader cancelAction(Map<String,Object> params)
                    throws StripeException

Cancels the current reader action. See Programmatic Cancellation for more details.

Throws:

StripeException

cancelAction

public Reader cancelAction(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

Cancels the current reader action. See Programmatic Cancellation for more details.

Throws:

StripeException

cancelAction

public Reader cancelAction(ReaderCancelActionParams params)
                    throws StripeException

Cancels the current reader action. See Programmatic Cancellation for more details.

Throws:

StripeException

cancelAction

public Reader cancelAction(ReaderCancelActionParams params,
 RequestOptions options)
                    throws StripeException

Cancels the current reader action. See Programmatic Cancellation for more details.

Throws:

StripeException

collectInputs

public Reader collectInputs(Map<String,Object> params)
                     throws StripeException

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

Throws:

StripeException

collectInputs

public Reader collectInputs(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

Throws:

StripeException

collectInputs

public Reader collectInputs(ReaderCollectInputsParams params)
                     throws StripeException

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

Throws:

StripeException

collectInputs

public Reader collectInputs(ReaderCollectInputsParams params,
 RequestOptions options)
                     throws StripeException

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

Throws:

StripeException

collectPaymentMethod

public Reader collectPaymentMethod(Map<String,Object> params)
                            throws StripeException

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

Throws:

StripeException

collectPaymentMethod

public Reader collectPaymentMethod(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

Throws:

StripeException

collectPaymentMethod

public Reader collectPaymentMethod(ReaderCollectPaymentMethodParams params)
                            throws StripeException

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

Throws:

StripeException

collectPaymentMethod

public Reader collectPaymentMethod(ReaderCollectPaymentMethodParams params,
 RequestOptions options)
                            throws StripeException

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

Throws:

StripeException

confirmPaymentIntent

public Reader confirmPaymentIntent(Map<String,Object> params)
                            throws StripeException

Finalizes a payment on a Reader. See Confirming a Payment for more details.

Throws:

StripeException

confirmPaymentIntent

public Reader confirmPaymentIntent(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Finalizes a payment on a Reader. See Confirming a Payment for more details.

Throws:

StripeException

confirmPaymentIntent

public Reader confirmPaymentIntent(ReaderConfirmPaymentIntentParams params)
                            throws StripeException

Finalizes a payment on a Reader. See Confirming a Payment for more details.

Throws:

StripeException

confirmPaymentIntent

public Reader confirmPaymentIntent(ReaderConfirmPaymentIntentParams params,
 RequestOptions options)
                            throws StripeException

Finalizes a payment on a Reader. See Confirming a Payment for more details.

Throws:

StripeException

create

public static Reader create(Map<String,Object> params)
                     throws StripeException

Creates a new Reader object.

Throws:

StripeException

create

public static Reader create(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Creates a new Reader object.

Throws:

StripeException

create

public static Reader create(ReaderCreateParams params)
                     throws StripeException

Creates a new Reader object.

Throws:

StripeException

create

public static Reader create(ReaderCreateParams params,
 RequestOptions options)
                     throws StripeException

Creates a new Reader object.

Throws:

StripeException

delete

public Reader delete()
              throws StripeException

Deletes a Reader object.

Throws:

StripeException

delete

public Reader delete(RequestOptions options)
              throws StripeException

Deletes a Reader object.

Throws:

StripeException

delete

public Reader delete(Map<String,Object> params)
              throws StripeException

Deletes a Reader object.

Throws:

StripeException

delete

public Reader delete(Map<String,Object> params,
 RequestOptions options)
              throws StripeException

Deletes a Reader object.

Throws:

StripeException

list

public static ReaderCollection list(Map<String,Object> params)
                             throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

list

public static ReaderCollection list(Map<String,Object> params,
 RequestOptions options)
                             throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

list

public static ReaderCollection list(ReaderListParams params)
                             throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

list

public static ReaderCollection list(ReaderListParams params,
 RequestOptions options)
                             throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

processPaymentIntent

public Reader processPaymentIntent(Map<String,Object> params)
                            throws StripeException

Initiates a payment flow on a Reader. See process the payment for more details.

Throws:

StripeException

processPaymentIntent

public Reader processPaymentIntent(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Initiates a payment flow on a Reader. See process the payment for more details.

Throws:

StripeException

processPaymentIntent

public Reader processPaymentIntent(ReaderProcessPaymentIntentParams params)
                            throws StripeException

Initiates a payment flow on a Reader. See process the payment for more details.

Throws:

StripeException

processPaymentIntent

public Reader processPaymentIntent(ReaderProcessPaymentIntentParams params,
 RequestOptions options)
                            throws StripeException

Initiates a payment flow on a Reader. See process the payment for more details.

Throws:

StripeException

processSetupIntent

public Reader processSetupIntent(Map<String,Object> params)
                          throws StripeException

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

Throws:

StripeException

processSetupIntent

public Reader processSetupIntent(Map<String,Object> params,
 RequestOptions options)
                          throws StripeException

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

Throws:

StripeException

processSetupIntent

public Reader processSetupIntent(ReaderProcessSetupIntentParams params)
                          throws StripeException

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

Throws:

StripeException

processSetupIntent

public Reader processSetupIntent(ReaderProcessSetupIntentParams params,
 RequestOptions options)
                          throws StripeException

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

Throws:

StripeException

refundPayment

public Reader refundPayment()
                     throws StripeException

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Throws:

StripeException

refundPayment

public Reader refundPayment(RequestOptions options)
                     throws StripeException

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Throws:

StripeException

refundPayment

public Reader refundPayment(Map<String,Object> params)
                     throws StripeException

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Throws:

StripeException

refundPayment

public Reader refundPayment(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Throws:

StripeException

refundPayment

public Reader refundPayment(ReaderRefundPaymentParams params)
                     throws StripeException

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Throws:

StripeException

refundPayment

public Reader refundPayment(ReaderRefundPaymentParams params,
 RequestOptions options)
                     throws StripeException

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Throws:

StripeException

retrieve

public static Reader retrieve(String reader)
                       throws StripeException

Retrieves a Reader object.

Throws:

StripeException

retrieve

public static Reader retrieve(String reader,
 RequestOptions options)
                       throws StripeException

Retrieves a Reader object.

Throws:

StripeException

retrieve

public static Reader retrieve(String reader,
 Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Retrieves a Reader object.

Throws:

StripeException

retrieve

public static Reader retrieve(String reader,
 ReaderRetrieveParams params,
 RequestOptions options)
                       throws StripeException

Retrieves a Reader object.

Throws:

StripeException

setReaderDisplay

public Reader setReaderDisplay(Map<String,Object> params)
                        throws StripeException

Sets the reader display to show cart details.

Throws:

StripeException

setReaderDisplay

public Reader setReaderDisplay(Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Sets the reader display to show cart details.

Throws:

StripeException

setReaderDisplay

public Reader setReaderDisplay(ReaderSetReaderDisplayParams params)
                        throws StripeException

Sets the reader display to show cart details.

Throws:

StripeException

setReaderDisplay

public Reader setReaderDisplay(ReaderSetReaderDisplayParams params,
 RequestOptions options)
                        throws StripeException

Sets the reader display to show cart details.

Throws:

StripeException

update

public Reader update(Map<String,Object> params)
              throws StripeException

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

Specified by:

update in interface MetadataStore<Reader>

Throws:

StripeException

update

public Reader update(Map<String,Object> params,
 RequestOptions options)
              throws StripeException

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

Specified by:

update in interface MetadataStore<Reader>

Throws:

StripeException

update

public Reader update(ReaderUpdateParams params)
              throws StripeException

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

Throws:

StripeException

update

public Reader update(ReaderUpdateParams params,
 RequestOptions options)
              throws StripeException

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

Throws:

StripeException

getTestHelpers

public Reader.TestHelpers getTestHelpers()

The quantity of the line item.

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAction

public Reader.Action getAction()

The most recent action performed by the reader.

getDeleted

public Boolean getDeleted()

Always true for a deleted object.

getDeviceSwVersion

public String getDeviceSwVersion()

The current software version of the reader.

getDeviceType

public String getDeviceType()

Device type of the reader.

One of bbpos_chipper2x, bbpos_wisepad3, bbpos_wisepos_e, mobile_phone_reader, simulated_stripe_s700, simulated_wisepos_e, stripe_m2, stripe_s700, or verifone_P400.

getIpAddress

public String getIpAddress()

The local IP address of the reader.

getLabel

public String getLabel()

Custom label given to the reader for easier identification.

getLastSeenAt

public Long getLastSeenAt()

The last time this reader reported to Stripe backend.

getLivemode

public Boolean getLivemode()

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

getObject

public String getObject()

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

Equal to terminal.reader.

getSerialNumber

public String getSerialNumber()

Serial number of the reader.

getStatus

public String getStatus()

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

One of offline, or online.

setAction

public void setAction(Reader.Action action)

The most recent action performed by the reader.

setDeleted

public void setDeleted(Boolean deleted)

Always true for a deleted object.

setDeviceSwVersion

public void setDeviceSwVersion(String deviceSwVersion)

The current software version of the reader.

setDeviceType

public void setDeviceType(String deviceType)

Device type of the reader.

One of bbpos_chipper2x, bbpos_wisepad3, bbpos_wisepos_e, mobile_phone_reader, simulated_stripe_s700, simulated_wisepos_e, stripe_m2, stripe_s700, or verifone_P400.

setId

public void setId(String id)

Unique identifier for the object.

setIpAddress

public void setIpAddress(String ipAddress)

The local IP address of the reader.

setLabel

public void setLabel(String label)

Custom label given to the reader for easier identification.

setLastSeenAt

public void setLastSeenAt(Long lastSeenAt)

The last time this reader reported to Stripe backend.

setLivemode

public void setLivemode(Boolean livemode)

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

setMetadata

public void setMetadata(Map<String,String> metadata)

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.

setObject

public void setObject(String object)

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

Equal to terminal.reader.

setSerialNumber

public void setSerialNumber(String serialNumber)

Serial number of the reader.

setStatus

public void setStatus(String status)

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

One of offline, or online.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

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.

Specified by:

getMetadata in interface MetadataStore<Reader>