Payment (Square 20.0.0.20220512 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, Money approvedMoney, List<ProcessingFee> processingFee, Money refundedMoney, String status, String delayDuration, String delayAction, String delayedUntil, String sourceType, CardPaymentDetails cardDetails, CashPaymentDetails cashDetails, BankAccountPaymentDetails bankAccountDetails, ExternalPaymentDetails externalDetails, DigitalWalletDetails walletDetails, BuyNowPayLaterDetails buyNowPayLaterDetails, String locationId, String orderId, String referenceId, String customerId, String employeeId, String teamMemberId, List<String> refundIds, RiskEvaluation riskEvaluation, String buyerEmailAddress, Address billingAddress, Address shippingAddress, String note, String statementDescriptionIdentifier, List<String> capabilities, String receiptNumber, String receiptUrl, DeviceDetails deviceDetails, ApplicationDetails applicationDetails, String versionToken) 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.
`ApplicationDetails`	`getApplicationDetails()` Getter for ApplicationDetails.
`Money`	`getApprovedMoney()` Getter for ApprovedMoney.
`BankAccountPaymentDetails`	`getBankAccountDetails()` Getter for BankAccountDetails.
`Address`	`getBillingAddress()` Getter for BillingAddress.
`String`	`getBuyerEmailAddress()` Getter for BuyerEmailAddress.
`BuyNowPayLaterDetails`	`getBuyNowPayLaterDetails()` Getter for BuyNowPayLaterDetails.
`List<String>`	`getCapabilities()` Getter for Capabilities.
`CardPaymentDetails`	`getCardDetails()` Getter for CardDetails.
`CashPaymentDetails`	`getCashDetails()` Getter for CashDetails.
`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.
`DeviceDetails`	`getDeviceDetails()` Getter for DeviceDetails.
`String`	`getEmployeeId()` Getter for EmployeeId.
`ExternalPaymentDetails`	`getExternalDetails()` Getter for ExternalDetails.
`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.
`RiskEvaluation`	`getRiskEvaluation()` Getter for RiskEvaluation.
`Address`	`getShippingAddress()` Getter for ShippingAddress.
`String`	`getSourceType()` Getter for SourceType.
`String`	`getStatementDescriptionIdentifier()` Getter for StatementDescriptionIdentifier.
`String`	`getStatus()` Getter for Status.
`String`	`getTeamMemberId()` Getter for TeamMemberId.
`Money`	`getTipMoney()` Getter for TipMoney.
`Money`	`getTotalMoney()` Getter for TotalMoney.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`String`	`getVersionToken()` Getter for VersionToken.
`DigitalWalletDetails`	`getWalletDetails()` Getter for WalletDetails.
`int`	`hashCode()`
`Payment.Builder`	`toBuilder()` Builds a new `Payment.Builder` object.
`String`	`toString()` Converts this Payment into string format.

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

- Constructor Detail
  - Payment
