com.squareup.square.models

Class PayOrderRequest

java.lang.Object

com.squareup.square.models.PayOrderRequest

public class PayOrderRequest
extends Object

This is a model class for PayOrderRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PayOrderRequest(String idempotencyKey, Integer orderVersion, List<String> paymentIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIdempotencyKey() Getter for IdempotencyKey.
Integer	getOrderVersion() Getter for OrderVersion.
List<String>	getPaymentIds() Getter for PaymentIds.
int	hashCode()
PayOrderRequest.Builder	toBuilder() Builds a new PayOrderRequest.Builder object.
String	toString() Converts this PayOrderRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PayOrderRequest

public PayOrderRequest(String idempotencyKey,
                       Integer orderVersion,
                       List<String> paymentIds)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

orderVersion - Integer value for orderVersion.

paymentIds - List of String value for paymentIds.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A value you specify that uniquely identifies this request among requests you have sent. If you are unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).

Returns:

Returns the String

getOrderVersion

public Integer getOrderVersion()

Getter for OrderVersion. The version of the order being paid. If not supplied, the latest version will be paid.

Returns:

Returns the Integer

getPaymentIds

public List<String> getPaymentIds()

Getter for PaymentIds. The IDs of the [payments]($m/Payment) to collect. The payment total must match the order total.

Returns:

Returns the List of 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 PayOrderRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PayOrderRequest.Builder toBuilder()

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

Returns:

a new PayOrderRequest.Builder object