Index

A B C D E F G H I K L M O P R S T V

A

addressLines(addressLines) - Method in class sqip.Contact.Builder

B

Brand() - Constructor for enum sqip.Card.Brand: The card brand (for example, Visa).
build(given_name) - Method in class sqip.Contact.Builder
Builder() - Constructor for class sqip.Contact.Builder
BuyerAction - Class in sqip: Indicates the action that will be performed onto the card payment source id after retrieving the verification token.
BuyerAction.Charge - Class in sqip: Action that will charge the card payment source id with Money.amount in the specified Money.currencyCode
BuyerAction.Store - Class in sqip: Action that will store the card paymentSourceId.
BuyerVerification - Class in sqip: Lets the application retrieve a verification token for a payment source ID.
BuyerVerificationResult - Class in sqip: Represents the result of a BuyerVerification.verify operation. The result will be an instance of class BuyerVerificationResult.Success if the operation is successful or class BuyerVerificationResult.Error if the operation failed.
BuyerVerificationResult.Error - Class in sqip: Represents the result of an unsuccessful BuyerVerification.verify operation.
BuyerVerificationResult.Success - Class in sqip: Represents the result of a successful BuyerVerificationResult.verify operation. Contains a value indicating whether the user was challenged and the verification token.
BuyerVerifiedDetails - Interface in sqip: Represents the result of a successful operation to verify a payment token

C

