com.squareup.square.models

Class PaymentOptions

java.lang.Object

com.squareup.square.models.PaymentOptions

public class PaymentOptions
extends Object

This is a model class for PaymentOptions type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentOptions.Builder Class to build instances of PaymentOptions.

Constructor Summary

Constructors

Modifier	Constructor and Description
	PaymentOptions(Boolean autocomplete, String delayDuration, Boolean acceptPartialAuthorization, String delayAction) Initialization constructor.
protected	PaymentOptions(io.apimatic.core.types.OptionalNullable<Boolean> autocomplete, io.apimatic.core.types.OptionalNullable<String> delayDuration, io.apimatic.core.types.OptionalNullable<Boolean> acceptPartialAuthorization, String delayAction) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAcceptPartialAuthorization() Getter for AcceptPartialAuthorization.
Boolean	getAutocomplete() Getter for Autocomplete.
String	getDelayAction() Getter for DelayAction.
String	getDelayDuration() Getter for DelayDuration.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAcceptPartialAuthorization() Internal Getter for AcceptPartialAuthorization.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAutocomplete() Internal Getter for Autocomplete.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDelayDuration() Internal Getter for DelayDuration.
PaymentOptions.Builder	toBuilder() Builds a new PaymentOptions.Builder object.
String	toString() Converts this PaymentOptions into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentOptions

public PaymentOptions(Boolean autocomplete,
                      String delayDuration,
                      Boolean acceptPartialAuthorization,
                      String delayAction)

Initialization constructor.

Parameters:

autocomplete - Boolean value for autocomplete.

delayDuration - String value for delayDuration.

acceptPartialAuthorization - Boolean value for acceptPartialAuthorization.

delayAction - String value for delayAction.

PaymentOptions

protected PaymentOptions(io.apimatic.core.types.OptionalNullable<Boolean> autocomplete,
                         io.apimatic.core.types.OptionalNullable<String> delayDuration,
                         io.apimatic.core.types.OptionalNullable<Boolean> acceptPartialAuthorization,
                         String delayAction)

Internal initialization constructor.

Method Detail

internalGetAutocomplete

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAutocomplete()

Internal Getter for Autocomplete. Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically `COMPLETED` or left in an `APPROVED` state for later modification.

Returns:

Returns the Internal Boolean

getAutocomplete

public Boolean getAutocomplete()

Getter for Autocomplete. Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically `COMPLETED` or left in an `APPROVED` state for later modification.

Returns:

Returns the Boolean

internalGetDelayDuration

protected io.apimatic.core.types.OptionalNullable<String> internalGetDelayDuration()

Internal Getter for DelayDuration. The duration of time after the payment's creation when Square automatically cancels the payment. This automatic cancellation applies only to payments that do not reach a terminal state (COMPLETED or CANCELED) before the `delay_duration` time period. This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value of 1 minute. Note: This feature is only supported for card payments. This parameter can only be set for a delayed capture payment (`autocomplete=false`). Default: - Card-present payments: "PT36H" (36 hours) from the creation time. - Card-not-present payments: "P7D" (7 days) from the creation time.

Returns:

Returns the Internal String

getDelayDuration

public String getDelayDuration()

Getter for DelayDuration. The duration of time after the payment's creation when Square automatically cancels the payment. This automatic cancellation applies only to payments that do not reach a terminal state (COMPLETED or CANCELED) before the `delay_duration` time period. This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value of 1 minute. Note: This feature is only supported for card payments. This parameter can only be set for a delayed capture payment (`autocomplete=false`). Default: - Card-present payments: "PT36H" (36 hours) from the creation time. - Card-not-present payments: "P7D" (7 days) from the creation time.

Returns:

Returns the String

internalGetAcceptPartialAuthorization

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAcceptPartialAuthorization()

Internal Getter for AcceptPartialAuthorization. If set to `true` and charging a Square Gift Card, a payment might be returned with `amount_money` equal to less than what was requested. For example, a request for $20 when charging a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card payment. This field cannot be `true` when `autocomplete = true`. This field cannot be `true` when an `order_id` isn't specified. For more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards). Default: false

Returns:

Returns the Internal Boolean

getAcceptPartialAuthorization

public Boolean getAcceptPartialAuthorization()

Getter for AcceptPartialAuthorization. If set to `true` and charging a Square Gift Card, a payment might be returned with `amount_money` equal to less than what was requested. For example, a request for $20 when charging a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card payment. This field cannot be `true` when `autocomplete = true`. This field cannot be `true` when an `order_id` isn't specified. For more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards). Default: false

Returns:

Returns the Boolean

getDelayAction

public String getDelayAction()

Getter for DelayAction. Describes the action to be applied to a delayed capture payment when the delay_duration has elapsed.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this PaymentOptions into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PaymentOptions.Builder toBuilder()

Builds a new PaymentOptions.Builder object. Creates the instance with the state of the current model.

Returns:

a new PaymentOptions.Builder object