Package com.stripe.service.terminal

Class ReaderService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.terminal.ReaderService

public final class ReaderService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
ReaderService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Reader	cancelAction(String reader)	Cancels the current reader action.
Reader	cancelAction(String reader, RequestOptions options)	Cancels the current reader action.
Reader	cancelAction(String reader, ReaderCancelActionParams params)	Cancels the current reader action.
Reader	cancelAction(String reader, ReaderCancelActionParams params, RequestOptions options)	Cancels the current reader action.
Reader	collectInputs(String reader, ReaderCollectInputsParams params)	Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Reader	collectInputs(String reader, ReaderCollectInputsParams params, RequestOptions options)	Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Reader	collectPaymentMethod(String reader, ReaderCollectPaymentMethodParams params)	Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Reader	collectPaymentMethod(String reader, ReaderCollectPaymentMethodParams params, RequestOptions options)	Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Reader	confirmPaymentIntent(String reader, ReaderConfirmPaymentIntentParams params)	Finalizes a payment on a Reader.
Reader	confirmPaymentIntent(String reader, ReaderConfirmPaymentIntentParams params, RequestOptions options)	Finalizes a payment on a Reader.
Reader	create(ReaderCreateParams params)	Creates a new Reader object.
Reader	create(ReaderCreateParams params, RequestOptions options)	Creates a new Reader object.
Reader	delete(String reader)	Deletes a Reader object.
Reader	delete(String reader, RequestOptions options)	Deletes a Reader object.
StripeCollection<Reader>	list()	Returns a list of Reader objects.
StripeCollection<Reader>	list(RequestOptions options)	Returns a list of Reader objects.
StripeCollection<Reader>	list(ReaderListParams params)	Returns a list of Reader objects.
StripeCollection<Reader>	list(ReaderListParams params, RequestOptions options)	Returns a list of Reader objects.
Reader	processPaymentIntent(String reader, ReaderProcessPaymentIntentParams params)	Initiates a payment flow on a Reader.
Reader	processPaymentIntent(String reader, ReaderProcessPaymentIntentParams params, RequestOptions options)	Initiates a payment flow on a Reader.
Reader	processSetupIntent(String reader, ReaderProcessSetupIntentParams params)	Initiates a SetupIntent flow on a Reader.
Reader	processSetupIntent(String reader, ReaderProcessSetupIntentParams params, RequestOptions options)	Initiates a SetupIntent flow on a Reader.
Reader	refundPayment(String reader)	Initiates an in-person refund on a Reader.
Reader	refundPayment(String reader, RequestOptions options)	Initiates an in-person refund on a Reader.
Reader	refundPayment(String reader, ReaderRefundPaymentParams params)	Initiates an in-person refund on a Reader.
Reader	refundPayment(String reader, ReaderRefundPaymentParams params, RequestOptions options)	Initiates an in-person refund on a Reader.
Reader	retrieve(String reader)	Retrieves a Reader object.
Reader	retrieve(String reader, RequestOptions options)	Retrieves a Reader object.
Reader	retrieve(String reader, ReaderRetrieveParams params)	Retrieves a Reader object.
Reader	retrieve(String reader, ReaderRetrieveParams params, RequestOptions options)	Retrieves a Reader object.
Reader	setReaderDisplay(String reader, ReaderSetReaderDisplayParams params)	Sets the reader display to show cart details.
Reader	setReaderDisplay(String reader, ReaderSetReaderDisplayParams params, RequestOptions options)	Sets the reader display to show cart details.
Reader	update(String reader)	Updates a Reader object by setting the values of the parameters passed.
Reader	update(String reader, RequestOptions options)	Updates a Reader object by setting the values of the parameters passed.
Reader	update(String reader, ReaderUpdateParams params)	Updates a Reader object by setting the values of the parameters passed.
Reader	update(String reader, ReaderUpdateParams params, RequestOptions options)	Updates a Reader object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReaderService

public ReaderService(StripeResponseGetter responseGetter)

Method Details

delete

public Reader delete(String reader)
              throws StripeException

Deletes a Reader object.

Throws:

StripeException

delete

public Reader delete(String reader,
 RequestOptions options)
              throws StripeException

Deletes a Reader object.

Throws:

StripeException

retrieve

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

Retrieves a Reader object.

Throws:

StripeException

retrieve

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

Retrieves a Reader object.

Throws:

StripeException

retrieve

public Reader retrieve(String reader)
                throws StripeException

Retrieves a Reader object.

Throws:

StripeException

retrieve

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

Retrieves a Reader object.

Throws:

StripeException

update

public Reader update(String reader,
 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(String reader,
 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

update

public Reader update(String reader)
              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(String reader,
 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

list

public StripeCollection<Reader> list(ReaderListParams params)
                              throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

list

public StripeCollection<Reader> list(RequestOptions options)
                              throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

list

public StripeCollection<Reader> list()
                              throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

list

public StripeCollection<Reader> list(ReaderListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of Reader objects.

Throws:

StripeException

create

public Reader create(ReaderCreateParams params)
              throws StripeException

Creates a new Reader object.

Throws:

StripeException

create

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

Creates a new Reader object.

Throws:

StripeException

cancelAction

public Reader cancelAction(String reader,
 ReaderCancelActionParams params)
                    throws StripeException

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

Throws:

StripeException

cancelAction

public Reader cancelAction(String reader,
 RequestOptions options)
                    throws StripeException

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

Throws:

StripeException

cancelAction

public Reader cancelAction(String reader)
                    throws StripeException

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

Throws:

StripeException

cancelAction

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

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

Throws:

StripeException

collectInputs

public Reader collectInputs(String reader,
 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(String reader,
 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(String reader,
 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(String reader,
 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(String reader,
 ReaderConfirmPaymentIntentParams params)
                            throws StripeException

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

Throws:

StripeException

confirmPaymentIntent

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

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

Throws:

StripeException

processPaymentIntent

public Reader processPaymentIntent(String reader,
 ReaderProcessPaymentIntentParams params)
                            throws StripeException

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

Throws:

StripeException

processPaymentIntent

public Reader processPaymentIntent(String reader,
 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(String reader,
 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(String reader,
 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(String reader,
 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(String reader,
 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(String reader)
                     throws StripeException

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

Throws:

StripeException

refundPayment

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

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

Throws:

StripeException

setReaderDisplay

public Reader setReaderDisplay(String reader,
 ReaderSetReaderDisplayParams params)
                        throws StripeException

Sets the reader display to show cart details.

Throws:

StripeException

setReaderDisplay

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

Sets the reader display to show cart details.

Throws:

StripeException