Call<T> - Interface in sqip: An invocation of an SDK call that sends a request to Square servers and returns a response. Each call yields its own request and response. Use Call.clone to make multiple calls with the same parameters to the same web server; this may be used to retry a failed call.
Callback<R> - Interface in sqip: Communicates the result of an asynchronous operation. Callback.onResult is invoked exactly once per operation.
cancel() - Method in interface sqip.Call: Cancels this call. An attempt will be made to cancel in-flight calls, and if the call has not yet been executed it never will be.
Card - Class in sqip: Represents a payment card.
Card(brand, lastFourDigits, expirationMonth, expirationYear, postalCode, type, prepaidType) - Constructor for class sqip.Card: Represents a payment card.
Card.Brand - Enum in sqip: The card brand (for example, Visa).
Card.PrepaidType - Enum in sqip
Card.Type - Enum in sqip
CardDetails - Interface in sqip: Represents the result of a successful operation to process card payment information.
CardEntry - Class in sqip: Lets the application collect card information from the customer.
CardEntryActivityCommand - Class in sqip: Commands that determine the behavior of the Square card entry activity after the completion of a interface CardNonceBackgroundHandler.
CardEntryActivityCommand.Finish - Class in sqip: Finish the card entry activity with class CardEntryActivityResult.Success.
CardEntryActivityCommand.ShowError - Class in sqip: Display message in an error dialog to the customer, and allow the customer to edit their card information and re-submit.
CardEntryActivityResult - Class in sqip: Represents the result of a card entry activity. The result will be an instance of class CardEntryActivityResult.Success if the request is successful, or class CardEntryActivityResult.Canceled if the customer cancels the request.
CardEntryActivityResult.Canceled - Class in sqip: The result when the customer cancels the Square card entry activity before a card is successfully entered.
CardEntryActivityResult.Success - Class in sqip: Represents the result of a successful operation to process card payment information. Contains the card nonce and additional class Card details.
CardNonceBackgroundHandler - Interface in sqip: A callback invoked on a background thread after the customer successfully enters their card information and before the card entry activity finishes. This lets the application perform additional work using the card information, such as as charging the card.
Charge(money) - Constructor for class sqip.BuyerAction.Charge: Action that will charge the card payment source id with Money.amount in the specified Money.currencyCode
city(city) - Method in class sqip.Contact.Builder
clone() - Method in interface sqip.Call: Creates a new, identical call to this one which can be enqueued or executed even if this call has already been executed.
Code() - Constructor for enum sqip.Error.Code: Possible error codes that can be returned as a result of attempting to verify a card nonce.
Code() - Constructor for enum sqip.Error.Code: Possible error codes that can be returned as a result of attempting to create a Google Pay card nonce.
component1() - Method in class sqip.BuyerAction.Charge
component1() - Method in class sqip.BuyerVerificationResult.Error: The error code.
component1() - Method in class sqip.BuyerVerificationResult.Success: true if the buyer was challenged for additional authentication factors.
component1() - Method in class sqip.Card: The card brand
component1() - Method in class sqip.CardEntryActivityCommand.ShowError
component1() - Method in class sqip.CardEntryActivityResult.Success: A one-time-use payment token that is used with the Transactions API
component1() - Method in class sqip.GooglePayNonceResult.Error: The error code.
component1() - Method in class sqip.GooglePayNonceResult.Success: A one-time-use payment token that is used with the Transactions API
component1() - Method in class sqip.Money: Amount of money that will be charged
component1() - Method in class sqip.SquareIdentifier.LocationToken
component2() - Method in class sqip.BuyerVerificationResult.Error: A displayable message that summarizes the possible cause of the error.
component2() - Method in class sqip.BuyerVerificationResult.Success: The token representing a verified buyer.
component2() - Method in class sqip.Card: The last 4 digits of the card number.
component2() - Method in class sqip.CardEntryActivityResult.Success: The payment card.
component2() - Method in class sqip.GooglePayNonceResult.Error: A displayable message that summarizes the possible cause of the error.
component2() - Method in class sqip.GooglePayNonceResult.Success: The payment card.
component2() - Method in class sqip.Money: The currency type the paymentSourceId will be charged in.
component3() - Method in class sqip.BuyerVerificationResult.Error: A more detailed error code for troubleshooting.
component3() - Method in class sqip.Card: The expiration month of the card.
component3() - Method in class sqip.GooglePayNonceResult.Error: A more detailed error code for troubleshooting.
component4() - Method in class sqip.BuyerVerificationResult.Error: A human-readable message containing additional debug
component4() - Method in class sqip.Card: The 4-digit expiration year of the card.
component4() - Method in class sqip.GooglePayNonceResult.Error: A human-readable message containing additional debug
component5() - Method in class sqip.Card: The billing postal code associated with the card,
component6() - Method in class sqip.Card: The card’s type.
component7() - Method in class sqip.Card: Indicates whether or not this is a prepaid card.
Contact - Class in sqip: This represents the required given name field and optional fields that can be passed in as part of the verification process. The more fields you supply, the greater the chance the verification will be successful.
Contact.Builder - Class in sqip
copy(money) - Method in class sqip.BuyerAction.Charge: Action that will charge the card payment source id with Money.amount in the specified Money.currencyCode
copy(code, message, debugCode, debugMessage) - Method in class sqip.BuyerVerificationResult.Error: Represents the result of an unsuccessful BuyerVerification.verify operation.
copy(hasChallengedUser, verificationToken) - Method in class sqip.BuyerVerificationResult.Success: Represents the result of a successful BuyerVerificationResult.verify operation. Contains a value indicating whether the user was challenged and the verification token.
copy(brand, lastFourDigits, expirationMonth, expirationYear, postalCode, type, prepaidType) - Method in class sqip.Card: Represents a payment card.
copy(message) - Method in class sqip.CardEntryActivityCommand.ShowError: Display message in an error dialog to the customer, and allow the customer to edit their card information and re-submit.
copy(nonce, card) - Method in class sqip.CardEntryActivityResult.Success: Represents the result of a successful operation to process card payment information. Contains the card nonce and additional class Card details.
copy(code, message, debugCode, debugMessage) - Method in class sqip.GooglePayNonceResult.Error: Represents the result of an unsuccessful GooglePay.requestGooglePayNonce operation.
copy(nonce, card) - Method in class sqip.GooglePayNonceResult.Success: Represents the result of a successful GooglePay.requestGooglePayNonce operation. Contains the card nonce and additional class Card details.
copy(amount, currencyCode) - Method in class sqip.Money: Amount to charge the card payment source ID in the specified currencyCode
copy(tokenId) - Method in class sqip.SquareIdentifier.LocationToken
Country - Enum in sqip: Indicates the country associated with an entity, such as a business. Values are in ISO 3166-1-alpha-2 format.
Country(code) - Constructor for enum sqip.Country: Indicates the country associated with an entity, such as a business. Values are in ISO 3166-1-alpha-2 format.
countryCode(countryCode) - Method in class sqip.Contact.Builder
createIsReadyToPayRequest() - Method in class sqip.GooglePay: Creates an IsReadyToPayRequest instance with Square-supported card networks and payment methods configured.
createPaymentDataRequest(squareLocationId, transactionInfo) - Method in class sqip.GooglePay: Creates a PaymentDataRequest instance configured for the Square payment gateway.
Currency - Enum in sqip: Indicates the associated currency for a money amount . Values correspond to ISO 4217.
Currency(code) - Constructor for enum sqip.Currency: Indicates the associated currency for a money amount . Values correspond to ISO 4217.

