com.squareup.sdk.pos

Class ChargeRequest

java.lang.Object

com.squareup.sdk.pos.ChargeRequest

public final class ChargeRequest
extends java.lang.Object

Represents the details of a transaction to initiate with the Point of Sale API. After building a ChargeRequest instance with Builder#Builder(int, CurrencyCode), pass it to the PosClient.createChargeIntent(ChargeRequest) method to initiate the transaction.

See Also:

code sample

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChargeRequest.Builder A flexible builder to create a ChargeRequest.
static class	ChargeRequest.Error Contains values returned by Square Point of Sale after failing to process a transaction.
static class	ChargeRequest.ErrorCode
static class	ChargeRequest.Success Contains values returned by Square Point of Sale after a successfully processed transaction.
static class	ChargeRequest.TenderType Possible forms of payment that a merchant can accept for a Point of Sale API transaction.

Field Summary

Fields

Modifier and Type	Field and Description
long	autoReturnMillis
CurrencyCode	currencyCode
java.lang.String	customerId
java.lang.String	locationId
java.lang.String	note
java.lang.String	requestMetadata
java.util.Set<ChargeRequest.TenderType>	tenderTypes
int	totalAmount

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
ChargeRequest.Builder	newBuilder() Creates a new ChargeRequest.Builder copied from this transaction.
ChargeRequest.Builder	newBuilder(int totalAmount, CurrencyCode currencyCode) Creates a new ChargeRequest.Builder copied from this transaction, with a different amount.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

totalAmount

public final int totalAmount

See Also:

Builder#Builder(int, CurrencyCode)

currencyCode

public final CurrencyCode currencyCode

See Also:

Builder#Builder(int, CurrencyCode)

tenderTypes

public final java.util.Set<ChargeRequest.TenderType> tenderTypes

See Also:

ChargeRequest.Builder.restrictTendersTo(Collection)

note

public final java.lang.String note

See Also:

ChargeRequest.Builder.note(String)

autoReturnMillis

public final long autoReturnMillis

See Also:

ChargeRequest.Builder.autoReturn(long, TimeUnit)

locationId

public final java.lang.String locationId

See Also:

ChargeRequest.Builder.enforceBusinessLocation(String)

requestMetadata

public final java.lang.String requestMetadata

See Also:

ChargeRequest.Builder.requestMetadata

customerId

public final java.lang.String customerId

See Also:

ChargeRequest.Builder.customerId(String)

Method Detail

newBuilder

public ChargeRequest.Builder newBuilder()

Creates a new ChargeRequest.Builder copied from this transaction.

newBuilder

public ChargeRequest.Builder newBuilder(int totalAmount,
                                        CurrencyCode currencyCode)

Creates a new ChargeRequest.Builder copied from this transaction, with a different amount.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object