com.paypal.api.payments

Class Authorization

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Authorization

public class Authorization
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Authorization() Default Constructor
Authorization(Amount amount) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
Capture	capture(APIContext apiContext, Capture capture) Captures and processes an authorization, by ID.
Capture	capture(java.lang.String accessToken, Capture capture) Deprecated. Please use capture(APIContext, Capture) instead.
Authorization	doVoid(APIContext apiContext) Voids, or cancels, an authorization, by ID.
Authorization	doVoid(java.lang.String accessToken) Deprecated. Please use doVoid(APIContext) instead.
boolean	equals(java.lang.Object o)
static Authorization	get(APIContext apiContext, java.lang.String authorizationId) Shows details for an authorization, by ID.
static Authorization	get(java.lang.String accessToken, java.lang.String authorizationId) Deprecated. Please use get(APIContext, String) instead.
Amount	getAmount() Amount being authorized.
java.lang.String	getCreateTime() Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
FmfDetails	getFmfDetails() Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
java.lang.String	getId() ID of the authorization transaction.
java.util.List<Links>	getLinks()
java.lang.String	getParentPayment() ID of the Payment resource that this transaction is based on.
java.lang.String	getPaymentMode() Specifies the payment mode of the transaction.
java.lang.String	getPendingReason() [DEPRECATED] Reason code for the transaction state being Pending.Obsolete.
java.lang.String	getProtectionEligibility() The level of seller protection in force for the transaction.
java.lang.String	getProtectionEligibilityType() The kind of seller protection in force for the transaction.
java.lang.String	getReasonCode() Reason code, `AUTHORIZATION`, for a transaction state of `pending`.
java.lang.String	getReceiptId() Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
java.lang.String	getReferenceId() Identifier to the purchase or transaction unit corresponding to this authorization transaction.
java.lang.String	getState() State of the authorization.
java.lang.String	getUpdateTime() Time that the resource was last updated.
java.lang.String	getValidUntil() Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
int	hashCode()
Authorization	reauthorize(APIContext apiContext) Reauthorizes a PayPal account payment, by authorization ID.
Authorization	reauthorize(java.lang.String accessToken) Deprecated. Please use reauthorize(APIContext) instead.
Authorization	setAmount(Amount amount) Amount being authorized.
Authorization	setCreateTime(java.lang.String createTime) Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
Authorization	setFmfDetails(FmfDetails fmfDetails) Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
Authorization	setId(java.lang.String id) ID of the authorization transaction.
Authorization	setLinks(java.util.List<Links> links)
Authorization	setParentPayment(java.lang.String parentPayment) ID of the Payment resource that this transaction is based on.
Authorization	setPaymentMode(java.lang.String paymentMode) Specifies the payment mode of the transaction.
Authorization	setPendingReason(java.lang.String pendingReason) [DEPRECATED] Reason code for the transaction state being Pending.Obsolete.
Authorization	setProtectionEligibility(java.lang.String protectionEligibility) The level of seller protection in force for the transaction.
Authorization	setProtectionEligibilityType(java.lang.String protectionEligibilityType) The kind of seller protection in force for the transaction.
Authorization	setReasonCode(java.lang.String reasonCode) Reason code, `AUTHORIZATION`, for a transaction state of `pending`.
Authorization	setReceiptId(java.lang.String receiptId) Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
Authorization	setReferenceId(java.lang.String referenceId) Identifier to the purchase or transaction unit corresponding to this authorization transaction.
Authorization	setState(java.lang.String state) State of the authorization.
Authorization	setUpdateTime(java.lang.String updateTime) Time that the resource was last updated.
Authorization	setValidUntil(java.lang.String validUntil) Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).

Methods inherited from class com.paypal.base.rest.PayPalResource

configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel

toJSON, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Authorization

public Authorization()

Default Constructor

Authorization

public Authorization(Amount amount)

Parameterized Constructor

Method Detail

get

public static Authorization get(java.lang.String accessToken,
                                java.lang.String authorizationId)
                         throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Shows details for an authorization, by ID.

Parameters:

accessToken - Access Token used for the API call.

authorizationId - String

Returns:

Authorization

Throws:

PayPalRESTException

get

public static Authorization get(APIContext apiContext,
                                java.lang.String authorizationId)
                         throws PayPalRESTException

Shows details for an authorization, by ID.

Parameters:

apiContext - APIContext used for the API call.

authorizationId - String

Returns:

Authorization

Throws:

PayPalRESTException

capture

public Capture capture(java.lang.String accessToken,
                       Capture capture)
                throws PayPalRESTException

Deprecated. Please use capture(APIContext, Capture) instead.

Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of `authorize`.

Parameters:

accessToken - Access Token used for the API call.

capture - Capture

Returns:

Capture

Throws:

PayPalRESTException

capture

public Capture capture(APIContext apiContext,
                       Capture capture)
                throws PayPalRESTException

Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of `authorize`.

Parameters:

apiContext - APIContext used for the API call.

capture - Capture

Returns:

Capture

Throws:

PayPalRESTException

doVoid

public Authorization doVoid(java.lang.String accessToken)
                     throws PayPalRESTException

Deprecated. Please use doVoid(APIContext) instead.

Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Authorization

Throws:

PayPalRESTException

doVoid

public Authorization doVoid(APIContext apiContext)
                     throws PayPalRESTException

Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Authorization

Throws:

PayPalRESTException

reauthorize

public Authorization reauthorize(java.lang.String accessToken)
                          throws PayPalRESTException

Deprecated. Please use reauthorize(APIContext) instead.