D

DEFAULT_BUYER_VERIFICATION_REQUEST_CODE - Static variable in class sqip.BuyerVerification
DEFAULT_CARD_ENTRY_REQUEST_CODE - Static variable in class sqip.CardEntry

E

email(email) - Method in class sqip.Contact.Builder
enqueue(callback) - Method in interface sqip.Call: Asynchronously sends the request and notifies callback of the result.
enqueue($receiver, callback) - Static method in class sqip.KotlinExtensions: Asynchronously send the request and notify callback of the result.
equals(p) - Method in class sqip.BuyerAction.Charge
equals(other) - Method in class sqip.BuyerAction.Store
equals(p) - Method in class sqip.BuyerVerificationResult.Error
equals(p) - Method in class sqip.BuyerVerificationResult.Success
equals(p) - Method in class sqip.Card
equals(p) - Method in class sqip.CardEntryActivityCommand.ShowError
equals(p) - Method in class sqip.CardEntryActivityResult.Success
equals(p) - Method in class sqip.GooglePayNonceResult.Error
equals(p) - Method in class sqip.GooglePayNonceResult.Success
equals(p) - Method in class sqip.Money
equals(p) - Method in class sqip.SquareIdentifier.LocationToken
Error(code, message, debugCode, debugMessage) - Constructor for class sqip.BuyerVerificationResult.Error: Represents the result of an unsuccessful BuyerVerification.verify operation.
Error(code, message, debugCode, debugMessage) - Constructor for class sqip.GooglePayNonceResult.Error: Represents the result of an unsuccessful GooglePay.requestGooglePayNonce operation.
Error.Code - Enum in sqip: Possible error codes that can be returned as a result of attempting to verify a card nonce.
Error.Code - Enum in sqip: Possible error codes that can be returned as a result of attempting to create a Google Pay card nonce.
execute() - Method in interface sqip.Call: Synchronously sends the request and returns the result.

F

familyName(familyName) - Method in class sqip.Contact.Builder
Finish() - Constructor for class sqip.CardEntryActivityCommand.Finish: Finish the card entry activity with class CardEntryActivityResult.Success.

G

