com.squareup.sdk.pos

Class ChargeRequest.Builder

java.lang.Object

com.squareup.sdk.pos.ChargeRequest.Builder

Enclosing class:

ChargeRequest

public static final class ChargeRequest.Builder
extends java.lang.Object

A flexible builder to create a ChargeRequest.

Constructor Summary

Constructors

Constructor and Description
Builder(int totalAmount, CurrencyCode currencyCode)

Method Summary

Modifier and Type	Method and Description
ChargeRequest.Builder	autoReturn(long timeout, java.util.concurrent.TimeUnit unit) After a transaction completes, Square Point of Sale automatically returns to your app after the timeout you provide to this method.
ChargeRequest	build() Constructs a ChargeRequest from the current state of this builder.
ChargeRequest.Builder	customerId(java.lang.String customerId) Optional customer id to associate the sale to a specific customer.
ChargeRequest.Builder	enforceBusinessLocation(java.lang.String locationId) Requires a transaction to be processed by a particular location of a merchant's business.
ChargeRequest.Builder	note(java.lang.String note) Specifies a note to associate with a processed transaction.
ChargeRequest.Builder	requestMetadata(java.lang.String requestMetadata) Optional request metadata that Square Point of Sale will return in its response, as ChargeRequest.Success.requestMetadata or Error#requestMetadata.
ChargeRequest.Builder	restrictTendersTo(ChargeRequest.TenderType... tenderTypes)
ChargeRequest.Builder	restrictTendersTo(java.util.Collection<ChargeRequest.TenderType> tenderTypes) Restricts the payment methods the merchant can accept for the transaction.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(int totalAmount,
               CurrencyCode currencyCode)

Parameters:

totalAmount - Amount to charge. Point of Sale might add taxes and / or a tip on top, depending on the user account configuration. Smallest divisible unit of currency for a given locale, scaled by the default number of decimal places for the currency. For example, totalAmount = 100 in USD means $1.00.

currencyCode - CurrencyCode representing ISO-4217 currency codes. Square Point of Sale will ensure that the passed in currency code matches the currency of the user logged in to Point of Sale.

Throws:

java.lang.IllegalArgumentException - if totalAmount is negative.

java.lang.NullPointerException - if currencyCode is null.

Method Detail

restrictTendersTo

public ChargeRequest.Builder restrictTendersTo(java.util.Collection<ChargeRequest.TenderType> tenderTypes)

Restricts the payment methods the merchant can accept for the transaction.

If you don't provide this value, all supported payment methods are allowed.

Parameters:

tenderTypes - The payment methods that the merchant can accept.

Returns:

This builder to allow chaining of builder method calls.

Throws:

java.lang.NullPointerException - if tenderTypes is null

java.lang.IllegalArgumentException - is tenderTypes is empty

restrictTendersTo

public ChargeRequest.Builder restrictTendersTo(ChargeRequest.TenderType... tenderTypes)

See Also:

restrictTendersTo(Collection)

note

public ChargeRequest.Builder note(java.lang.String note)

Specifies a note to associate with a processed transaction.

This note is included in the itemizations field of Payment objects returned by the List Payments and Retrieve Payment endpoints of the Square Connect API. It's also included on all paper tickets and receipts associated with the transaction.

Parameters:

note - The note to associate with the transaction.

Returns:

This builder to allow chaining of builder method calls.

Throws:

java.lang.IllegalArgumentException - if the note is longer than 500 characters.

autoReturn

public ChargeRequest.Builder autoReturn(long timeout,
                                        java.util.concurrent.TimeUnit unit)

After a transaction completes, Square Point of Sale automatically returns to your app after the timeout you provide to this method.

Parameters:

timeout - The timeout to set, in the provided unit, or PosApi.AUTO_RETURN_NO_TIMEOUT. If you specify a timeout, it must be between 3.2 seconds and 10 seconds.

unit - the TimeUnit for the passed in timeout value. May be null if timeout is PosApi.AUTO_RETURN_NO_TIMEOUT

Returns:

This builder to allow chaining of builder method calls.

Throws:

java.lang.IllegalArgumentException - if timeout is not between PosApi.AUTO_RETURN_TIMEOUT_MIN_MILLIS and PosApi.AUTO_RETURN_TIMEOUT_MAX_MILLIS.

enforceBusinessLocation

public ChargeRequest.Builder enforceBusinessLocation(java.lang.String locationId)

Requires a transaction to be processed by a particular location of a merchant's business.

Parameters:

locationId - If provided, this ID must correspond to whichever location is currently logged in to Square Point of Sale. Otherwise, Square Point of Sale will respond with ChargeRequest.ErrorCode.ILLEGAL_LOCATION_ID. If you don't provide this value, the payment will be processed by whichever location is logged in to Square Point of Sale.

Returns:

This builder to allow chaining of builder method calls.

requestMetadata

public ChargeRequest.Builder requestMetadata(java.lang.String requestMetadata)

Optional request metadata that Square Point of Sale will return in its response, as ChargeRequest.Success.requestMetadata or Error#requestMetadata. This metadata is currently not sent to Square servers.

Parameters:

requestMetadata - The request metadata, or null.

Returns:

This builder to allow chaining of builder method calls.

customerId

public ChargeRequest.Builder customerId(java.lang.String customerId)

Optional customer id to associate the sale to a specific customer.

Parameters:

customerId - the customer id, see the online documentation on saving customer information.

Returns:

This builder to allow chaining of builder method calls.

build

public ChargeRequest build()

Constructs a ChargeRequest from the current state of this builder.