Payment (Square 6.3.0.20200826 API)

java.lang.Object
- com.squareup.square.models.Payment

```
public class Payment
extends Object
```
This is a model class for Payment type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Payment.Builder
Class to build instances of Payment

Nested Classes
Modifier and Type	Class and Description
`static class`	`Payment.Builder` Class to build instances of `Payment`

Constructor Summary

Constructors
Constructor and Description
Payment(String id, String createdAt, String updatedAt, Money amountMoney, Money tipMoney, Money totalMoney, Money appFeeMoney, List<ProcessingFee> processingFee, Money refundedMoney, String status, String delayDuration, String delayAction, String delayedUntil, String sourceType, CardPaymentDetails cardDetails, String locationId, String orderId, String referenceId, String customerId, String employeeId, List<String> refundIds, String buyerEmailAddress, Address billingAddress, Address shippingAddress, String note, String statementDescriptionIdentifier, String receiptNumber, String receiptUrl) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Money`	`getAmountMoney()` Getter for AmountMoney.
`Money`	`getAppFeeMoney()` Getter for AppFeeMoney.
`Address`	`getBillingAddress()` Getter for BillingAddress.
`String`	`getBuyerEmailAddress()` Getter for BuyerEmailAddress.
`CardPaymentDetails`	`getCardDetails()` Getter for CardDetails.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCustomerId()` Getter for CustomerId.
`String`	`getDelayAction()` Getter for DelayAction.
`String`	`getDelayDuration()` Getter for DelayDuration.
`String`	`getDelayedUntil()` Getter for DelayedUntil.
`String`	`getEmployeeId()` Getter for EmployeeId.
`String`	`getId()` Getter for Id.
`String`	`getLocationId()` Getter for LocationId.
`String`	`getNote()` Getter for Note.
`String`	`getOrderId()` Getter for OrderId.
`List<ProcessingFee>`	`getProcessingFee()` Getter for ProcessingFee.
`String`	`getReceiptNumber()` Getter for ReceiptNumber.
`String`	`getReceiptUrl()` Getter for ReceiptUrl.
`String`	`getReferenceId()` Getter for ReferenceId.
`Money`	`getRefundedMoney()` Getter for RefundedMoney.
`List<String>`	`getRefundIds()` Getter for RefundIds.
`Address`	`getShippingAddress()` Getter for ShippingAddress.
`String`	`getSourceType()` Getter for SourceType.
`String`	`getStatementDescriptionIdentifier()` Getter for StatementDescriptionIdentifier.
`String`	`getStatus()` Getter for Status.
`Money`	`getTipMoney()` Getter for TipMoney.
`Money`	`getTotalMoney()` Getter for TotalMoney.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`int`	`hashCode()`
`Payment.Builder`	`toBuilder()` Builds a new `Payment.Builder` object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Payment
```
public Payment(String id,
               String createdAt,
               String updatedAt,
               Money amountMoney,
               Money tipMoney,
               Money totalMoney,
               Money appFeeMoney,
               List<ProcessingFee> processingFee,
               Money refundedMoney,
               String status,
               String delayDuration,
               String delayAction,
               String delayedUntil,
               String sourceType,
               CardPaymentDetails cardDetails,
               String locationId,
               String orderId,
               String referenceId,
               String customerId,
               String employeeId,
               List<String> refundIds,
               String buyerEmailAddress,
               Address billingAddress,
               Address shippingAddress,
               String note,
               String statementDescriptionIdentifier,
               String receiptNumber,
               String receiptUrl)
```
    Initialization constructor.
    
    Parameters:
    
    id -
    
    createdAt -
    
    updatedAt -
    
    amountMoney -
    
    tipMoney -
    
    totalMoney -
    
    appFeeMoney -
    
    processingFee -
    
    refundedMoney -
    
    status -
    
    delayDuration -
    
    delayAction -
    
    delayedUntil -
    
    sourceType -
    
    cardDetails -
    
    locationId -
    
    orderId -
    
    referenceId -
    
    customerId -
    
    employeeId -
    
    refundIds -
    
    buyerEmailAddress -
    
    billingAddress -
    
    shippingAddress -
    
    note -
    
    statementDescriptionIdentifier -
    
    receiptNumber -
    
    receiptUrl -
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. Unique ID for the payment.
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. Timestamp of when the payment was created, in RFC 3339 format.
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. Timestamp of when the payment was last updated, in RFC 3339 format.
  - 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.
  - getTipMoney
