com.squareup.square.models

Class Payout

java.lang.Object

com.squareup.square.models.Payout

public class Payout
extends Object

This is a model class for Payout type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	Payout(String id, String locationId, String status, String createdAt, String updatedAt, Money amountMoney, Destination destination, Integer version, String type, List<PayoutFee> payoutFee, String arrivalDate, String endToEndId) Initialization constructor.
protected	Payout(String id, String locationId, String status, String createdAt, String updatedAt, Money amountMoney, Destination destination, Integer version, String type, io.apimatic.core.types.OptionalNullable<List<PayoutFee>> payoutFee, io.apimatic.core.types.OptionalNullable<String> arrivalDate, io.apimatic.core.types.OptionalNullable<String> endToEndId) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
String	getArrivalDate() Getter for ArrivalDate.
String	getCreatedAt() Getter for CreatedAt.
Destination	getDestination() Getter for Destination.
String	getEndToEndId() Getter for EndToEndId.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
List<PayoutFee>	getPayoutFee() Getter for PayoutFee.
String	getStatus() Getter for Status.
String	getType() Getter for Type.
String	getUpdatedAt() Getter for UpdatedAt.
Integer	getVersion() Getter for Version.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetArrivalDate() Internal Getter for ArrivalDate.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEndToEndId() Internal Getter for EndToEndId.
protected io.apimatic.core.types.OptionalNullable<List<PayoutFee>>	internalGetPayoutFee() Internal Getter for PayoutFee.
Payout.Builder	toBuilder() Builds a new Payout.Builder object.
String	toString() Converts this Payout into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Payout

public Payout(String id,
              String locationId,
              String status,
              String createdAt,
              String updatedAt,
              Money amountMoney,
              Destination destination,
              Integer version,
              String type,
              List<PayoutFee> payoutFee,
              String arrivalDate,
              String endToEndId)

Initialization constructor.

Parameters:

id - String value for id.

locationId - String value for locationId.

status - String value for status.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

amountMoney - Money value for amountMoney.

destination - Destination value for destination.

version - Integer value for version.

type - String value for type.

payoutFee - List of PayoutFee value for payoutFee.

arrivalDate - String value for arrivalDate.

endToEndId - String value for endToEndId.

Payout

protected Payout(String id,
                 String locationId,
                 String status,
                 String createdAt,
                 String updatedAt,
                 Money amountMoney,
                 Destination destination,
                 Integer version,
                 String type,
                 io.apimatic.core.types.OptionalNullable<List<PayoutFee>> payoutFee,
                 io.apimatic.core.types.OptionalNullable<String> arrivalDate,
                 io.apimatic.core.types.OptionalNullable<String> endToEndId)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. A unique ID for the payout.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. Payout status types

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the location associated with the payout.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp of when the payout was last updated, in RFC 3339 format.

Returns:

Returns the String

getAmountMoney

public Money getAmountMoney()

Getter for AmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getDestination

public Destination getDestination()

Getter for Destination. Information about the destination against which the payout was made.

Returns:

Returns the Destination

getVersion

public Integer getVersion()

Getter for Version. The version number, which is incremented each time an update is made to this payout record. The version number helps developers receive event notifications or feeds out of order.

Returns:

Returns the Integer

getType

public String getType()

Getter for Type. The type of payout: “BATCH” or “SIMPLE”. BATCH payouts include a list of payout entries that can be considered settled. SIMPLE payouts do not have any payout entries associated with them and will show up as one of the payout entries in a future BATCH payout.

Returns:

Returns the String

internalGetPayoutFee

protected io.apimatic.core.types.OptionalNullable<List<PayoutFee>> internalGetPayoutFee()

Internal Getter for PayoutFee. A list of transfer fees and any taxes on the fees assessed by Square for this payout.

Returns:

Returns the Internal List of PayoutFee

getPayoutFee

public List<PayoutFee> getPayoutFee()

Getter for PayoutFee. A list of transfer fees and any taxes on the fees assessed by Square for this payout.

Returns:

Returns the List of PayoutFee

internalGetArrivalDate

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

Internal Getter for ArrivalDate. The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.

Returns:

Returns the Internal String

getArrivalDate

public String getArrivalDate()

Getter for ArrivalDate. The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.

Returns:

Returns the String

internalGetEndToEndId

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

Internal Getter for EndToEndId. A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement.

Returns:

Returns the Internal String

getEndToEndId

public String getEndToEndId()

Getter for EndToEndId. A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Payout.Builder toBuilder()

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

Returns:

a new Payout.Builder object