V1Payment (Square 30.0.1.20230608 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class V1Payment.Builder
Class to build instances of V1Payment.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	V1Payment(String id, io.apimatic.core.types.OptionalNullable<String> merchantId, String createdAt, io.apimatic.core.types.OptionalNullable<String> creatorId, Device device, io.apimatic.core.types.OptionalNullable<String> paymentUrl, io.apimatic.core.types.OptionalNullable<String> receiptUrl, V1Money inclusiveTaxMoney, V1Money additiveTaxMoney, V1Money taxMoney, V1Money tipMoney, V1Money discountMoney, V1Money totalCollectedMoney, V1Money processingFeeMoney, V1Money netTotalMoney, V1Money refundedMoney, V1Money swedishRoundingMoney, V1Money grossSalesMoney, V1Money netSalesMoney, io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> inclusiveTax, io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> additiveTax, io.apimatic.core.types.OptionalNullable<List<V1Tender>> tender, io.apimatic.core.types.OptionalNullable<List<V1Refund>> refunds, io.apimatic.core.types.OptionalNullable<List<V1PaymentItemization>> itemizations, V1Money surchargeMoney, io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>> surcharges, io.apimatic.core.types.OptionalNullable<Boolean> isPartial) Internal initialization constructor.
	V1Payment(String id, String merchantId, String createdAt, String creatorId, Device device, String paymentUrl, String receiptUrl, V1Money inclusiveTaxMoney, V1Money additiveTaxMoney, V1Money taxMoney, V1Money tipMoney, V1Money discountMoney, V1Money totalCollectedMoney, V1Money processingFeeMoney, V1Money netTotalMoney, V1Money refundedMoney, V1Money swedishRoundingMoney, V1Money grossSalesMoney, V1Money netSalesMoney, List<V1PaymentTax> inclusiveTax, List<V1PaymentTax> additiveTax, List<V1Tender> tender, List<V1Refund> refunds, List<V1PaymentItemization> itemizations, V1Money surchargeMoney, List<V1PaymentSurcharge> surcharges, Boolean isPartial) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<V1PaymentTax>`	`getAdditiveTax()` Getter for AdditiveTax.
`V1Money`	`getAdditiveTaxMoney()` Getter for AdditiveTaxMoney.
`HttpContext`	`getContext()`
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCreatorId()` Getter for CreatorId.
`Device`	`getDevice()` Getter for Device.
`V1Money`	`getDiscountMoney()` Getter for DiscountMoney.
`V1Money`	`getGrossSalesMoney()` Getter for GrossSalesMoney.
`String`	`getId()` Getter for Id.
`List<V1PaymentTax>`	`getInclusiveTax()` Getter for InclusiveTax.
`V1Money`	`getInclusiveTaxMoney()` Getter for InclusiveTaxMoney.
`Boolean`	`getIsPartial()` Getter for IsPartial.
`List<V1PaymentItemization>`	`getItemizations()` Getter for Itemizations.
`String`	`getMerchantId()` Getter for MerchantId.
`V1Money`	`getNetSalesMoney()` Getter for NetSalesMoney.
`V1Money`	`getNetTotalMoney()` Getter for NetTotalMoney.
`String`	`getPaymentUrl()` Getter for PaymentUrl.
`V1Money`	`getProcessingFeeMoney()` Getter for ProcessingFeeMoney.
`String`	`getReceiptUrl()` Getter for ReceiptUrl.
`V1Money`	`getRefundedMoney()` Getter for RefundedMoney.
`List<V1Refund>`	`getRefunds()` Getter for Refunds.
`V1Money`	`getSurchargeMoney()` Getter for SurchargeMoney.
`List<V1PaymentSurcharge>`	`getSurcharges()` Getter for Surcharges.
`V1Money`	`getSwedishRoundingMoney()` Getter for SwedishRoundingMoney.
`V1Money`	`getTaxMoney()` Getter for TaxMoney.
`List<V1Tender>`	`getTender()` Getter for Tender.
`V1Money`	`getTipMoney()` Getter for TipMoney.
`V1Money`	`getTotalCollectedMoney()` Getter for TotalCollectedMoney.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>>`	`internalGetAdditiveTax()` Internal Getter for AdditiveTax.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCreatorId()` Internal Getter for CreatorId.
`protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>>`	`internalGetInclusiveTax()` Internal Getter for InclusiveTax.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetIsPartial()` Internal Getter for IsPartial.
`protected io.apimatic.core.types.OptionalNullable<List<V1PaymentItemization>>`	`internalGetItemizations()` Internal Getter for Itemizations.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetMerchantId()` Internal Getter for MerchantId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPaymentUrl()` Internal Getter for PaymentUrl.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetReceiptUrl()` Internal Getter for ReceiptUrl.
`protected io.apimatic.core.types.OptionalNullable<List<V1Refund>>`	`internalGetRefunds()` Internal Getter for Refunds.
`protected io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>>`	`internalGetSurcharges()` Internal Getter for Surcharges.
`protected io.apimatic.core.types.OptionalNullable<List<V1Tender>>`	`internalGetTender()` Internal Getter for Tender.
`V1Payment.Builder`	`toBuilder()` Builds a new `V1Payment.Builder` object.
`String`	`toString()` Converts this V1Payment into string format.

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

- Constructor Detail
  - V1Payment
```
public V1Payment(String id,
                 String merchantId,
                 String createdAt,
                 String creatorId,
                 Device device,
                 String paymentUrl,
                 String receiptUrl,
                 V1Money inclusiveTaxMoney,
                 V1Money additiveTaxMoney,
                 V1Money taxMoney,
                 V1Money tipMoney,
                 V1Money discountMoney,
                 V1Money totalCollectedMoney,
                 V1Money processingFeeMoney,
                 V1Money netTotalMoney,
                 V1Money refundedMoney,
                 V1Money swedishRoundingMoney,
                 V1Money grossSalesMoney,
                 V1Money netSalesMoney,
                 List<V1PaymentTax> inclusiveTax,
                 List<V1PaymentTax> additiveTax,
                 List<V1Tender> tender,
                 List<V1Refund> refunds,
                 List<V1PaymentItemization> itemizations,
                 V1Money surchargeMoney,
                 List<V1PaymentSurcharge> surcharges,
                 Boolean isPartial)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    merchantId - String value for merchantId.
    
    createdAt - String value for createdAt.
    
    creatorId - String value for creatorId.
    
    device - Device value for device.
    
    paymentUrl - String value for paymentUrl.
    
    receiptUrl - String value for receiptUrl.
    
    inclusiveTaxMoney - V1Money value for inclusiveTaxMoney.
    
    additiveTaxMoney - V1Money value for additiveTaxMoney.
    
    taxMoney - V1Money value for taxMoney.
    
    tipMoney - V1Money value for tipMoney.
    
    discountMoney - V1Money value for discountMoney.
    
    totalCollectedMoney - V1Money value for totalCollectedMoney.
    
    processingFeeMoney - V1Money value for processingFeeMoney.
    
    netTotalMoney - V1Money value for netTotalMoney.
    
    refundedMoney - V1Money value for refundedMoney.
    
    swedishRoundingMoney - V1Money value for swedishRoundingMoney.
    
    grossSalesMoney - V1Money value for grossSalesMoney.
    
    netSalesMoney - V1Money value for netSalesMoney.
    
    inclusiveTax - List of V1PaymentTax value for inclusiveTax.
    
    additiveTax - List of V1PaymentTax value for additiveTax.
    
    tender - List of V1Tender value for tender.
    
    refunds - List of V1Refund value for refunds.
    
    itemizations - List of V1PaymentItemization value for itemizations.
    
    surchargeMoney - V1Money value for surchargeMoney.
    
    surcharges - List of V1PaymentSurcharge value for surcharges.
    
    isPartial - Boolean value for isPartial.
  - V1Payment
```
protected V1Payment(String id,
                    io.apimatic.core.types.OptionalNullable<String> merchantId,
                    String createdAt,
                    io.apimatic.core.types.OptionalNullable<String> creatorId,
                    Device device,
                    io.apimatic.core.types.OptionalNullable<String> paymentUrl,
                    io.apimatic.core.types.OptionalNullable<String> receiptUrl,
                    V1Money inclusiveTaxMoney,
                    V1Money additiveTaxMoney,
                    V1Money taxMoney,
                    V1Money tipMoney,
                    V1Money discountMoney,
                    V1Money totalCollectedMoney,
                    V1Money processingFeeMoney,
                    V1Money netTotalMoney,
                    V1Money refundedMoney,
                    V1Money swedishRoundingMoney,
                    V1Money grossSalesMoney,
                    V1Money netSalesMoney,
                    io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> inclusiveTax,
                    io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> additiveTax,
                    io.apimatic.core.types.OptionalNullable<List<V1Tender>> tender,
                    io.apimatic.core.types.OptionalNullable<List<V1Refund>> refunds,
                    io.apimatic.core.types.OptionalNullable<List<V1PaymentItemization>> itemizations,
                    V1Money surchargeMoney,
                    io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>> surcharges,
                    io.apimatic.core.types.OptionalNullable<Boolean> isPartial)
```
    Internal initialization constructor.
- Method Detail
  - getContext
```
public HttpContext getContext()
```
  - getId
```
public String getId()
```
    Getter for Id. The payment's unique identifier.
    
    Returns:
    
    Returns the String
  - internalGetMerchantId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetMerchantId()
```
    Internal Getter for MerchantId. The unique identifier of the merchant that took the payment.
    
    Returns:
    
    Returns the Internal String
  - getMerchantId
```
public String getMerchantId()
```
    Getter for MerchantId. The unique identifier of the merchant that took the payment.
    
    Returns:
    
    Returns the String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The time when the payment was created, in ISO 8601 format. Reflects the time of the first payment if the object represents an incomplete partial payment, and the time of the last or complete payment otherwise.
    
    Returns:
    
    Returns the String
  - internalGetCreatorId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCreatorId()
```
    Internal Getter for CreatorId. The unique identifier of the Square account that took the payment.
    
    Returns:
    
    Returns the Internal String
  - getCreatorId
```
public String getCreatorId()
```
    Getter for CreatorId. The unique identifier of the Square account that took the payment.
    
    Returns:
    
    Returns the String
  - getDevice
```
public Device getDevice()
```
    Getter for Device.
    
    Returns:
    
    Returns the Device
  - internalGetPaymentUrl
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPaymentUrl()
```
    Internal Getter for PaymentUrl. The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page.
    
    Returns:
    
    Returns the Internal String
  - getPaymentUrl
```
public String getPaymentUrl()
```
    Getter for PaymentUrl. The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page.
    
    Returns:
    
    Returns the String
  - internalGetReceiptUrl
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetReceiptUrl()
```
    Internal Getter for ReceiptUrl. The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment.
    
    Returns:
    
    Returns the Internal String
  - getReceiptUrl
```
public String getReceiptUrl()
```
    Getter for ReceiptUrl. The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment.
    
    Returns:
    
    Returns the String
  - getInclusiveTaxMoney
```
public V1Money getInclusiveTaxMoney()
```
    Getter for InclusiveTaxMoney.
    
    Returns:
    
    Returns the V1Money
  - getAdditiveTaxMoney
```
public V1Money getAdditiveTaxMoney()
```
    Getter for AdditiveTaxMoney.
    
    Returns:
    
    Returns the V1Money
  - getTaxMoney
```
public V1Money getTaxMoney()
```
    Getter for TaxMoney.
    
    Returns:
    
    Returns the V1Money
  - getTipMoney
```
public V1Money getTipMoney()
```
    Getter for TipMoney.
    
    Returns:
    
    Returns the V1Money
  - getDiscountMoney
```
public V1Money getDiscountMoney()
```
    Getter for DiscountMoney.
    
    Returns:
    
    Returns the V1Money
  - getTotalCollectedMoney
```
public V1Money getTotalCollectedMoney()
```
    Getter for TotalCollectedMoney.
    
    Returns:
    
    Returns the V1Money
  - getProcessingFeeMoney
```
public V1Money getProcessingFeeMoney()
```
    Getter for ProcessingFeeMoney.
    
    Returns:
    
    Returns the V1Money
  - getNetTotalMoney
```
public V1Money getNetTotalMoney()
```
    Getter for NetTotalMoney.
    
    Returns:
    
    Returns the V1Money
  - getRefundedMoney
```
public V1Money getRefundedMoney()
```
    Getter for RefundedMoney.
    
    Returns:
    
    Returns the V1Money
  - getSwedishRoundingMoney
```
public V1Money getSwedishRoundingMoney()
```
    Getter for SwedishRoundingMoney.
    
    Returns:
    
    Returns the V1Money
  - getGrossSalesMoney
```
public V1Money getGrossSalesMoney()
```
    Getter for GrossSalesMoney.
    
    Returns:
    
    Returns the V1Money
  - getNetSalesMoney
```
public V1Money getNetSalesMoney()
```
    Getter for NetSalesMoney.
    
    Returns:
    
    Returns the V1Money
  - internalGetInclusiveTax
```
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> internalGetInclusiveTax()
```
    Internal Getter for InclusiveTax. All of the inclusive taxes associated with the payment.
    
    Returns:
    
    Returns the Internal List of V1PaymentTax
  - getInclusiveTax
```
public List<V1PaymentTax> getInclusiveTax()
```
    Getter for InclusiveTax. All of the inclusive taxes associated with the payment.
    
    Returns:
    
    Returns the List of V1PaymentTax
  - internalGetAdditiveTax
```
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentTax>> internalGetAdditiveTax()
```
    Internal Getter for AdditiveTax. All of the additive taxes associated with the payment.
    
    Returns:
    
    Returns the Internal List of V1PaymentTax
  - getAdditiveTax
```
public List<V1PaymentTax> getAdditiveTax()
```
    Getter for AdditiveTax. All of the additive taxes associated with the payment.
    
    Returns:
    
    Returns the List of V1PaymentTax
  - internalGetTender
```
protected io.apimatic.core.types.OptionalNullable<List<V1Tender>> internalGetTender()
```
    Internal Getter for Tender. All of the tenders associated with the payment.
    
    Returns:
    
    Returns the Internal List of V1Tender
  - getTender
```
public List<V1Tender> getTender()
```
    Getter for Tender. All of the tenders associated with the payment.
    
    Returns:
    
    Returns the List of V1Tender
  - internalGetRefunds
```
protected io.apimatic.core.types.OptionalNullable<List<V1Refund>> internalGetRefunds()
```
    Internal Getter for Refunds. All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange.
    
    Returns:
    
    Returns the Internal List of V1Refund
  - getRefunds
```
public List<V1Refund> getRefunds()
```
    Getter for Refunds. All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange.
    
    Returns:
    
    Returns the List of V1Refund
  - internalGetItemizations
```
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentItemization>> internalGetItemizations()
```
    Internal Getter for Itemizations. The items purchased in the payment.
    
    Returns:
    
    Returns the Internal List of V1PaymentItemization
  - getItemizations
```
public List<V1PaymentItemization> getItemizations()
```
    Getter for Itemizations. The items purchased in the payment.
    
    Returns:
    
    Returns the List of V1PaymentItemization
  - getSurchargeMoney
```
public V1Money getSurchargeMoney()
```
    Getter for SurchargeMoney.
    
    Returns:
    
    Returns the V1Money
  - internalGetSurcharges
```
protected io.apimatic.core.types.OptionalNullable<List<V1PaymentSurcharge>> internalGetSurcharges()
```
    Internal Getter for Surcharges. A list of all surcharges associated with the payment.
    
    Returns:
    
    Returns the Internal List of V1PaymentSurcharge
  - getSurcharges
```
public List<V1PaymentSurcharge> getSurcharges()
```
    Getter for Surcharges. A list of all surcharges associated with the payment.
    
    Returns:
    
    Returns the List of V1PaymentSurcharge
  - internalGetIsPartial
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetIsPartial()
```
    Internal Getter for IsPartial. Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.
    
    Returns:
    
    Returns the Internal Boolean
  - getIsPartial
```
public Boolean getIsPartial()
```
    Getter for IsPartial. Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.
    
    Returns:
    
    Returns the Boolean
  - 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 V1Payment into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public V1Payment.Builder toBuilder()
```
    Builds a new V1Payment.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new V1Payment.Builder object

Class V1Payment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

V1Payment

V1Payment

Method Detail

getContext

getId

internalGetMerchantId

getMerchantId

getCreatedAt

internalGetCreatorId

getCreatorId

getDevice

internalGetPaymentUrl

getPaymentUrl

internalGetReceiptUrl

getReceiptUrl

getInclusiveTaxMoney

getAdditiveTaxMoney

getTaxMoney

getTipMoney

getDiscountMoney

getTotalCollectedMoney

getProcessingFeeMoney

getNetTotalMoney

getRefundedMoney

getSwedishRoundingMoney

getGrossSalesMoney

getNetSalesMoney

internalGetInclusiveTax

getInclusiveTax

internalGetAdditiveTax

getAdditiveTax

internalGetTender

getTender

internalGetRefunds

getRefunds

internalGetItemizations

getItemizations

getSurchargeMoney

internalGetSurcharges

getSurcharges

internalGetIsPartial

getIsPartial

hashCode

equals

toString

toBuilder