com.stripe.model.terminal.Reader Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model.terminal;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.model.Charge;
import com.stripe.model.ExpandableField;
import com.stripe.model.HasId;
import com.stripe.model.MetadataStore;
import com.stripe.model.PaymentIntent;
import com.stripe.model.Refund;
import com.stripe.model.SetupIntent;
import com.stripe.model.StripeObject;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.terminal.ReaderCancelActionParams;
import com.stripe.param.terminal.ReaderCreateParams;
import com.stripe.param.terminal.ReaderListParams;
import com.stripe.param.terminal.ReaderPresentPaymentMethodParams;
import com.stripe.param.terminal.ReaderProcessPaymentIntentParams;
import com.stripe.param.terminal.ReaderProcessSetupIntentParams;
import com.stripe.param.terminal.ReaderRefundPaymentParams;
import com.stripe.param.terminal.ReaderRetrieveParams;
import com.stripe.param.terminal.ReaderSetReaderDisplayParams;
import com.stripe.param.terminal.ReaderUpdateParams;
import java.util.List;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* A Reader represents a physical device for accepting payment details.
*
* Related guide: Connecting
* to a reader
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Reader extends ApiResource implements HasId, MetadataStore {
/** The most recent action performed by the reader. */
@SerializedName("action")
Action action;
/** Always true for a deleted object. */
@SerializedName("deleted")
Boolean deleted;
/** The current software version of the reader. */
@SerializedName("device_sw_version")
String deviceSwVersion;
/**
* Type of reader, one of {@code bbpos_wisepad3}, {@code stripe_m2}, {@code stripe_s700}, {@code
* bbpos_chipper2x}, {@code bbpos_wisepos_e}, {@code verifone_P400}, {@code simulated_wisepos_e},
* or {@code mobile_phone_reader}.
*/
@SerializedName("device_type")
String deviceType;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/** The local IP address of the reader. */
@SerializedName("ip_address")
String ipAddress;
/** Custom label given to the reader for easier identification. */
@SerializedName("label")
String label;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/** The location identifier of the reader. */
@SerializedName("location")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField location;
/**
* 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.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map metadata;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code terminal.reader}.
*/
@SerializedName("object")
String object;
/** Serial number of the reader. */
@SerializedName("serial_number")
String serialNumber;
/**
* The networking status of the reader. We do not recommend using this field in flows that may
* block taking payments.
*
*
One of {@code offline}, or {@code online}.
*/
@SerializedName("status")
String status;
/** Get ID of expandable {@code location} object. */
public String getLocation() {
return (this.location != null) ? this.location.getId() : null;
}
public void setLocation(String id) {
this.location = ApiResource.setExpandableFieldId(id, this.location);
}
/** Get expanded {@code location}. */
public Location getLocationObject() {
return (this.location != null) ? this.location.getExpanded() : null;
}
public void setLocationObject(Location expandableObject) {
this.location = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Cancels the current reader action. */
public Reader cancelAction() throws StripeException {
return cancelAction((Map) null, (RequestOptions) null);
}
/** Cancels the current reader action. */
public Reader cancelAction(RequestOptions options) throws StripeException {
return cancelAction((Map) null, options);
}
/** Cancels the current reader action. */
public Reader cancelAction(Map params) throws StripeException {
return cancelAction(params, (RequestOptions) null);
}
/** Cancels the current reader action. */
public Reader cancelAction(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/cancel_action", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/** Cancels the current reader action. */
public Reader cancelAction(ReaderCancelActionParams params) throws StripeException {
return cancelAction(params, (RequestOptions) null);
}
/** Cancels the current reader action. */
public Reader cancelAction(ReaderCancelActionParams params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/cancel_action", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Reader.class);
}
/** Creates a new {@code Reader} object. */
public static Reader create(Map params) throws StripeException {
return create(params, (RequestOptions) null);
}
/** Creates a new {@code Reader} object. */
public static Reader create(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/readers";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getGlobalResponseGetter().request(request, Reader.class);
}
/** Creates a new {@code Reader} object. */
public static Reader create(ReaderCreateParams params) throws StripeException {
return create(params, (RequestOptions) null);
}
/** Creates a new {@code Reader} object. */
public static Reader create(ReaderCreateParams params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/readers";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Reader.class);
}
/** Deletes a {@code Reader} object. */
public Reader delete() throws StripeException {
return delete((Map) null, (RequestOptions) null);
}
/** Deletes a {@code Reader} object. */
public Reader delete(RequestOptions options) throws StripeException {
return delete((Map) null, options);
}
/** Deletes a {@code Reader} object. */
public Reader delete(Map params) throws StripeException {
return delete(params, (RequestOptions) null);
}
/** Deletes a {@code Reader} object. */
public Reader delete(Map params, RequestOptions options) throws StripeException {
String path = String.format("/v1/terminal/readers/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.DELETE, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/** Returns a list of {@code Reader} objects. */
public static ReaderCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of {@code Reader} objects. */
public static ReaderCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/readers";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, ReaderCollection.class);
}
/** Returns a list of {@code Reader} objects. */
public static ReaderCollection list(ReaderListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of {@code Reader} objects. */
public static ReaderCollection list(ReaderListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/readers";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, ReaderCollection.class);
}
/** Initiates a payment flow on a Reader. */
public Reader processPaymentIntent(Map params) throws StripeException {
return processPaymentIntent(params, (RequestOptions) null);
}
/** Initiates a payment flow on a Reader. */
public Reader processPaymentIntent(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/process_payment_intent",
ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/** Initiates a payment flow on a Reader. */
public Reader processPaymentIntent(ReaderProcessPaymentIntentParams params)
throws StripeException {
return processPaymentIntent(params, (RequestOptions) null);
}
/** Initiates a payment flow on a Reader. */
public Reader processPaymentIntent(
ReaderProcessPaymentIntentParams params, RequestOptions options) throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/process_payment_intent",
ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Reader.class);
}
/** Initiates a setup intent flow on a Reader. */
public Reader processSetupIntent(Map params) throws StripeException {
return processSetupIntent(params, (RequestOptions) null);
}
/** Initiates a setup intent flow on a Reader. */
public Reader processSetupIntent(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/process_setup_intent", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/** Initiates a setup intent flow on a Reader. */
public Reader processSetupIntent(ReaderProcessSetupIntentParams params) throws StripeException {
return processSetupIntent(params, (RequestOptions) null);
}
/** Initiates a setup intent flow on a Reader. */
public Reader processSetupIntent(ReaderProcessSetupIntentParams params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/process_setup_intent", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Reader.class);
}
/** Initiates a refund on a Reader. */
public Reader refundPayment() throws StripeException {
return refundPayment((Map) null, (RequestOptions) null);
}
/** Initiates a refund on a Reader. */
public Reader refundPayment(RequestOptions options) throws StripeException {
return refundPayment((Map) null, options);
}
/** Initiates a refund on a Reader. */
public Reader refundPayment(Map params) throws StripeException {
return refundPayment(params, (RequestOptions) null);
}
/** Initiates a refund on a Reader. */
public Reader refundPayment(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/refund_payment", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/** Initiates a refund on a Reader. */
public Reader refundPayment(ReaderRefundPaymentParams params) throws StripeException {
return refundPayment(params, (RequestOptions) null);
}
/** Initiates a refund on a Reader. */
public Reader refundPayment(ReaderRefundPaymentParams params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/refund_payment", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Reader.class);
}
/** Retrieves a {@code Reader} object. */
public static Reader retrieve(String reader) throws StripeException {
return retrieve(reader, (Map) null, (RequestOptions) null);
}
/** Retrieves a {@code Reader} object. */
public static Reader retrieve(String reader, RequestOptions options) throws StripeException {
return retrieve(reader, (Map) null, options);
}
/** Retrieves a {@code Reader} object. */
public static Reader retrieve(String reader, Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/terminal/readers/%s", ApiResource.urlEncodeId(reader));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, Reader.class);
}
/** Retrieves a {@code Reader} object. */
public static Reader retrieve(String reader, ReaderRetrieveParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/terminal/readers/%s", ApiResource.urlEncodeId(reader));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Reader.class);
}
/** Sets reader display to show cart details. */
public Reader setReaderDisplay(Map params) throws StripeException {
return setReaderDisplay(params, (RequestOptions) null);
}
/** Sets reader display to show cart details. */
public Reader setReaderDisplay(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/set_reader_display", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/** Sets reader display to show cart details. */
public Reader setReaderDisplay(ReaderSetReaderDisplayParams params) throws StripeException {
return setReaderDisplay(params, (RequestOptions) null);
}
/** Sets reader display to show cart details. */
public Reader setReaderDisplay(ReaderSetReaderDisplayParams params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/terminal/readers/%s/set_reader_display", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Reader.class);
}
/**
* Updates a {@code Reader} object by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*/
@Override
public Reader update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Updates a {@code Reader} object by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*/
@Override
public Reader update(Map params, RequestOptions options) throws StripeException {
String path = String.format("/v1/terminal/readers/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Reader.class);
}
/**
* Updates a {@code Reader} object by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*/
public Reader update(ReaderUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Updates a {@code Reader} object by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*/
public Reader update(ReaderUpdateParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/terminal/readers/%s", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Reader.class);
}
/** Represents an action performed by the reader. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Action extends StripeObject {
/** Failure code, only set if status is {@code failed}. */
@SerializedName("failure_code")
String failureCode;
/** Detailed failure message, only set if status is {@code failed}. */
@SerializedName("failure_message")
String failureMessage;
/** Represents a reader action to process a payment intent. */
@SerializedName("process_payment_intent")
ProcessPaymentIntent processPaymentIntent;
/** Represents a reader action to process a setup intent. */
@SerializedName("process_setup_intent")
ProcessSetupIntent processSetupIntent;
/** Represents a reader action to refund a payment. */
@SerializedName("refund_payment")
RefundPayment refundPayment;
/** Represents a reader action to set the reader display. */
@SerializedName("set_reader_display")
SetReaderDisplay setReaderDisplay;
/**
* Status of the action performed by the reader.
*
* One of {@code failed}, {@code in_progress}, or {@code succeeded}.
*/
@SerializedName("status")
String status;
/**
* Type of action performed by the reader.
*
*
One of {@code process_payment_intent}, {@code process_setup_intent}, {@code
* refund_payment}, or {@code set_reader_display}.
*/
@SerializedName("type")
String type;
/** Represents a reader action to process a payment intent. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ProcessPaymentIntent extends StripeObject {
/** Most recent PaymentIntent processed by the reader. */
@SerializedName("payment_intent")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField paymentIntent;
/** Represents a per-transaction override of a reader configuration. */
@SerializedName("process_config")
ProcessConfig processConfig;
/** Get ID of expandable {@code paymentIntent} object. */
public String getPaymentIntent() {
return (this.paymentIntent != null) ? this.paymentIntent.getId() : null;
}
public void setPaymentIntent(String id) {
this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent);
}
/** Get expanded {@code paymentIntent}. */
public PaymentIntent getPaymentIntentObject() {
return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null;
}
public void setPaymentIntentObject(PaymentIntent expandableObject) {
this.paymentIntent =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Represents a per-transaction override of a reader configuration. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ProcessConfig extends StripeObject {
/** Enable customer initiated cancellation when processing this payment. */
@SerializedName("enable_customer_cancellation")
Boolean enableCustomerCancellation;
/** Override showing a tipping selection screen on this transaction. */
@SerializedName("skip_tipping")
Boolean skipTipping;
/** Represents a per-transaction tipping configuration. */
@SerializedName("tipping")
Tipping tipping;
/** Represents a per-transaction tipping configuration. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Tipping extends StripeObject {
/**
* Amount used to calculate tip suggestions on tipping selection screen for this
* transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents
* to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
*/
@SerializedName("amount_eligible")
Long amountEligible;
}
}
}
/** Represents a reader action to process a setup intent. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ProcessSetupIntent extends StripeObject {
/**
* ID of a card PaymentMethod generated from the card_present PaymentMethod that may be
* attached to a Customer for future transactions. Only present if it was possible to generate
* a card PaymentMethod.
*/
@SerializedName("generated_card")
String generatedCard;
/** Represents a per-setup override of a reader configuration. */
@SerializedName("process_config")
ProcessConfig processConfig;
/** Most recent SetupIntent processed by the reader. */
@SerializedName("setup_intent")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField setupIntent;
/** Get ID of expandable {@code setupIntent} object. */
public String getSetupIntent() {
return (this.setupIntent != null) ? this.setupIntent.getId() : null;
}
public void setSetupIntent(String id) {
this.setupIntent = ApiResource.setExpandableFieldId(id, this.setupIntent);
}
/** Get expanded {@code setupIntent}. */
public SetupIntent getSetupIntentObject() {
return (this.setupIntent != null) ? this.setupIntent.getExpanded() : null;
}
public void setSetupIntentObject(SetupIntent expandableObject) {
this.setupIntent =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Represents a per-setup override of a reader configuration. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ProcessConfig extends StripeObject {
/** Enable customer initiated cancellation when processing this SetupIntent. */
@SerializedName("enable_customer_cancellation")
Boolean enableCustomerCancellation;
}
}
/** Represents a reader action to refund a payment. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class RefundPayment extends StripeObject {
/** The amount being refunded. */
@SerializedName("amount")
Long amount;
/** Charge that is being refunded. */
@SerializedName("charge")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField charge;
/**
* 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.
*/
@SerializedName("metadata")
Map metadata;
/** Payment intent that is being refunded. */
@SerializedName("payment_intent")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField paymentIntent;
/**
* The reason for the refund.
*
* One of {@code duplicate}, {@code fraudulent}, or {@code requested_by_customer}.
*/
@SerializedName("reason")
String reason;
/** Unique identifier for the refund object. */
@SerializedName("refund")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField refund;
/**
* Boolean indicating whether the application fee should be refunded when refunding this
* charge. If a full charge refund is given, the full application fee will be refunded.
* Otherwise, the application fee will be refunded in an amount proportional to the amount of
* the charge refunded. An application fee can be refunded only by the application that
* created the charge.
*/
@SerializedName("refund_application_fee")
Boolean refundApplicationFee;
/** Represents a per-transaction override of a reader configuration. */
@SerializedName("refund_payment_config")
RefundPaymentConfig refundPaymentConfig;
/**
* Boolean indicating whether the transfer should be reversed when refunding this charge. The
* transfer will be reversed proportionally to the amount being refunded (either the entire or
* partial amount). A transfer can be reversed only by the application that created the
* charge.
*/
@SerializedName("reverse_transfer")
Boolean reverseTransfer;
/** Get ID of expandable {@code charge} object. */
public String getCharge() {
return (this.charge != null) ? this.charge.getId() : null;
}
public void setCharge(String id) {
this.charge = ApiResource.setExpandableFieldId(id, this.charge);
}
/** Get expanded {@code charge}. */
public Charge getChargeObject() {
return (this.charge != null) ? this.charge.getExpanded() : null;
}
public void setChargeObject(Charge expandableObject) {
this.charge = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code paymentIntent} object. */
public String getPaymentIntent() {
return (this.paymentIntent != null) ? this.paymentIntent.getId() : null;
}
public void setPaymentIntent(String id) {
this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent);
}
/** Get expanded {@code paymentIntent}. */
public PaymentIntent getPaymentIntentObject() {
return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null;
}
public void setPaymentIntentObject(PaymentIntent expandableObject) {
this.paymentIntent =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code refund} object. */
public String getRefund() {
return (this.refund != null) ? this.refund.getId() : null;
}
public void setRefund(String id) {
this.refund = ApiResource.setExpandableFieldId(id, this.refund);
}
/** Get expanded {@code refund}. */
public Refund getRefundObject() {
return (this.refund != null) ? this.refund.getExpanded() : null;
}
public void setRefundObject(Refund expandableObject) {
this.refund = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Represents a per-transaction override of a reader configuration. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class RefundPaymentConfig extends StripeObject {
/** Enable customer initiated cancellation when refunding this payment. */
@SerializedName("enable_customer_cancellation")
Boolean enableCustomerCancellation;
}
}
/** Represents a reader action to set the reader display. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class SetReaderDisplay extends StripeObject {
/** Cart object to be displayed by the reader. */
@SerializedName("cart")
Cart cart;
/**
* Type of information to be displayed by the reader.
*
* Equal to {@code cart}.
*/
@SerializedName("type")
String type;
/** Represents a cart to be displayed on the reader. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Cart extends StripeObject {
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency.
*/
@SerializedName("currency")
String currency;
/** List of line items in the cart. */
@SerializedName("line_items")
List lineItems;
/**
* Tax amount for the entire cart. A positive integer in the smallest currency unit.
*/
@SerializedName("tax")
Long tax;
/**
* Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.
*/
@SerializedName("total")
Long total;
/** Represents a line item to be displayed on the reader. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class LineItem extends StripeObject {
/**
* The amount of the line item. A positive integer in the smallest currency unit.
*/
@SerializedName("amount")
Long amount;
/** Description of the line item. */
@SerializedName("description")
String description;
/** The quantity of the line item. */
@SerializedName("quantity")
Long quantity;
}
}
}
}
public TestHelpers getTestHelpers() {
return new TestHelpers(this);
}
public static class TestHelpers {
private final Reader resource;
private TestHelpers(Reader resource) {
this.resource = resource;
}
/**
* Presents a payment method on a simulated reader. Can be used to simulate accepting a payment,
* saving a card or refunding a transaction.
*/
public Reader presentPaymentMethod() throws StripeException {
return presentPaymentMethod((Map) null, (RequestOptions) null);
}
/**
* Presents a payment method on a simulated reader. Can be used to simulate accepting a payment,
* saving a card or refunding a transaction.
*/
public Reader presentPaymentMethod(RequestOptions options) throws StripeException {
return presentPaymentMethod((Map) null, options);
}
/**
* Presents a payment method on a simulated reader. Can be used to simulate accepting a payment,
* saving a card or refunding a transaction.
*/
public Reader presentPaymentMethod(Map params) throws StripeException {
return presentPaymentMethod(params, (RequestOptions) null);
}
/**
* Presents a payment method on a simulated reader. Can be used to simulate accepting a payment,
* saving a card or refunding a transaction.
*/
public Reader presentPaymentMethod(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/test_helpers/terminal/readers/%s/present_payment_method",
ApiResource.urlEncodeId(this.resource.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return resource.getResponseGetter().request(request, Reader.class);
}
/**
* Presents a payment method on a simulated reader. Can be used to simulate accepting a payment,
* saving a card or refunding a transaction.
*/
public Reader presentPaymentMethod(ReaderPresentPaymentMethodParams params)
throws StripeException {
return presentPaymentMethod(params, (RequestOptions) null);
}
/**
* Presents a payment method on a simulated reader. Can be used to simulate accepting a payment,
* saving a card or refunding a transaction.
*/
public Reader presentPaymentMethod(
ReaderPresentPaymentMethodParams params, RequestOptions options) throws StripeException {
String path =
String.format(
"/v1/test_helpers/terminal/readers/%s/present_payment_method",
ApiResource.urlEncodeId(this.resource.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return resource.getResponseGetter().request(request, Reader.class);
}
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(action, responseGetter);
trySetResponseGetter(location, responseGetter);
}
}