getAction() - Method in class sqip.VerificationParameters
getAddress_lines() - Method in class sqip.Contact
getAmount() - Method in class sqip.Money: Amount of money that will be charged
getBrand() - Method in class sqip.Card: The card brand
getCard() - Method in interface sqip.CardDetails: The payment card.
getCard() - Method in class sqip.CardEntryActivityResult.Success: The payment card.
getCard() - Method in class sqip.GooglePayNonceResult.Success: The payment card.
getCity() - Method in class sqip.Contact: The contact address city name
getCode() - Method in class sqip.BuyerVerificationResult.Error: The error code.
getCode() - Method in enum sqip.Country
getCode() - Method in enum sqip.Currency
getCode() - Method in class sqip.GooglePayNonceResult.Error: The error code.
getContact() - Method in class sqip.VerificationParameters
getCountry_code() - Method in class sqip.Contact
getCurrencyCode() - Method in class sqip.Money: The currency type the paymentSourceId will be charged in.
getDebugCode() - Method in class sqip.BuyerVerificationResult.Error: A more detailed error code for troubleshooting.
getDebugCode() - Method in class sqip.GooglePayNonceResult.Error: A more detailed error code for troubleshooting.
getDebugMessage() - Method in class sqip.BuyerVerificationResult.Error: A human-readable message containing additional debug
getDebugMessage() - Method in class sqip.GooglePayNonceResult.Error: A human-readable message containing additional debug
getEmail() - Method in class sqip.Contact: Email address of the contact.
getErrorValue() - Method in class sqip.BuyerVerificationResult: The result of an erroneous BuyerVerification.verify operation.
getErrorValue() - Method in class sqip.GooglePayNonceResult: The result of an erroneous GooglePay.requestGooglePayNonce operation.
getExpirationMonth() - Method in class sqip.Card: The expiration month of the card.
getExpirationYear() - Method in class sqip.Card: The 4-digit expiration year of the card.
getFamily_name() - Method in class sqip.Contact
getGiven_name() - Method in class sqip.Contact
getHasChallengedUser() - Method in class sqip.BuyerVerificationResult.Success: true if the buyer was challenged for additional authentication factors.
getHasChallengedUser() - Method in interface sqip.BuyerVerifiedDetails: true if the buyer was challenged for additional authentication factors.
getLastFourDigits() - Method in class sqip.Card: The last 4 digits of the card number.
getMessage() - Method in class sqip.BuyerVerificationResult.Error: A displayable message that summarizes the possible cause of the error.
getMessage() - Method in class sqip.CardEntryActivityCommand.ShowError
getMessage() - Method in class sqip.GooglePayNonceResult.Error: A displayable message that summarizes the possible cause of the error.
getMoney() - Method in class sqip.BuyerAction.Charge
getNonce() - Method in interface sqip.CardDetails: A one-time-use payment token that is used with the Transactions API to charge the card or the Customers API to store a Card on File.
getNonce() - Method in class sqip.CardEntryActivityResult.Success: A one-time-use payment token that is used with the Transactions API
getNonce() - Method in class sqip.GooglePayNonceResult.Success: A one-time-use payment token that is used with the Transactions API
getPaymentSourceId() - Method in class sqip.VerificationParameters
getPhone() - Method in class sqip.Contact: the telephone number of the contact
getPostal_code() - Method in class sqip.Contact
getPostalCode() - Method in class sqip.Card: The billing postal code associated with the card,
getPrepaidType() - Method in class sqip.Card: Indicates whether or not this is a prepaid card.
getRegion() - Method in class sqip.Contact: The applicable administrative region
getSquareApplicationId() - Method in class sqip.InAppPaymentsSdk
getSquareIdentifier() - Method in class sqip.VerificationParameters
getSuccessValue() - Method in class sqip.BuyerVerificationResult: The result of a successful BuyerVerification.verify operation.
getSuccessValue() - Method in class sqip.CardEntryActivityResult
getSuccessValue() - Method in class sqip.GooglePayNonceResult: The result of a successful GooglePay.requestGooglePayNonce operation.
getTokenId() - Method in class sqip.SquareIdentifier.LocationToken
getType() - Method in class sqip.Card: The card’s type.
getVerificationToken() - Method in class sqip.BuyerVerificationResult.Success: The token representing a verified buyer.
getVerificationToken() - Method in interface sqip.BuyerVerifiedDetails: The token representing a verified buyer.
GooglePay - Class in sqip: Lets the application retrieve a card nonce using a Google Pay token.
GooglePayNonceResult - Class in sqip: Represents the result of a GooglePay.requestGooglePayNonce operation. The result will be an instance of class GooglePayNonceResult.Success if the operation is successful or class GooglePayNonceResult.Error if the operation failed.
GooglePayNonceResult.Error - Class in sqip: Represents the result of an unsuccessful GooglePay.requestGooglePayNonce operation.
GooglePayNonceResult.Success - Class in sqip: Represents the result of a successful GooglePay.requestGooglePayNonce operation. Contains the card nonce and additional class Card details.

