PHP Class PayPal\EBLBaseComponents\MerchantPullPaymentType

Inheritance: extends PayPal\Core\PPXmlMessage
Show file Open project: paypal/merchant-sdk-php

Public Properties

Property Type Description
$Amount PayPal\CoreComponentTypes\BasicAmountType The amount to charge to the customer. Required Only numeric characters and a decimal separator are allowed. Limit: 10 single-byte characters, including two for decimals You must set the currencyID attribute to one of the three-character currency code for any of the supported PayPal currencies.
$ButtonSource string An identification code for use by third-party applications to identify transactions. Optional Character length and limitations: 32 single-byte alphanumeric characters
$Custom string Custom annotation field for tracking or other use Optional
$EmailSubject string Subject line of confirmation email sent to recipient Optional
$Handling PayPal\CoreComponentTypes\BasicAmountType Per-transaction handling charge Optional
$Invoice string Your invoice number Optional
$ItemName string Name of purchased item Optional
$ItemNumber string Reference number of purchased item Optional
$Memo string Text entered by the customer in the Note field during enrollment Optional
$MpID string Preapproved Payments billing agreement identification number between the PayPal customer and you. Required Character limit: 19 single-byte alphanumeric characters. The format of a billing agreement identification number is the single-character prefix B, followed by a hyphen and an alphanumeric character string: B-unique_alphanumeric_string
$PaymentType string Specifies type of PayPal payment you require Optional
$Shipping PayPal\CoreComponentTypes\BasicAmountType Per-transaction shipping charge Optional
$SoftDescriptor string Passed in soft descriptor string to be appended. Optional Character length and limitations: single-byte alphanumeric characters
$Tax PayPal\CoreComponentTypes\BasicAmountType The tax charged on the transaction Optional

Property Details

$Amount public property

The amount to charge to the customer. Required Only numeric characters and a decimal separator are allowed. Limit: 10 single-byte characters, including two for decimals You must set the currencyID attribute to one of the three-character currency code for any of the supported PayPal currencies.
public BasicAmountType,PayPal\CoreComponentTypes $Amount
return PayPal\CoreComponentTypes\BasicAmountType

$ButtonSource public property

An identification code for use by third-party applications to identify transactions. Optional Character length and limitations: 32 single-byte alphanumeric characters
public string $ButtonSource
return string

$Custom public property

Custom annotation field for tracking or other use Optional
public string $Custom
return string

$EmailSubject public property

Subject line of confirmation email sent to recipient Optional
public string $EmailSubject
return string

$Handling public property

Per-transaction handling charge Optional
public BasicAmountType,PayPal\CoreComponentTypes $Handling
return PayPal\CoreComponentTypes\BasicAmountType

$Invoice public property

Your invoice number Optional
public string $Invoice
return string

$ItemName public property

Name of purchased item Optional
public string $ItemName
return string

$ItemNumber public property

Reference number of purchased item Optional
public string $ItemNumber
return string

$Memo public property

Text entered by the customer in the Note field during enrollment Optional
public string $Memo
return string

$MpID public property

Preapproved Payments billing agreement identification number between the PayPal customer and you. Required Character limit: 19 single-byte alphanumeric characters. The format of a billing agreement identification number is the single-character prefix B, followed by a hyphen and an alphanumeric character string: B-unique_alphanumeric_string
public string $MpID
return string

$PaymentType public property

Specifies type of PayPal payment you require Optional
public string $PaymentType
return string

$Shipping public property

Per-transaction shipping charge Optional
public BasicAmountType,PayPal\CoreComponentTypes $Shipping
return PayPal\CoreComponentTypes\BasicAmountType

$SoftDescriptor public property

Passed in soft descriptor string to be appended. Optional Character length and limitations: single-byte alphanumeric characters
public string $SoftDescriptor
return string

$Tax public property

The tax charged on the transaction Optional
public BasicAmountType,PayPal\CoreComponentTypes $Tax
return PayPal\CoreComponentTypes\BasicAmountType