PHP Class PayPal\PayPalAPI\DoCaptureRequestType

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

Public Properties

Property Type Description
$Amount PayPal\CoreComponentTypes\BasicAmountType Amount to authorize. You must set the currencyID attribute to USD. 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 (,)
$AuthorizationID string The authorization identification number of the payment you want to capture. Required Character length and limits: 19 single-byte characters maximum
$CompleteType string Indicates if this capture is the last capture you intend to make. The default is Complete. If CompleteType is Complete, any remaining amount of the original reauthorized transaction is automatically voided. Required Character length and limits: 12 single-byte alphanumeric characters
$Descriptor string dynamic descriptor Dynamic descriptor is used for merchant to provide detail of a transaction appears on statement Optional Character length and limits: <18 characters alphanumeric characters
$EnhancedData PayPal\EBLBaseComponents\EnhancedDataType Not Required
$InvoiceID string Your invoice number or other identification number. The InvoiceID value is recorded only if the authorization you are capturing is an order authorization, not a basic authorization. Optional Character length and limits: 127 single-byte alphanumeric characters
$MerchantData PayPal\EBLBaseComponents\MerchantDataType This holds key-value pair which merchants wants to pass it to the open wallet-PLCC processorOptional
$MerchantStoreDetails PayPal\EBLBaseComponents\MerchantStoreDetailsType To pass the Merchant store informationOptional
$MsgSubID string Unique id for each API request to prevent duplicate payments. Optional Character length and limits: 38 single-byte characters maximum.
$Note string Optional Character length and limits: 255 single-byte characters

Public Methods

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

Method Details

__construct() public method

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

Property Details

$Amount public_oe property

Amount to authorize. You must set the currencyID attribute to USD. 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

$AuthorizationID public_oe property

The authorization identification number of the payment you want to capture. Required Character length and limits: 19 single-byte characters maximum
public string $AuthorizationID
return string

$CompleteType public_oe property

Indicates if this capture is the last capture you intend to make. The default is Complete. If CompleteType is Complete, any remaining amount of the original reauthorized transaction is automatically voided. Required Character length and limits: 12 single-byte alphanumeric characters
public string $CompleteType
return string

$Descriptor public_oe property

dynamic descriptor Dynamic descriptor is used for merchant to provide detail of a transaction appears on statement Optional Character length and limits: <18 characters alphanumeric characters
public string $Descriptor
return string

$EnhancedData public_oe property

Not Required
public EnhancedDataType,PayPal\EBLBaseComponents $EnhancedData
return PayPal\EBLBaseComponents\EnhancedDataType

$InvoiceID public_oe property

Your invoice number or other identification number. The InvoiceID value is recorded only if the authorization you are capturing is an order authorization, not a basic authorization. Optional Character length and limits: 127 single-byte alphanumeric characters
public string $InvoiceID
return string

$MerchantData public_oe property

This holds key-value pair which merchants wants to pass it to the open wallet-PLCC processorOptional
public MerchantDataType,PayPal\EBLBaseComponents $MerchantData
return PayPal\EBLBaseComponents\MerchantDataType

$MerchantStoreDetails public_oe property

To pass the Merchant store informationOptional
public MerchantStoreDetailsType,PayPal\EBLBaseComponents $MerchantStoreDetails
return PayPal\EBLBaseComponents\MerchantStoreDetailsType

$MsgSubID public_oe 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

$Note public_oe property

Optional Character length and limits: 255 single-byte characters
public string $Note
return string