H

handleActivityResult(data, callback) - Method in class sqip.BuyerVerification: Use this function to handle results of the buyer verification activity. This function should be called from Activity.onActivityResult with the provided data parameter. callback will be called immediately with the result of the buyer verification activity.BuyerVerificationActivityCommand
handleActivityResult(data, callback) - Method in class sqip.CardEntry: Use this function to handle results of the card entry activity. This function should be called from Activity.onActivityResult with the provided data parameter. callback will be called immediately with the result of the card entry activity.
handleActivityResult($receiver, data, callback) - Static method in class sqip.KotlinExtensions
handleActivityResult($receiver, data, callback) - Static method in class sqip.KotlinExtensionsKt
handleEnteredCardInBackground(cardDetails) - Method in interface sqip.CardNonceBackgroundHandler
hashCode() - Method in class sqip.BuyerAction.Charge
hashCode() - Method in class sqip.BuyerAction.Store
hashCode() - Method in class sqip.BuyerVerificationResult.Error
hashCode() - Method in class sqip.BuyerVerificationResult.Success
hashCode() - Method in class sqip.Card
hashCode() - Method in class sqip.CardEntryActivityCommand.ShowError
hashCode() - Method in class sqip.CardEntryActivityResult.Success
hashCode() - Method in class sqip.GooglePayNonceResult.Error
hashCode() - Method in class sqip.GooglePayNonceResult.Success
hashCode() - Method in class sqip.Money
hashCode() - Method in class sqip.SquareIdentifier.LocationToken

I

InAppPaymentsSdk - Class in sqip: Lets the application read and write the Square application ID via the InAppPaymentsSdk.getSquareApplicationId property. You can also specify the application ID at build time in the AndroidManifest.xml:
INSTANCE - Static variable in class sqip.BuyerVerification: Lets the application retrieve a verification token for a payment source ID.
INSTANCE - Static variable in class sqip.CardEntry: Lets the application collect card information from the customer.
INSTANCE - Static variable in class sqip.CardEntryActivityResult.Canceled: The result when the customer cancels the Square card entry activity before a card is successfully entered.
INSTANCE - Static variable in class sqip.GooglePay: Lets the application retrieve a card nonce using a Google Pay token.
INSTANCE - Static variable in class sqip.InAppPaymentsSdk: Lets the application read and write the Square application ID via the InAppPaymentsSdk.getSquareApplicationId property. You can also specify the application ID at build time in the AndroidManifest.xml:
isCanceled() - Method in interface sqip.Call: True if Call.cancel was called.
isCanceled() - Method in class sqip.CardEntryActivityResult: True if the customer cancels the Square card entry activity before a card is successfully entered.
isError() - Method in class sqip.BuyerVerificationResult: True if the BuyerVerification.verify operation resulted in an error.
isError() - Method in class sqip.GooglePayNonceResult: True if the GooglePay.requestGooglePayNonce operation resulted in an error.
isExecuted() - Method in interface sqip.Call: True if this call has been either Call.execute or Call.enqueue. It is an error to execute or enqueue a call more than once.
isSuccess() - Method in class sqip.BuyerVerificationResult: True if the BuyerVerification.verify operation was successful. See BuyerVerificationResult.getSuccessValue for the result.
isSuccess() - Method in class sqip.CardEntryActivityResult: True if card entry is successful. See CardEntryActivityResult.getSuccessValue for the result.
isSuccess() - Method in class sqip.GooglePayNonceResult: True if the GooglePay.requestGooglePayNonce operation was successful. See GooglePayNonceResult.getSuccessValue for the result.