```
public Payment(String id,
               String createdAt,
               String updatedAt,
               Money amountMoney,
               Money tipMoney,
               Money totalMoney,
               Money appFeeMoney,
               Money approvedMoney,
               List<ProcessingFee> processingFee,
               Money refundedMoney,
               String status,
               String delayDuration,
               String delayAction,
               String delayedUntil,
               String sourceType,
               CardPaymentDetails cardDetails,
               CashPaymentDetails cashDetails,
               BankAccountPaymentDetails bankAccountDetails,
               ExternalPaymentDetails externalDetails,
               DigitalWalletDetails walletDetails,
               BuyNowPayLaterDetails buyNowPayLaterDetails,
               String locationId,
               String orderId,
               String referenceId,
               String customerId,
               String employeeId,
               String teamMemberId,
               List<String> refundIds,
               RiskEvaluation riskEvaluation,
               String buyerEmailAddress,
               Address billingAddress,
               Address shippingAddress,
               String note,
               String statementDescriptionIdentifier,
               List<String> capabilities,
               String receiptNumber,
               String receiptUrl,
               DeviceDetails deviceDetails,
               ApplicationDetails applicationDetails,
               String versionToken)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    amountMoney - Money value for amountMoney.
    
    tipMoney - Money value for tipMoney.
    
    totalMoney - Money value for totalMoney.
    
    appFeeMoney - Money value for appFeeMoney.
    
    approvedMoney - Money value for approvedMoney.
    
    processingFee - List of ProcessingFee value for processingFee.
    
    refundedMoney - Money value for refundedMoney.
    
    status - String value for status.
    
    delayDuration - String value for delayDuration.
    
    delayAction - String value for delayAction.
    
    delayedUntil - String value for delayedUntil.
    
    sourceType - String value for sourceType.
    
    cardDetails - CardPaymentDetails value for cardDetails.
    
    cashDetails - CashPaymentDetails value for cashDetails.
    
    bankAccountDetails - BankAccountPaymentDetails value for bankAccountDetails.
    
    externalDetails - ExternalPaymentDetails value for externalDetails.
    
    walletDetails - DigitalWalletDetails value for walletDetails.
    
    buyNowPayLaterDetails - BuyNowPayLaterDetails value for buyNowPayLaterDetails.
    
    locationId - String value for locationId.
    
    orderId - String value for orderId.
    
    referenceId - String value for referenceId.
    
    customerId - String value for customerId.
    
    employeeId - String value for employeeId.
    
    teamMemberId - String value for teamMemberId.
    
    refundIds - List of String value for refundIds.
    
    riskEvaluation - RiskEvaluation value for riskEvaluation.
    
    buyerEmailAddress - String value for buyerEmailAddress.
    
    billingAddress - Address value for billingAddress.
    
    shippingAddress - Address value for shippingAddress.
    
    note - String value for note.
    
    statementDescriptionIdentifier - String value for statementDescriptionIdentifier.
    
    capabilities - List of String value for capabilities.
    
    receiptNumber - String value for receiptNumber.
    
    receiptUrl - String value for receiptUrl.
    
    deviceDetails - DeviceDetails value for deviceDetails.
    
    applicationDetails - ApplicationDetails value for applicationDetails.
    
    versionToken - String value for versionToken.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. A unique ID for the payment.
    
    Returns:
    
    Returns the String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The timestamp of when the payment was created, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The timestamp of when the payment 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
  - 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.
    
    Returns:
    
    Returns the Money
  - 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.
    
    Returns:
    
    Returns the Money
  - 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.
    
    Returns:
    
    Returns the Money
  - getApprovedMoney
```
public Money getApprovedMoney()
```
    Getter for ApprovedMoney. 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
  - getProcessingFee
```
public List<ProcessingFee> getProcessingFee()
```
    Getter for ProcessingFee. The processing fees and fee adjustments assessed by Square for this payment.
    
    Returns:
    
    Returns the List of ProcessingFee
  - 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.
    
    Returns:
    
    Returns the Money
  - getStatus
```
public String getStatus()
```
    Getter for Status. Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.
    
    Returns:
    
    Returns the String
  - 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 do not 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.
    
    Returns:
    
    Returns the String
  - 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`.
    
    Returns:
    
    Returns the String
  - getDelayedUntil
```
public String getDelayedUntil()
```
    Getter for DelayedUntil. The read-only timestamp of when the `delay_action` is automatically 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 might not exactly match the time on your local machine.
    
    Returns:
    
    Returns the String
  - getSourceType
```
public String getSourceType()
```
    Getter for SourceType. The source type for this payment. Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`, or `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
    
    Returns:
    
    Returns the String
  - getCardDetails
```
public CardPaymentDetails getCardDetails()
```
    Getter for CardDetails. Reflects the current status of a card payment. Contains only non-confidential information.
    
    Returns:
    
    Returns the CardPaymentDetails
  - getCashDetails
```
public CashPaymentDetails getCashDetails()
```
    Getter for CashDetails. Stores details about a cash payment. Contains only non-confidential information. For more information, see [Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments).
    
    Returns:
    
    Returns the CashPaymentDetails
  - getBankAccountDetails
```
public BankAccountPaymentDetails getBankAccountDetails()
```
    Getter for BankAccountDetails. Additional details about BANK_ACCOUNT type payments.
    
    Returns:
    
    Returns the BankAccountPaymentDetails
  - getExternalDetails
```
public ExternalPaymentDetails getExternalDetails()
```
    Getter for ExternalDetails. Stores details about an external payment. Contains only non-confidential information. For more information, see [Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments).
    
    Returns:
    
    Returns the ExternalPaymentDetails
  - getWalletDetails
```
public DigitalWalletDetails getWalletDetails()
```
    Getter for WalletDetails. Additional details about `WALLET` type payments. Contains only non-confidential information.
    
    Returns:
    
    Returns the DigitalWalletDetails
  - getBuyNowPayLaterDetails
```
public BuyNowPayLaterDetails getBuyNowPayLaterDetails()
```
    Getter for BuyNowPayLaterDetails. Additional details about a Buy Now Pay Later payment type.
    
    Returns:
    
    Returns the BuyNowPayLaterDetails
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The ID of the location associated with the payment.
    
    Returns:
    
    Returns the String
  - getOrderId
