PHP Class PayPal\Api\Authorization

An authorization transaction.
Inheritance: extends PayPal\Common\PayPalResourceModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
capture ( Capture $capture, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Capture Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of authorize.
get ( string $authorizationId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Authorization Shows details for an authorization, by ID.
getAmount ( ) : Amount Amount being authorized.
getCreateTime ( ) : string Time of authorization as defined in RFC 3339 Section 5.6.
getFmfDetails ( ) : 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 for more information.
getId ( ) : string ID of the authorization transaction.
getParentPayment ( ) : string ID of the Payment resource that this transaction is based on.
getPaymentMode ( ) : string Specifies the payment mode of the transaction.
getPendingReason ( ) : string
getProcessorResponse ( ) : PayPal\Api\ProcessorResponse Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
getProtectionEligibility ( ) : string 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 ( ) : string The kind of seller protection in force for the transaction. This property is returned only when the protection_eligibility property is set to ELIGIBLEor 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.
getReasonCode ( ) : string Reason code, AUTHORIZATION, for a transaction state of pending.
getReceiptId ( ) : string Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
getReferenceId ( ) : string Identifier to the purchase or transaction unit corresponding to this authorization transaction.
getState ( ) : string State of the authorization.
getUpdateTime ( ) : string Time that the resource was last updated.
getValidUntil ( ) : string Authorization expiration time and date as defined in RFC 3339 Section 5.6.
reauthorize ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Authorization 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.
setAmount ( Amount $amount ) Amount being authorized.
setCreateTime ( string $create_time ) Time of authorization as defined in RFC 3339 Section 5.6.
setFmfDetails ( FmfDetails $fmf_details ) 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 for more information.
setId ( string $id ) ID of the authorization transaction.
setParentPayment ( string $parent_payment ) ID of the Payment resource that this transaction is based on.
setPaymentMode ( string $payment_mode ) Specifies the payment mode of the transaction.
setPendingReason ( string $pending_reason ) [DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.
setProcessorResponse ( PayPal\Api\ProcessorResponse $processor_response ) Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
setProtectionEligibility ( string $protection_eligibility ) 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.
setProtectionEligibilityType ( string $protection_eligibility_type ) The kind of seller protection in force for the transaction. This property is returned only when the protection_eligibility property is set to ELIGIBLEor 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.
setReasonCode ( string $reason_code ) Reason code, AUTHORIZATION, for a transaction state of pending.
setReceiptId ( string $receipt_id ) Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
setReferenceId ( string $reference_id ) Identifier to the purchase or transaction unit corresponding to this authorization transaction.
setState ( string $state ) State of the authorization.
setUpdateTime ( string $update_time ) Time that the resource was last updated.
setValidUntil ( string $valid_until ) Authorization expiration time and date as defined in RFC 3339 Section 5.6.
void ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Authorization Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.

Method Details

capture() public method

Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of authorize.
public capture ( Capture $capture, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Capture
$capture Capture
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
return Capture

get() public static method

Shows details for an authorization, by ID.
public static get ( string $authorizationId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Authorization
$authorizationId string
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
return Authorization

getAmount() public method

Amount being authorized.
public getAmount ( ) : Amount
return Amount

getCreateTime() public method

Time of authorization as defined in RFC 3339 Section 5.6.
public getCreateTime ( ) : string
return string

getFmfDetails() public method

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 for more information.
public getFmfDetails ( ) : FmfDetails
return FmfDetails

getId() public method

ID of the authorization transaction.
public getId ( ) : string
return string

getParentPayment() public method

ID of the Payment resource that this transaction is based on.
public getParentPayment ( ) : string
return string

getPaymentMode() public method

Specifies the payment mode of the transaction.
public getPaymentMode ( ) : string
return string

getPendingReason() public method

Deprecation: [DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.
public getPendingReason ( ) : string
return string

getProcessorResponse() public method

Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
public getProcessorResponse ( ) : PayPal\Api\ProcessorResponse
return PayPal\Api\ProcessorResponse

getProtectionEligibility() public method

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.
public getProtectionEligibility ( ) : string
return string

getProtectionEligibilityType() public method

The kind of seller protection in force for the transaction. This property is returned only when the protection_eligibility property is set to ELIGIBLEor 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.
public getProtectionEligibilityType ( ) : string
return string

getReasonCode() public method

Reason code, AUTHORIZATION, for a transaction state of pending.
public getReasonCode ( ) : string
return string

getReceiptId() public method

Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
public getReceiptId ( ) : string
return string

getReferenceId() public method

Identifier to the purchase or transaction unit corresponding to this authorization transaction.
public getReferenceId ( ) : string
return string

getState() public method

State of the authorization.
public getState ( ) : string
return string

getUpdateTime() public method

Time that the resource was last updated.
public getUpdateTime ( ) : string
return string

getValidUntil() public method

Authorization expiration time and date as defined in RFC 3339 Section 5.6.
public getValidUntil ( ) : string
return string

reauthorize() public method

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.
public reauthorize ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Authorization
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
return Authorization

setAmount() public method

Amount being authorized.
public setAmount ( Amount $amount )
$amount Amount

setCreateTime() public method

Time of authorization as defined in RFC 3339 Section 5.6.
public setCreateTime ( string $create_time )
$create_time string

setFmfDetails() public method

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 for more information.
public setFmfDetails ( FmfDetails $fmf_details )
$fmf_details FmfDetails

setId() public method

ID of the authorization transaction.
public setId ( string $id )
$id string

setParentPayment() public method

ID of the Payment resource that this transaction is based on.
public setParentPayment ( string $parent_payment )
$parent_payment string

setPaymentMode() public method

Valid Values: ["INSTANT_TRANSFER"]
public setPaymentMode ( string $payment_mode )
$payment_mode string

setPendingReason() public method

Valid Values: ["AUTHORIZATION"]
public setPendingReason ( string $pending_reason )
$pending_reason string

setProcessorResponse() public method

Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
public setProcessorResponse ( PayPal\Api\ProcessorResponse $processor_response )
$processor_response PayPal\Api\ProcessorResponse

setProtectionEligibility() public method

Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"]
public setProtectionEligibility ( string $protection_eligibility )
$protection_eligibility string

setProtectionEligibilityType() public method

Valid Values: ["ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"]
public setProtectionEligibilityType ( string $protection_eligibility_type )
$protection_eligibility_type string

setReasonCode() public method

Valid Values: ["AUTHORIZATION"]
public setReasonCode ( string $reason_code )
$reason_code string

setReceiptId() public method

Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
public setReceiptId ( string $receipt_id )
$receipt_id string

setReferenceId() public method

Identifier to the purchase or transaction unit corresponding to this authorization transaction.
public setReferenceId ( string $reference_id )
$reference_id string

setState() public method

Valid Values: ["pending", "authorized", "partially_captured", "captured", "expired", "voided"]
public setState ( string $state )
$state string

setUpdateTime() public method

Time that the resource was last updated.
public setUpdateTime ( string $update_time )
$update_time string

setValidUntil() public method

Authorization expiration time and date as defined in RFC 3339 Section 5.6.
public setValidUntil ( string $valid_until )
$valid_until string

void() public method

Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.
public void ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Authorization
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
return Authorization