public
|
#
setId( string $id )
ID of the authorization transaction.
ID of the authorization transaction.
Parameters
Returns
$this
|
public
string
|
#
getId( )
ID of the authorization transaction.
ID of the authorization transaction.
Returns
string
|
public
|
|
public
PayPal\Api\Amount
|
|
public
|
#
setPaymentMode( string $payment_mode )
Specifies the payment mode of the transaction.
Valid Values: ["INSTANT_TRANSFER"]
Specifies the payment mode of the transaction.
Valid Values: ["INSTANT_TRANSFER"]
Parameters
Returns
$this
|
public
string
|
#
getPaymentMode( )
Specifies the payment mode of the transaction.
Specifies the payment mode of the transaction.
Returns
string
|
public
|
#
setState( string $state )
State of the authorization.
Valid Values: ["pending", "authorized", "partially_captured", "captured", "expired", "voided"]
State of the authorization.
Valid Values: ["pending", "authorized", "partially_captured", "captured", "expired", "voided"]
Parameters
Returns
$this
|
public
string
|
#
getState( )
State of the authorization.
State of the authorization.
Returns
string
|
public
|
#
setReasonCode( string $reason_code )
Reason code, AUTHORIZATION, for a transaction state of pending.
Valid Values: ["AUTHORIZATION"]
Reason code, AUTHORIZATION, for a transaction state of pending.
Valid Values: ["AUTHORIZATION"]
Parameters
Returns
$this
|
public
string
|
#
getReasonCode( )
Reason code, AUTHORIZATION, for a transaction state of pending.
Reason code, AUTHORIZATION, for a transaction state of pending.
Returns
string
|
public
|
#
setPendingReason( string $pending_reason )
[DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.
Valid Values: ["AUTHORIZATION"]
[DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.
Valid Values: ["AUTHORIZATION"]
Parameters
Returns
$this
|
public
string
|
#
getPendingReason( )
Deprecated
[DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.
Returns
string
|
public
|
#
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.
Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"]
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.
Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"]
Parameters
Returns
$this
|
public
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.
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
string
|
public
|
#
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.
Valid Values: ["ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"]
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.
Valid Values: ["ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"]
Parameters
- $protection_eligibility_type
Returns
$this
|
public
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 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.
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.
Returns
string
|
public
|
#
setFmfDetails( PayPal\Api\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.
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.
Parameters
Returns
$this
|
public
PayPal\Api\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 for more information.
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.
Returns
|
public
|
#
setParentPayment( string $parent_payment )
ID of the Payment resource that this transaction is based on.
ID of the Payment resource that this transaction is based on.
Parameters
Returns
$this
|
public
string
|
#
getParentPayment( )
ID of the Payment resource that this transaction is based on.
ID of the Payment resource that this transaction is based on.
Returns
string
|
public
|
#
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.
Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
Parameters
Returns
$this
|
public
PayPal\Api\ProcessorResponse
|
#
getProcessorResponse( )
Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card.
Returns
|
public
|
|
public
string
|
|
public
|
|
public
string
|
|
public
|
#
setUpdateTime( string $update_time )
Time that the resource was last updated.
Time that the resource was last updated.
Parameters
Returns
$this
|
public
string
|
#
getUpdateTime( )
Time that the resource was last updated.
Time that the resource was last updated.
Returns
string
|
public
|
#
setReferenceId( string $reference_id )
Identifier to the purchase or transaction unit corresponding to this authorization transaction.
Identifier to the purchase or transaction unit corresponding to this authorization transaction.
Parameters
Returns
$this
|
public
string
|
#
getReferenceId( )
Identifier to the purchase or transaction unit corresponding to this authorization transaction.
Identifier to the purchase or transaction unit corresponding to this authorization transaction.
Returns
string
|
public
|
#
setReceiptId( string $receipt_id )
Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
Parameters
Returns
$this
|
public
string
|
#
getReceiptId( )
Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
Returns
string
|
public static
PayPal\Api\Authorization
|
#
get( string $authorizationId, PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )
Shows details for an authorization, by ID.
Shows details for an authorization, by ID.
Parameters
- $authorizationId
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public
PayPal\Api\Capture
|
#
capture( PayPal\Api\Capture $capture, PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )
Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of authorize.
Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of authorize.
Parameters
- $capture
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public
PayPal\Api\Authorization
|
#
void( PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )
Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.
Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.
Parameters
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public
PayPal\Api\Authorization
|
#
reauthorize( PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )
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.
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
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
PayPal\Common\PayPalResourceModel
implements
PayPal\Rest\IResource