PHP Class PayPal\PayPalAPI\DoAuthorizationRequestType

Inheritance: extends PayPal\EBLBaseComponents\AbstractRequestType
Show file Open project: paypal/merchant-sdk-php Class Usage Examples

Public Properties

Property Type Description
$Amount PayPal\CoreComponentTypes\BasicAmountType Amount to authorize. Required Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
$Custom string A free-form field for your own use. Optional Character length and limitations: 256 single-byte alphanumeric characters
$HandlingTotal PayPal\CoreComponentTypes\BasicAmountType Total handling costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
$IPAddress string IP Address of the buyer
$InsuranceTotal PayPal\CoreComponentTypes\BasicAmountType Total shipping insurance costs for this order. Optional
$ItemTotal PayPal\CoreComponentTypes\BasicAmountType Sum of cost of all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
$MsgSubID string Unique id for each API request to prevent duplicate payments. Optional Character length and limits: 38 single-byte characters maximum.
$OrderDescription string Description of items the customer is purchasing. Optional Character length and limitations: 127 single-byte alphanumeric characters
$PaymentDetailsItem PayPal\EBLBaseComponents\PaymentDetailsItemType Information about the individual purchased items
$ShipToAddress PayPal\EBLBaseComponents\AddressType Address the order will be shipped to. Optional
$ShippingDiscount PayPal\CoreComponentTypes\BasicAmountType Shipping discount for this order, specified as a negative number. Optional
$ShippingTotal PayPal\CoreComponentTypes\BasicAmountType Total shipping costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
$TaxTotal PayPal\CoreComponentTypes\BasicAmountType Sum of tax for all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
$TransactionEntity string Type of transaction to authorize. The only allowable value is Order, which means that the transaction represents a customer order that can be fulfilled over 29 days. Optional
$TransactionID string The value of the order’s transaction identification number returned by a PayPal product. Required Character length and limits: 19 single-byte characters maximum

Public Methods

Method Description
__construct ( $TransactionID = null, $Amount = null ) Constructor with arguments

Method Details

__construct() public method

Constructor with arguments
public __construct ( $TransactionID = null, $Amount = null )

Property Details

$Amount public property

Amount to authorize. Required Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
public BasicAmountType,PayPal\CoreComponentTypes $Amount
return PayPal\CoreComponentTypes\BasicAmountType

$Custom public property

A free-form field for your own use. Optional Character length and limitations: 256 single-byte alphanumeric characters
public string $Custom
return string

$HandlingTotal public property

Total handling costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
public BasicAmountType,PayPal\CoreComponentTypes $HandlingTotal
return PayPal\CoreComponentTypes\BasicAmountType

$IPAddress public property

IP Address of the buyer
public string $IPAddress
return string

$InsuranceTotal public property

Total shipping insurance costs for this order. Optional
public BasicAmountType,PayPal\CoreComponentTypes $InsuranceTotal
return PayPal\CoreComponentTypes\BasicAmountType

$ItemTotal public property

Sum of cost of all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
public BasicAmountType,PayPal\CoreComponentTypes $ItemTotal
return PayPal\CoreComponentTypes\BasicAmountType

$MsgSubID public property

Unique id for each API request to prevent duplicate payments. Optional Character length and limits: 38 single-byte characters maximum.
public string $MsgSubID
return string

$OrderDescription public property

Description of items the customer is purchasing. Optional Character length and limitations: 127 single-byte alphanumeric characters
public string $OrderDescription
return string

$PaymentDetailsItem public property

Information about the individual purchased items
public PaymentDetailsItemType,PayPal\EBLBaseComponents $PaymentDetailsItem
return PayPal\EBLBaseComponents\PaymentDetailsItemType

$ShipToAddress public property

Address the order will be shipped to. Optional
public AddressType,PayPal\EBLBaseComponents $ShipToAddress
return PayPal\EBLBaseComponents\AddressType

$ShippingDiscount public property

Shipping discount for this order, specified as a negative number. Optional
public BasicAmountType,PayPal\CoreComponentTypes $ShippingDiscount
return PayPal\CoreComponentTypes\BasicAmountType

$ShippingTotal public property

Total shipping costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
public BasicAmountType,PayPal\CoreComponentTypes $ShippingTotal
return PayPal\CoreComponentTypes\BasicAmountType

$TaxTotal public property

Sum of tax for all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
public BasicAmountType,PayPal\CoreComponentTypes $TaxTotal
return PayPal\CoreComponentTypes\BasicAmountType

$TransactionEntity public property

Type of transaction to authorize. The only allowable value is Order, which means that the transaction represents a customer order that can be fulfilled over 29 days. Optional
public string $TransactionEntity
return string

$TransactionID public property

The value of the order’s transaction identification number returned by a PayPal product. Required Character length and limits: 19 single-byte characters maximum
public string $TransactionID
return string