ChargeRequest (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`ChargeRequest(String idempotencyKey, Money amountMoney, String cardNonce, String customerCardId, Boolean delayCapture, String referenceId, String note, String customerId, Address billingAddress, Address shippingAddress, String buyerEmailAddress, String orderId, List<ChargeRequestAdditionalRecipient> additionalRecipients, String verificationToken)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<ChargeRequestAdditionalRecipient>`	`getAdditionalRecipients()` Getter for AdditionalRecipients.
`Money`	`getAmountMoney()` Getter for AmountMoney.
`Address`	`getBillingAddress()` Getter for BillingAddress.
`String`	`getBuyerEmailAddress()` Getter for BuyerEmailAddress.
`String`	`getCardNonce()` Getter for CardNonce.
`String`	`getCustomerCardId()` Getter for CustomerCardId.
`String`	`getCustomerId()` Getter for CustomerId.
`Boolean`	`getDelayCapture()` Getter for DelayCapture.
`String`	`getIdempotencyKey()` Getter for IdempotencyKey.
`String`	`getNote()` Getter for Note.
`String`	`getOrderId()` Getter for OrderId.
`String`	`getReferenceId()` Getter for ReferenceId.
`Address`	`getShippingAddress()` Getter for ShippingAddress.
`String`	`getVerificationToken()` Getter for VerificationToken.
`int`	`hashCode()`
`ChargeRequest.Builder`	`toBuilder()` Builds a new `ChargeRequest.Builder` object.
`String`	`toString()` Converts this ChargeRequest into string format.

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

- Constructor Detail
  - ChargeRequest
```
public ChargeRequest(String idempotencyKey,
                     Money amountMoney,
                     String cardNonce,
                     String customerCardId,
                     Boolean delayCapture,
                     String referenceId,
                     String note,
                     String customerId,
                     Address billingAddress,
                     Address shippingAddress,
                     String buyerEmailAddress,
                     String orderId,
                     List<ChargeRequestAdditionalRecipient> additionalRecipients,
                     String verificationToken)
```
    Initialization constructor.
    
    Parameters:
    
    idempotencyKey - String value for idempotencyKey.
    
    amountMoney - Money value for amountMoney.
    
    cardNonce - String value for cardNonce.
    
    customerCardId - String value for customerCardId.
    
    delayCapture - Boolean value for delayCapture.
    
    referenceId - String value for referenceId.
    
    note - String value for note.
    
    customerId - String value for customerId.
    
    billingAddress - Address value for billingAddress.
    
    shippingAddress - Address value for shippingAddress.
    
    buyerEmailAddress - String value for buyerEmailAddress.
    
    orderId - String value for orderId.
    
    additionalRecipients - List of ChargeRequestAdditionalRecipient value for additionalRecipients.
    
    verificationToken - String value for verificationToken.
- Method Detail
  - getIdempotencyKey
```
public String getIdempotencyKey()
```
    Getter for IdempotencyKey. A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
    
    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
  - getCardNonce
```
public String getCardNonce()
```
    Getter for CardNonce. A payment token generated from the [Card.tokenize()](https://developer.squareup.com/reference/sdks/web/payments/objects/Card#Card.tokenize) that represents the card to charge. The application that provides a payment token to this endpoint must be the _same application_ that generated the payment token with the Web Payments SDK. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`.
    
    Returns:
    
    Returns the String
  - getCustomerCardId
```
public String getCustomerCardId()
```
    Getter for CustomerCardId. The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`.
    
    Returns:
    
    Returns the String
  - getDelayCapture
```
public Boolean getDelayCapture()
```
    Getter for DelayCapture. If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction]($e/Transactions/CaptureTransaction) endpoint) or a Void (with the [VoidTransaction]($e/Transactions/VoidTransaction) endpoint). Default value: `false`
    
    Returns:
    
    Returns the Boolean
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.
    
    Returns:
    
    Returns the String
  - getNote
```
public String getNote()
```
    Getter for Note. An optional note to associate with the transaction. This value cannot exceed 60 characters.
    
    Returns:
    
    Returns the String
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise.
    
    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
  - getBuyerEmailAddress
```
public String getBuyerEmailAddress()
```
    Getter for BuyerEmailAddress. The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided.
    
    Returns:
    
    Returns the String
  - getOrderId
```
public String getOrderId()
```
    Getter for OrderId. The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field.
    
    Returns:
    
    Returns the String
  - getAdditionalRecipients
```
public List<ChargeRequestAdditionalRecipient> getAdditionalRecipients()
```
    Getter for AdditionalRecipients. The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.
    
    Returns:
    
    Returns the List of ChargeRequestAdditionalRecipient
  - getVerificationToken
```
public String getVerificationToken()
```
    Getter for VerificationToken. A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result.
    
    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 ChargeRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public ChargeRequest.Builder toBuilder()
```
    Builds a new ChargeRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new ChargeRequest.Builder object

Class ChargeRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChargeRequest

Method Detail

getIdempotencyKey

getAmountMoney

getCardNonce

getCustomerCardId

getDelayCapture

getReferenceId

getNote

getCustomerId

getBillingAddress

getShippingAddress

getBuyerEmailAddress

getOrderId

getAdditionalRecipients

getVerificationToken

hashCode

equals

toString

toBuilder