```
public Money getTipMoney()
```
    Getter for TipMoney. 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.
  - getTotalMoney
```
public Money getTotalMoney()
```
    Getter for TotalMoney. 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.
  - getAppFeeMoney
```
public Money getAppFeeMoney()
```
    Getter for AppFeeMoney. 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.
  - getProcessingFee
```
public List<ProcessingFee> getProcessingFee()
```
    Getter for ProcessingFee. Processing fees and fee adjustments assessed by Square on this payment.
  - getRefundedMoney
```
public Money getRefundedMoney()
```
    Getter for RefundedMoney. 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.
  - getStatus
```
public String getStatus()
```
    Getter for Status. Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`.
  - getDelayDuration
```
public String getDelayDuration()
```
    Getter for DelayDuration. The duration of time after the payment's creation when Square automatically applies the `delay_action` to the payment. This automatic `delay_action` applies only to payments that don't reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period. This field is specified as a time duration, in RFC 3339 format. Notes: This feature is only supported for card payments. Default: - Card Present payments: "PT36H" (36 hours) from the creation time. - Card Not Present payments: "P7D" (7 days) from the creation time.
  - getDelayAction
```
public String getDelayAction()
```
    Getter for DelayAction. The action to be applied to the payment when the `delay_duration` has elapsed. This field is read only. Current values include: `CANCEL`
  - getDelayedUntil
```
public String getDelayedUntil()
```
    Getter for DelayedUntil. Read only timestamp of when the `delay_action` will automatically be applied, in RFC 3339 format. Note that this field is calculated by summing the payment's `delay_duration` and `created_at` fields. The `created_at` field is generated by Square and may not exactly match the time on your local machine.
  - getSourceType
```
public String getSourceType()
```
    Getter for SourceType. The source type for this payment Current values include: `CARD`.
  - getCardDetails
```
public CardPaymentDetails getCardDetails()
```
    Getter for CardDetails. Reflects the current status of a card payment.
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. ID of the location associated with the payment.
  - getOrderId
```
public String getOrderId()
```
    Getter for OrderId. ID of the order associated with this payment.
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. An optional ID that associates this payment with an entity in another system.
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The [Customer](#type-customer) ID of the customer associated with the payment.
  - getEmployeeId
```
public String getEmployeeId()
```
    Getter for EmployeeId. An optional ID of the employee associated with taking this payment.
  - getRefundIds
```
public List<String> getRefundIds()
```
    Getter for RefundIds. List of `refund_id`s identifying refunds for this payment.
  - getBuyerEmailAddress
```
public String getBuyerEmailAddress()
```
    Getter for BuyerEmailAddress. The buyer's e-mail address
  - getBillingAddress
```
public Address getBillingAddress()
```
    Getter for BillingAddress. Represents a physical address.
  - getShippingAddress
```
public Address getShippingAddress()
```
    Getter for ShippingAddress. Represents a physical address.
  - getNote
```
public String getNote()
```
    Getter for Note. An optional note to include when creating a payment
  - getStatementDescriptionIdentifier
```
public String getStatementDescriptionIdentifier()
```
    Getter for StatementDescriptionIdentifier. Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the `statement_description_identifier` may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment.
  - getReceiptNumber
```
public String getReceiptNumber()
```
    Getter for ReceiptNumber. The payment's receipt number. The field will be missing if a payment is CANCELED
  - getReceiptUrl
```
public String getReceiptUrl()
```
    Getter for ReceiptUrl. The URL for the payment's receipt. The field will only be populated for COMPLETED payments.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toBuilder
```
public Payment.Builder toBuilder()
```
    Builds a new Payment.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Payment.Builder object

Class Payment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Payment

Method Detail

getId

getCreatedAt

getUpdatedAt

getAmountMoney

getTipMoney

getTotalMoney

getAppFeeMoney

getProcessingFee

getRefundedMoney

getStatus

getDelayDuration

getDelayAction

getDelayedUntil

getSourceType

getCardDetails

getLocationId

getOrderId

getReferenceId

getCustomerId

getEmployeeId

getRefundIds

getBuyerEmailAddress

getBillingAddress

getShippingAddress

getNote

getStatementDescriptionIdentifier

getReceiptNumber

getReceiptUrl

hashCode

equals

toBuilder