CreatePaymentRequest (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
CreatePaymentRequest(String sourceId, String idempotencyKey, Money amountMoney, Money tipMoney, Money appFeeMoney, String delayDuration, Boolean autocomplete, String orderId, String customerId, String locationId, String teamMemberId, String referenceId, String verificationToken, Boolean acceptPartialAuthorization, String buyerEmailAddress, Address billingAddress, Address shippingAddress, String note, String statementDescriptionIdentifier, CashPaymentDetails cashDetails, ExternalPaymentDetails externalDetails) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getAcceptPartialAuthorization()` Getter for AcceptPartialAuthorization.
`Money`	`getAmountMoney()` Getter for AmountMoney.
`Money`	`getAppFeeMoney()` Getter for AppFeeMoney.
`Boolean`	`getAutocomplete()` Getter for Autocomplete.
`Address`	`getBillingAddress()` Getter for BillingAddress.
`String`	`getBuyerEmailAddress()` Getter for BuyerEmailAddress.
`CashPaymentDetails`	`getCashDetails()` Getter for CashDetails.
`String`	`getCustomerId()` Getter for CustomerId.
`String`	`getDelayDuration()` Getter for DelayDuration.
`ExternalPaymentDetails`	`getExternalDetails()` Getter for ExternalDetails.
`String`	`getIdempotencyKey()` Getter for IdempotencyKey.
`String`	`getLocationId()` Getter for LocationId.
`String`	`getNote()` Getter for Note.
`String`	`getOrderId()` Getter for OrderId.
`String`	`getReferenceId()` Getter for ReferenceId.
`Address`	`getShippingAddress()` Getter for ShippingAddress.
`String`	`getSourceId()` Getter for SourceId.
`String`	`getStatementDescriptionIdentifier()` Getter for StatementDescriptionIdentifier.
`String`	`getTeamMemberId()` Getter for TeamMemberId.
`Money`	`getTipMoney()` Getter for TipMoney.
`String`	`getVerificationToken()` Getter for VerificationToken.
`int`	`hashCode()`
`CreatePaymentRequest.Builder`	`toBuilder()` Builds a new `CreatePaymentRequest.Builder` object.
`String`	`toString()` Converts this CreatePaymentRequest into string format.

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

- Constructor Detail
  - CreatePaymentRequest
```
public CreatePaymentRequest(String sourceId,
                            String idempotencyKey,
                            Money amountMoney,
                            Money tipMoney,
                            Money appFeeMoney,
                            String delayDuration,
                            Boolean autocomplete,
                            String orderId,
                            String customerId,
                            String locationId,
                            String teamMemberId,
                            String referenceId,
                            String verificationToken,
                            Boolean acceptPartialAuthorization,
                            String buyerEmailAddress,
                            Address billingAddress,
                            Address shippingAddress,
                            String note,
                            String statementDescriptionIdentifier,
                            CashPaymentDetails cashDetails,
                            ExternalPaymentDetails externalDetails)
```
    Initialization constructor.
    
    Parameters:
    
    sourceId - String value for sourceId.
    
    idempotencyKey - String value for idempotencyKey.
    
    amountMoney - Money value for amountMoney.
    
    tipMoney - Money value for tipMoney.
    
    appFeeMoney - Money value for appFeeMoney.
    
    delayDuration - String value for delayDuration.
    
    autocomplete - Boolean value for autocomplete.
    
    orderId - String value for orderId.
    
    customerId - String value for customerId.
    
    locationId - String value for locationId.
    
    teamMemberId - String value for teamMemberId.
    
    referenceId - String value for referenceId.
    
    verificationToken - String value for verificationToken.
    
    acceptPartialAuthorization - Boolean value for acceptPartialAuthorization.
    
    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.
    
    cashDetails - CashPaymentDetails value for cashDetails.
    
    externalDetails - ExternalPaymentDetails value for externalDetails.
- Method Detail
  - getSourceId
```
public String getSourceId()
```
    Getter for SourceId. The ID for the source of funds for this payment. This can be a payment token (card nonce) generated by the Square payment form or a card on file made with the Customers API. If recording a payment that the seller received outside of Square, specify either "CASH" or "EXTERNAL". For more information, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
    
    Returns:
    
    Returns the String
  - getIdempotencyKey
```
public String getIdempotencyKey()
```
    Getter for IdempotencyKey. A unique string that identifies this `CreatePayment` request. Keys can be any valid string but must be unique for every `CreatePayment` request. Note: The number of allowed characters might be less than the stated maximum, if multi-byte characters are used. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
    
    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
  - 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
  - getDelayDuration
```
public String getDelayDuration()
```
    Getter for DelayDuration. The duration of time after the payment's creation when Square automatically cancels the payment. This automatic cancellation applies only to payments that do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period. This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value of 1 minute. Note: This feature is only supported for card payments. This parameter can only be set for a delayed capture payment (`autocomplete=false`). 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
  - getAutocomplete
```
public Boolean getAutocomplete()
```
    Getter for Autocomplete. If set to `true`, this payment will be completed when possible. If set to `false`, this payment is held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see [Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment). Default: true
    
    Returns:
    
    Returns the Boolean
  - getOrderId
```
public String getOrderId()
```
    Getter for OrderId. Associates a previously created order with this payment.
    
    Returns:
    
    Returns the String
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The [Customer]($m/Customer) ID of the customer associated with the payment. This is required if the `source_id` refers to a card on file created using the Customers API.
    
    Returns:
    
    Returns the String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The location ID to associate with the payment. If not specified, the default location is used.
    
    Returns:
    
    Returns the String
  - getTeamMemberId
```
public String getTeamMemberId()
```
    Getter for TeamMemberId. An optional [TeamMember]($m/TeamMember) ID to associate with this payment.
    
    Returns:
    
    Returns the String
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system (for example, you might specify an order ID that is generated by a third-party shopping cart).
    
    Returns:
    
    Returns the String
  - getVerificationToken
```
public String getVerificationToken()
```
    Getter for VerificationToken. An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview).
    
    Returns:
    
    Returns the String
  - getAcceptPartialAuthorization
```
public Boolean getAcceptPartialAuthorization()
```
    Getter for AcceptPartialAuthorization. If set to `true` and charging a Square Gift Card, a payment might be returned with `amount_money` equal to less than what was requested. For example, a request for $20 when charging a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card payment. This field cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false
    
    Returns:
    
    Returns the Boolean
  - 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 be entered by the developer when creating a payment.
    
    Returns:
    
    Returns the String
  - getStatementDescriptionIdentifier
```
public String getStatementDescriptionIdentifier()
```
    Getter for StatementDescriptionIdentifier. Optional additional payment information to include on the customer's card statement as part of the statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Note that the `statement_description_identifier` might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the seller taking the payment.
    
    Returns:
    
    Returns the String
  - 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
  - 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
  - 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 CreatePaymentRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public CreatePaymentRequest.Builder toBuilder()
```
    Builds a new CreatePaymentRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new CreatePaymentRequest.Builder object

Class CreatePaymentRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreatePaymentRequest

Method Detail

getSourceId

getIdempotencyKey

getAmountMoney

getTipMoney

getAppFeeMoney

getDelayDuration

getAutocomplete

getOrderId

getCustomerId

getLocationId

getTeamMemberId

getReferenceId

getVerificationToken

getAcceptPartialAuthorization

getBuyerEmailAddress

getBillingAddress

getShippingAddress

getNote

getStatementDescriptionIdentifier

getCashDetails

getExternalDetails

hashCode

equals

toString

toBuilder