K

KotlinExtensions - Class in sqip
KotlinExtensionsKt - Class in sqip

L

LocationToken(tokenId) - Constructor for class sqip.SquareIdentifier.LocationToken

M

Money - Class in sqip: Amount to charge the card payment source ID in the specified currencyCode
Money(amount, currencyCode) - Constructor for class sqip.Money: Amount to charge the card payment source ID in the specified currencyCode

O

onResult(result) - Method in interface sqip.Callback

P

phone(phone) - Method in class sqip.Contact.Builder
postalCode(postalCode) - Method in class sqip.Contact.Builder
PrepaidType() - Constructor for enum sqip.Card.PrepaidType

R

region(region) - Method in class sqip.Contact.Builder
requestGooglePayNonce(googlePayToken) - Method in class sqip.GooglePay: Creates a interface Call that requests a card nonce from a Google Pay token.

S

setCardNonceBackgroundHandler(handler) - Method in class sqip.CardEntry: Sets an optional handler that will be called from a background thread with the card result, before the card entry activity finishes. This allows the application to perform additional work such as attempting to charge the card and offers the ability to retry (for instance in case of a network error).
setCardNonceBackgroundHandler($receiver, handler) - Static method in class sqip.KotlinExtensions: Adds a callback to handle the result of the card entry prior to finishing the card entry activity. This allows the application to perform additional work such as saving the card to a server, and offers the ability to retry by returning class CardEntryActivityCommand.ShowError (for instance in case of a network error).
setSquareApplicationId(p) - Method in class sqip.InAppPaymentsSdk
ShowError(message) - Constructor for class sqip.CardEntryActivityCommand.ShowError: Display message in an error dialog to the customer, and allow the customer to edit their card information and re-submit.
sqip - package sqip
SquareIdentifier - Class in sqip
SquareIdentifier.LocationToken - Class in sqip
startCardEntryActivity(activity, collectPostalCode, requestCode) - Method in class sqip.CardEntry: Starts an activity that lets the application collect card information from the customer.
startGiftCardEntryActivity(activity, requestCode) - Method in class sqip.CardEntry: Starts an activity that lets the application collect gift card information from the customer.
Store() - Constructor for class sqip.BuyerAction.Store: Action that will store the card paymentSourceId.
Success(hasChallengedUser, verificationToken) - Constructor for class sqip.BuyerVerificationResult.Success: Represents the result of a successful BuyerVerificationResult.verify operation. Contains a value indicating whether the user was challenged and the verification token.
Success(nonce, card) - Constructor for class sqip.CardEntryActivityResult.Success: Represents the result of a successful operation to process card payment information. Contains the card nonce and additional class Card details.
Success(nonce, card) - Constructor for class sqip.GooglePayNonceResult.Success: Represents the result of a successful GooglePay.requestGooglePayNonce operation. Contains the card nonce and additional class Card details.

T

toString() - Method in class sqip.BuyerAction.Charge
toString() - Method in class sqip.BuyerVerificationResult.Error
toString() - Method in class sqip.BuyerVerificationResult.Success
toString() - Method in class sqip.Card
toString() - Method in class sqip.CardEntryActivityCommand.ShowError
toString() - Method in class sqip.CardEntryActivityResult.Success
toString() - Method in class sqip.GooglePayNonceResult.Error
toString() - Method in class sqip.GooglePayNonceResult.Success
toString() - Method in class sqip.Money
toString() - Method in class sqip.SquareIdentifier.LocationToken
Type() - Constructor for enum sqip.Card.Type

V

VerificationParameters - Class in sqip
VerificationParameters(paymentSourceId, action, squareIdentifier, contact) - Constructor for class sqip.VerificationParameters
verify(activity, verificationParameters, requestCode) - Method in class sqip.BuyerVerification: Starts an activity that requests a verification token for a card paymentSourceId.

A B C D E F G H I K L M O P R S T V