Reauthorizes a PayPal account payment, by authorization ID. To ensure that funds are still available, reauthorize a payment after the initial three-day honor period. Supports only the `amount` request parameter.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Authorization

Throws:

PayPalRESTException

reauthorize

public Authorization reauthorize(APIContext apiContext)
                          throws PayPalRESTException

Reauthorizes a PayPal account payment, by authorization ID. To ensure that funds are still available, reauthorize a payment after the initial three-day honor period. Supports only the `amount` request parameter.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Authorization

Throws:

PayPalRESTException

getId

public java.lang.String getId()

ID of the authorization transaction.

getAmount

public Amount getAmount()

Amount being authorized.

getPaymentMode

public java.lang.String getPaymentMode()

Specifies the payment mode of the transaction.

getState

public java.lang.String getState()

State of the authorization.

getReasonCode

public java.lang.String getReasonCode()

Reason code, `AUTHORIZATION`, for a transaction state of `pending`.

getPendingReason

public java.lang.String getPendingReason()

[DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.

getProtectionEligibility

public java.lang.String getProtectionEligibility()

The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`. Allowed values:
`ELIGIBLE`- Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
`PARTIALLY_ELIGIBLE`- Merchant is protected by PayPal's Seller Protection Policy for Item Not Received or Unauthorized Payments. Refer to `protection_eligibility_type` for specifics.
`INELIGIBLE`- Merchant is not protected under the Seller Protection Policy.

getProtectionEligibilityType

public java.lang.String getProtectionEligibilityType()

The kind of seller protection in force for the transaction. This property is returned only when the `protection_eligibility` property is set to `ELIGIBLE`or `PARTIALLY_ELIGIBLE`. Only supported when the `payment_method` is set to `paypal`. Allowed values:
`ITEM_NOT_RECEIVED_ELIGIBLE`- Sellers are protected against claims for items not received.
`UNAUTHORIZED_PAYMENT_ELIGIBLE`- Sellers are protected against claims for unauthorized payments.
One or both of the allowed values can be returned.

getFmfDetails

public FmfDetails getFmfDetails()

Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](https://developer.paypal.com/docs/classic/fmf/integration-guide/FMFSummary/) for more information.

getParentPayment

public java.lang.String getParentPayment()

ID of the Payment resource that this transaction is based on.

getValidUntil

public java.lang.String getValidUntil()

Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).

getCreateTime

public java.lang.String getCreateTime()

Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).

getUpdateTime

public java.lang.String getUpdateTime()

Time that the resource was last updated.

getReferenceId

public java.lang.String getReferenceId()

Identifier to the purchase or transaction unit corresponding to this authorization transaction.

getReceiptId

public java.lang.String getReceiptId()

Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.

getLinks

public java.util.List<Links> getLinks()

setId

public Authorization setId(java.lang.String id)

ID of the authorization transaction.

Returns:

this

setAmount

public Authorization setAmount(Amount amount)

Amount being authorized.

Returns:

this

setPaymentMode

public Authorization setPaymentMode(java.lang.String paymentMode)

Specifies the payment mode of the transaction.

Returns:

this

setState

public Authorization setState(java.lang.String state)

State of the authorization.

Returns:

this

setReasonCode

public Authorization setReasonCode(java.lang.String reasonCode)

Reason code, `AUTHORIZATION`, for a transaction state of `pending`.

Returns:

this

setPendingReason

public Authorization setPendingReason(java.lang.String pendingReason)

[DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.

Returns:

this

setProtectionEligibility

public Authorization setProtectionEligibility(java.lang.String protectionEligibility)

The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`. Allowed values:
`ELIGIBLE`- Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
`PARTIALLY_ELIGIBLE`- Merchant is protected by PayPal's Seller Protection Policy for Item Not Received or Unauthorized Payments. Refer to `protection_eligibility_type` for specifics.
`INELIGIBLE`- Merchant is not protected under the Seller Protection Policy.

Returns:

this

setProtectionEligibilityType

public Authorization setProtectionEligibilityType(java.lang.String protectionEligibilityType)

The kind of seller protection in force for the transaction. This property is returned only when the `protection_eligibility` property is set to `ELIGIBLE`or `PARTIALLY_ELIGIBLE`. Only supported when the `payment_method` is set to `paypal`. Allowed values:
`ITEM_NOT_RECEIVED_ELIGIBLE`- Sellers are protected against claims for items not received.
`UNAUTHORIZED_PAYMENT_ELIGIBLE`- Sellers are protected against claims for unauthorized payments.
One or both of the allowed values can be returned.

Returns:

this

setFmfDetails

public Authorization setFmfDetails(FmfDetails fmfDetails)

Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](https://developer.paypal.com/docs/classic/fmf/integration-guide/FMFSummary/) for more information.

Returns:

this

setParentPayment

public Authorization setParentPayment(java.lang.String parentPayment)

ID of the Payment resource that this transaction is based on.

Returns:

this

setValidUntil

public Authorization setValidUntil(java.lang.String validUntil)

Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).

Returns:

this

setCreateTime

public Authorization setCreateTime(java.lang.String createTime)

Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).

Returns:

this

setUpdateTime

public Authorization setUpdateTime(java.lang.String updateTime)

Time that the resource was last updated.

Returns:

this

setReferenceId

public Authorization setReferenceId(java.lang.String referenceId)

Identifier to the purchase or transaction unit corresponding to this authorization transaction.

Returns:

this

setReceiptId

public Authorization setReceiptId(java.lang.String receiptId)

Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.

Returns:

this

setLinks

public Authorization setLinks(java.util.List<Links> links)

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PayPalModel

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class PayPalModel

hashCode

public int hashCode()

Overrides:

hashCode in class PayPalModel