Module com.aoapps.payments.api

Package com.aoapps.payments

Class AuthorizationResult

java.lang.Object

com.aoapps.payments.TransactionResult

com.aoapps.payments.AuthorizationResult

All Implemented Interfaces:

Cloneable

public class AuthorizationResult
extends TransactionResult
implements Cloneable

Encapsulates the results of an authorization.

Author:

AO Industries, Inc.

See Also:

• MerchantServicesProvider.authorize(com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AuthorizationResult.ApprovalResult	The set of supported approval results.
static enum	AuthorizationResult.AvsResult	The set of supported address verification results.
static enum	AuthorizationResult.CvvResult	The set of supported card verification results.
static enum	AuthorizationResult.DeclineReason	The set of supported decline reasons.
static enum	AuthorizationResult.ReviewReason	The set of supported review reasons.

Nested classes/interfaces inherited from class com.aoapps.payments.TransactionResult

TransactionResult.CommunicationResult, TransactionResult.ErrorCode

Constructor Summary

Constructors

Constructor	Description
AuthorizationResult(String providerId, TransactionResult.CommunicationResult communicationResult, String providerErrorCode, TransactionResult.ErrorCode errorCode, String providerErrorMessage, String providerUniqueId, TokenizedCreditCard tokenizedCreditCard, String providerApprovalResult, AuthorizationResult.ApprovalResult approvalResult, String providerDeclineReason, AuthorizationResult.DeclineReason declineReason, String providerReviewReason, AuthorizationResult.ReviewReason reviewReason, String providerCvvResult, AuthorizationResult.CvvResult cvvResult, String providerAvsResult, AuthorizationResult.AvsResult avsResult, String approvalCode)	Creates a new authorization result.
AuthorizationResult(String providerId, TransactionResult.CommunicationResult communicationResult, String providerErrorCode, TransactionResult.ErrorCode errorCode, String providerErrorMessage, String providerUniqueId, String providerApprovalResult, AuthorizationResult.ApprovalResult approvalResult, String providerDeclineReason, AuthorizationResult.DeclineReason declineReason, String providerReviewReason, AuthorizationResult.ReviewReason reviewReason, String providerCvvResult, AuthorizationResult.CvvResult cvvResult, String providerAvsResult, AuthorizationResult.AvsResult avsResult, String approvalCode)	Deprecated, for removal: This API element is subject to removal in a future version. Please use AuthorizationResult(java.lang.String, com.aoapps.payments.TransactionResult.CommunicationResult, java.lang.String, com.aoapps.payments.TransactionResult.ErrorCode, java.lang.String, java.lang.String, com.aoapps.payments.TokenizedCreditCard, java.lang.String, com.aoapps.payments.AuthorizationResult.ApprovalResult, java.lang.String, com.aoapps.payments.AuthorizationResult.DeclineReason, java.lang.String, com.aoapps.payments.AuthorizationResult.ReviewReason, java.lang.String, com.aoapps.payments.AuthorizationResult.CvvResult, java.lang.String, com.aoapps.payments.AuthorizationResult.AvsResult, java.lang.String)

Method Summary

Modifier and Type	Method	Description
AuthorizationResult	clone()
String	getApprovalCode()	Gets the approval code.
AuthorizationResult.ApprovalResult	getApprovalResult()	Gets the provider-neutral approval response code.
AuthorizationResult.AvsResult	getAvsResult()	Gets the provider-neutral AVS result.
AuthorizationResult.CvvResult	getCvvResult()	Gets the provider-neutral CVV result.
AuthorizationResult.DeclineReason	getDeclineReason()	Gets the provider-neutral decline reason.
String	getProviderApprovalResult()	Gets the provider-specific approval response.
String	getProviderAvsResult()	Gets the provider-specific AVS result.
String	getProviderCvvResult()	Gets the provider-specific CVV result.
String	getProviderDeclineReason()	Gets the provider-specific decline reason.
String	getProviderReviewReason()	Gets the provider-specific review reason.
AuthorizationResult.ReviewReason	getReviewReason()	Gets the provider-neutral review reason.
TokenizedCreditCard	getTokenizedCreditCard()	Gets the tokenized card used for this authorization.

Methods inherited from class com.aoapps.payments.TransactionResult

getCommunicationResult, getErrorCode, getProviderErrorCode, getProviderErrorMessage, getProviderId, getProviderUniqueId

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationResult

public AuthorizationResult(String providerId,
 TransactionResult.CommunicationResult communicationResult,
 String providerErrorCode,
 TransactionResult.ErrorCode errorCode,
 String providerErrorMessage,
 String providerUniqueId,
 TokenizedCreditCard tokenizedCreditCard,
 String providerApprovalResult,
 AuthorizationResult.ApprovalResult approvalResult,
 String providerDeclineReason,
 AuthorizationResult.DeclineReason declineReason,
 String providerReviewReason,
 AuthorizationResult.ReviewReason reviewReason,
 String providerCvvResult,
 AuthorizationResult.CvvResult cvvResult,
 String providerAvsResult,
 AuthorizationResult.AvsResult avsResult,
 String approvalCode)

Creates a new authorization result.

AuthorizationResult

@Deprecated(forRemoval=true)
public AuthorizationResult(String providerId,
 TransactionResult.CommunicationResult communicationResult,
 String providerErrorCode,
 TransactionResult.ErrorCode errorCode,
 String providerErrorMessage,
 String providerUniqueId,
 String providerApprovalResult,
 AuthorizationResult.ApprovalResult approvalResult,
 String providerDeclineReason,
 AuthorizationResult.DeclineReason declineReason,
 String providerReviewReason,
 AuthorizationResult.ReviewReason reviewReason,
 String providerCvvResult,
 AuthorizationResult.CvvResult cvvResult,
 String providerAvsResult,
 AuthorizationResult.AvsResult avsResult,
 String approvalCode)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use AuthorizationResult(java.lang.String, com.aoapps.payments.TransactionResult.CommunicationResult, java.lang.String, com.aoapps.payments.TransactionResult.ErrorCode, java.lang.String, java.lang.String, com.aoapps.payments.TokenizedCreditCard, java.lang.String, com.aoapps.payments.AuthorizationResult.ApprovalResult, java.lang.String, com.aoapps.payments.AuthorizationResult.DeclineReason, java.lang.String, com.aoapps.payments.AuthorizationResult.ReviewReason, java.lang.String, com.aoapps.payments.AuthorizationResult.CvvResult, java.lang.String, com.aoapps.payments.AuthorizationResult.AvsResult, java.lang.String)

Creates a new authorization result.

Method Details

clone

public AuthorizationResult clone()
                          throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getTokenizedCreditCard

public TokenizedCreditCard getTokenizedCreditCard()

Gets the tokenized card used for this authorization.

Returns:

The tokenized card or null when replacement not supported

getProviderApprovalResult

public String getProviderApprovalResult()

Gets the provider-specific approval response.

getApprovalResult

public AuthorizationResult.ApprovalResult getApprovalResult()

Gets the provider-neutral approval response code.

getProviderDeclineReason

public String getProviderDeclineReason()

Gets the provider-specific decline reason.

getDeclineReason

public AuthorizationResult.DeclineReason getDeclineReason()

Gets the provider-neutral decline reason.

getProviderReviewReason

public String getProviderReviewReason()

Gets the provider-specific review reason.

getReviewReason

public AuthorizationResult.ReviewReason getReviewReason()

Gets the provider-neutral review reason.

getProviderCvvResult

public String getProviderCvvResult()

Gets the provider-specific CVV result.

getCvvResult

public AuthorizationResult.CvvResult getCvvResult()

Gets the provider-neutral CVV result.

getProviderAvsResult

public String getProviderAvsResult()

Gets the provider-specific AVS result.

getAvsResult

public AuthorizationResult.AvsResult getAvsResult()

Gets the provider-neutral AVS result.

getApprovalCode

public String getApprovalCode()

Gets the approval code.