```
public String getOrderId()
```
    Getter for OrderId. The ID of the order associated with the payment.
    
    Returns:
    
    Returns the String
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. An optional ID that associates the payment with an entity in another system.
    
    Returns:
    
    Returns the String
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The [Customer]($m/Customer) ID of the customer associated with the payment.
    
    Returns:
    
    Returns the String
  - getEmployeeId
```
public String getEmployeeId()
```
    Getter for EmployeeId. __Deprecated__: Use `Payment.team_member_id` instead. An optional ID of the employee associated with taking the payment.
    
    Returns:
    
    Returns the String
  - getTeamMemberId
```
public String getTeamMemberId()
```
    Getter for TeamMemberId. An optional ID of the [TeamMember]($m/TeamMember) associated with taking the payment.
    
    Returns:
    
    Returns the String
  - getRefundIds
```
public List<String> getRefundIds()
```
    Getter for RefundIds. A list of `refund_id`s identifying refunds for the payment.
    
    Returns:
    
    Returns the List of String
  - getRiskEvaluation
```
public RiskEvaluation getRiskEvaluation()
```
    Getter for RiskEvaluation. Represents fraud risk information for the associated payment. When you take a payment through Square's Payments API (using the `CreatePayment` endpoint), Square evaluates it and assigns a risk level to the payment. Sellers can use this information to determine the course of action (for example, provide the goods/services or refund the payment).
    
    Returns:
    
    Returns the RiskEvaluation
  - getBuyerEmailAddress
```
public String getBuyerEmailAddress()
```
    Getter for BuyerEmailAddress. The buyer's email address.
    
    Returns:
    
    Returns the String
  - getBillingAddress
```
public Address getBillingAddress()
```
    Getter for BillingAddress. 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
  - 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
  - getNote
```
public String getNote()
```
    Getter for Note. An optional note to include when creating a payment.
    
    Returns:
    
    Returns the String
  - getStatementDescriptionIdentifier
```
public String getStatementDescriptionIdentifier()
```
    Getter for StatementDescriptionIdentifier. Additional payment information that gets added to the customer's card statement as part of the statement description. Note that the `statement_description_identifier` might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and the name of the seller taking the payment.
    
    Returns:
    
    Returns the String
  - getCapabilities
```
public List<String> getCapabilities()
```
    Getter for Capabilities. Actions that can be performed on this payment: - `EDIT_AMOUNT_UP` - The payment amount can be edited up. - `EDIT_AMOUNT_DOWN` - The payment amount can be edited down. - `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up. - `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down.
    
    Returns:
    
    Returns the List of String
  - getReceiptNumber
```
public String getReceiptNumber()
```
    Getter for ReceiptNumber. The payment's receipt number. The field is missing if a payment is canceled.
    
    Returns:
    
    Returns the String
  - getReceiptUrl
```
public String getReceiptUrl()
```
    Getter for ReceiptUrl. The URL for the payment's receipt. The field is only populated for COMPLETED payments.
    
    Returns:
    
    Returns the String
  - getDeviceDetails
```
public DeviceDetails getDeviceDetails()
```
    Getter for DeviceDetails. Details about the device that took the payment.
    
    Returns:
    
    Returns the DeviceDetails
  - getApplicationDetails
```
public ApplicationDetails getApplicationDetails()
```
    Getter for ApplicationDetails. Details about the application that took the payment.
    
    Returns:
    
    Returns the ApplicationDetails
  - getVersionToken
```
public String getVersionToken()
```
    Getter for VersionToken. Used for optimistic concurrency. This opaque token identifies a specific version of the `Payment` object.
    
    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 Payment into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - 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

getApprovedMoney

getProcessingFee

getRefundedMoney

getStatus

getDelayDuration

getDelayAction

getDelayedUntil

getSourceType

getCardDetails

getCashDetails

getBankAccountDetails

getExternalDetails

getWalletDetails

getBuyNowPayLaterDetails

getLocationId

getOrderId

getReferenceId

getCustomerId

getEmployeeId

getTeamMemberId

getRefundIds

getRiskEvaluation

getBuyerEmailAddress

getBillingAddress

getShippingAddress

getNote

getStatementDescriptionIdentifier

getCapabilities

getReceiptNumber

getReceiptUrl

getDeviceDetails

getApplicationDetails

getVersionToken

hashCode

equals

toString

toBuilder