com.squareup.square.models

Class Transaction

java.lang.Object

com.squareup.square.models.Transaction

public class Transaction
extends Object

This is a model class for Transaction type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Transaction(String id, io.apimatic.core.types.OptionalNullable<String> locationId, String createdAt, io.apimatic.core.types.OptionalNullable<List<Tender>> tenders, io.apimatic.core.types.OptionalNullable<List<Refund>> refunds, io.apimatic.core.types.OptionalNullable<String> referenceId, String product, io.apimatic.core.types.OptionalNullable<String> clientId, Address shippingAddress, io.apimatic.core.types.OptionalNullable<String> orderId) Initialization constructor.
	Transaction(String id, String locationId, String createdAt, List<Tender> tenders, List<Refund> refunds, String referenceId, String product, String clientId, Address shippingAddress, String orderId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientId() Getter for ClientId.
String	getCreatedAt() Getter for CreatedAt.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getOrderId() Getter for OrderId.
String	getProduct() Getter for Product.
String	getReferenceId() Getter for ReferenceId.
List<Refund>	getRefunds() Getter for Refunds.
Address	getShippingAddress() Getter for ShippingAddress.
List<Tender>	getTenders() Getter for Tenders.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetClientId() Internal Getter for ClientId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetLocationId() Internal Getter for LocationId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOrderId() Internal Getter for OrderId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
protected io.apimatic.core.types.OptionalNullable<List<Refund>>	internalGetRefunds() Internal Getter for Refunds.
protected io.apimatic.core.types.OptionalNullable<List<Tender>>	internalGetTenders() Internal Getter for Tenders.
Transaction.Builder	toBuilder() Builds a new Transaction.Builder object.
String	toString() Converts this Transaction into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transaction

public Transaction(String id,
                   String locationId,
                   String createdAt,
                   List<Tender> tenders,
                   List<Refund> refunds,
                   String referenceId,
                   String product,
                   String clientId,
                   Address shippingAddress,
                   String orderId)

Initialization constructor.

Parameters:

id - String value for id.

locationId - String value for locationId.

createdAt - String value for createdAt.

tenders - List of Tender value for tenders.

refunds - List of Refund value for refunds.

referenceId - String value for referenceId.

product - String value for product.

clientId - String value for clientId.

shippingAddress - Address value for shippingAddress.

orderId - String value for orderId.

Transaction

protected Transaction(String id,
                      io.apimatic.core.types.OptionalNullable<String> locationId,
                      String createdAt,
                      io.apimatic.core.types.OptionalNullable<List<Tender>> tenders,
                      io.apimatic.core.types.OptionalNullable<List<Refund>> refunds,
                      io.apimatic.core.types.OptionalNullable<String> referenceId,
                      String product,
                      io.apimatic.core.types.OptionalNullable<String> clientId,
                      Address shippingAddress,
                      io.apimatic.core.types.OptionalNullable<String> orderId)

Initialization constructor.

Parameters:

id - String value for id.

locationId - String value for locationId.

createdAt - String value for createdAt.

tenders - List of Tender value for tenders.

refunds - List of Refund value for refunds.

referenceId - String value for referenceId.

product - String value for product.

clientId - String value for clientId.

shippingAddress - Address value for shippingAddress.

orderId - String value for orderId.

Method Detail

getId

public String getId()

Getter for Id. The transaction's unique ID, issued by Square payments servers.

Returns:

Returns the String

internalGetLocationId

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

Internal Getter for LocationId. The ID of the transaction's associated location.

Returns:

Returns the Internal String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the transaction's associated location.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp for when the transaction was created, in RFC 3339 format.

Returns:

Returns the String

internalGetTenders

protected io.apimatic.core.types.OptionalNullable<List<Tender>> internalGetTenders()

Internal Getter for Tenders. The tenders used to pay in the transaction.

Returns:

Returns the Internal List of Tender

getTenders

public List<Tender> getTenders()

Getter for Tenders. The tenders used to pay in the transaction.

Returns:

Returns the List of Tender

internalGetRefunds

protected io.apimatic.core.types.OptionalNullable<List<Refund>> internalGetRefunds()

Internal Getter for Refunds. Refunds that have been applied to any tender in the transaction.

Returns:

Returns the Internal List of Refund

getRefunds

public List<Refund> getRefunds()

Getter for Refunds. Refunds that have been applied to any tender in the transaction.

Returns:

Returns the List of Refund

internalGetReferenceId

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

Internal Getter for ReferenceId. If the transaction was created with the [Charge](api-endpoint:Transactions-Charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.

Returns:

Returns the Internal String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. If the transaction was created with the [Charge](api-endpoint:Transactions-Charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.

Returns:

Returns the String

getProduct

public String getProduct()

Getter for Product. Indicates the Square product used to process a transaction.

Returns:

Returns the String

internalGetClientId

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

Internal Getter for ClientId. If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale. This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode). It is not currently possible with the Connect API to perform a transaction lookup by this value.

Returns:

Returns the Internal String

getClientId

public String getClientId()

Getter for ClientId. If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale. This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode). It is not currently possible with the Connect API to perform a transaction lookup by this value.

Returns:

Returns the String

getShippingAddress

public Address getShippingAddress()

Getter for ShippingAddress. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the Address

internalGetOrderId

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

Internal Getter for OrderId. The order_id is an identifier for the order associated with this transaction, if any.

Returns:

Returns the Internal String

getOrderId

public String getOrderId()

Getter for OrderId. The order_id is an identifier for the order associated with this transaction, if any.

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 Transaction into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Transaction.Builder toBuilder()

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

Returns:

a new Transaction.Builder object