com.squareup.square.models

Class CardPaymentDetails

java.lang.Object

com.squareup.square.models.CardPaymentDetails

public class CardPaymentDetails
extends Object

This is a model class for CardPaymentDetails type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CardPaymentDetails.Builder Class to build instances of CardPaymentDetails.

Constructor Summary

Constructors

Constructor and Description

CardPaymentDetails(String status, Card card, String entryMethod, String cvvStatus, String avsStatus, String authResultCode, String applicationIdentifier, String applicationName, String applicationCryptogram, String verificationMethod, String verificationResults, String statementDescription, DeviceDetails deviceDetails, CardPaymentTimeline cardPaymentTimeline, Boolean refundRequiresCardPresence, List<Error> errors) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationCryptogram() Getter for ApplicationCryptogram.
String	getApplicationIdentifier() Getter for ApplicationIdentifier.
String	getApplicationName() Getter for ApplicationName.
String	getAuthResultCode() Getter for AuthResultCode.
String	getAvsStatus() Getter for AvsStatus.
Card	getCard() Getter for Card.
CardPaymentTimeline	getCardPaymentTimeline() Getter for CardPaymentTimeline.
String	getCvvStatus() Getter for CvvStatus.
DeviceDetails	getDeviceDetails() Getter for DeviceDetails.
String	getEntryMethod() Getter for EntryMethod.
List<Error>	getErrors() Getter for Errors.
Boolean	getRefundRequiresCardPresence() Getter for RefundRequiresCardPresence.
String	getStatementDescription() Getter for StatementDescription.
String	getStatus() Getter for Status.
String	getVerificationMethod() Getter for VerificationMethod.
String	getVerificationResults() Getter for VerificationResults.
int	hashCode()
CardPaymentDetails.Builder	toBuilder() Builds a new CardPaymentDetails.Builder object.
String	toString() Converts this CardPaymentDetails into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CardPaymentDetails

public CardPaymentDetails(String status,
                          Card card,
                          String entryMethod,
                          String cvvStatus,
                          String avsStatus,
                          String authResultCode,
                          String applicationIdentifier,
                          String applicationName,
                          String applicationCryptogram,
                          String verificationMethod,
                          String verificationResults,
                          String statementDescription,
                          DeviceDetails deviceDetails,
                          CardPaymentTimeline cardPaymentTimeline,
                          Boolean refundRequiresCardPresence,
                          List<Error> errors)

Initialization constructor.

Parameters:

status - String value for status.

card - Card value for card.

entryMethod - String value for entryMethod.

cvvStatus - String value for cvvStatus.

avsStatus - String value for avsStatus.

authResultCode - String value for authResultCode.

applicationIdentifier - String value for applicationIdentifier.

applicationName - String value for applicationName.

applicationCryptogram - String value for applicationCryptogram.

verificationMethod - String value for verificationMethod.

verificationResults - String value for verificationResults.

statementDescription - String value for statementDescription.

deviceDetails - DeviceDetails value for deviceDetails.

cardPaymentTimeline - CardPaymentTimeline value for cardPaymentTimeline.

refundRequiresCardPresence - Boolean value for refundRequiresCardPresence.

errors - List of Error value for errors.

Method Detail

getStatus

public String getStatus()

Getter for Status. The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.

Returns:

Returns the String

getCard

public Card getCard()

Getter for Card. Represents the payment details of a card to be used for payments. These details are determined by the payment token generated by Web Payments SDK.

Returns:

Returns the Card

getEntryMethod

public String getEntryMethod()

Getter for EntryMethod. The method used to enter the card's details for the payment. The method can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.

Returns:

Returns the String

getCvvStatus

public String getCvvStatus()

Getter for CvvStatus. The status code returned from the Card Verification Value (CVV) check. The code can be `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`.

Returns:

Returns the String

getAvsStatus

public String getAvsStatus()

Getter for AvsStatus. The status code returned from the Address Verification System (AVS) check. The code can be `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`.

Returns:

Returns the String

getAuthResultCode

public String getAuthResultCode()

Getter for AuthResultCode. The status code returned by the card issuer that describes the payment's authorization status.

Returns:

Returns the String

getApplicationIdentifier

public String getApplicationIdentifier()

Getter for ApplicationIdentifier. For EMV payments, the application ID identifies the EMV application used for the payment.

Returns:

Returns the String

getApplicationName

public String getApplicationName()

Getter for ApplicationName. For EMV payments, the human-readable name of the EMV application used for the payment.

Returns:

Returns the String

getApplicationCryptogram

public String getApplicationCryptogram()

Getter for ApplicationCryptogram. For EMV payments, the cryptogram generated for the payment.

Returns:

Returns the String

getVerificationMethod

public String getVerificationMethod()

Getter for VerificationMethod. For EMV payments, the method used to verify the cardholder's identity. The method can be `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`.

Returns:

Returns the String

getVerificationResults

public String getVerificationResults()

Getter for VerificationResults. For EMV payments, the results of the cardholder verification. The result can be `SUCCESS`, `FAILURE`, or `UNKNOWN`.

Returns:

Returns the String

getStatementDescription

public String getStatementDescription()

Getter for StatementDescription. The statement description sent to the card networks. Note: The actual statement description varies and is likely to be truncated and appended with additional information on a per issuer basis.

Returns:

Returns the String

getDeviceDetails

public DeviceDetails getDeviceDetails()

Getter for DeviceDetails. Details about the device that took the payment.

Returns:

Returns the DeviceDetails

getCardPaymentTimeline

public CardPaymentTimeline getCardPaymentTimeline()

Getter for CardPaymentTimeline. The timeline for card payments.

Returns:

Returns the CardPaymentTimeline

getRefundRequiresCardPresence

public Boolean getRefundRequiresCardPresence()

Getter for RefundRequiresCardPresence. Whether the card must be physically present for the payment to be refunded. If set to `true`, the card must be present.

Returns:

Returns the Boolean

getErrors

public List<Error> getErrors()

Getter for Errors. Information about errors encountered during the request.

Returns:

Returns the List of Error

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 CardPaymentDetails into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CardPaymentDetails.Builder toBuilder()

Builds a new CardPaymentDetails.Builder object. Creates the instance with the state of the current model.

Returns:

a new CardPaymentDetails.Builder object