Open Journal Systems  3.3.0
Omnipay\PayPal\Message\AbstractRequest Class Reference
Inheritance diagram for Omnipay\PayPal\Message\AbstractRequest:
Omnipay\Common\Message\AbstractRequest Omnipay\Common\Message\RequestInterface Omnipay\Common\Message\MessageInterface Omnipay\PayPal\Message\CaptureRequest Omnipay\PayPal\Message\ExpressAuthorizeRequest Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest Omnipay\PayPal\Message\ExpressFetchCheckoutRequest Omnipay\PayPal\Message\ExpressTransactionSearchRequest Omnipay\PayPal\Message\ExpressVoidRequest Omnipay\PayPal\Message\FetchTransactionRequest Omnipay\PayPal\Message\ProAuthorizeRequest Omnipay\PayPal\Message\RefundRequest

Public Member Functions

 getAddressOverride ()
 
 getAddressOverride ()
 
 getAllowNote ()
 
 getAllowNote ()
 
 getBorderColor ()
 
 getBorderColor ()
 
 getBrandName ()
 
 getBrandName ()
 
 getButtonSource ()
 
 getButtonSource ()
 
 getCustomerServiceNumber ()
 
 getCustomerServiceNumber ()
 
 getHandlingAmount ()
 
 getHandlingAmount ()
 
 getHeaderImageUrl ()
 
 getHeaderImageUrl ()
 
 getInsuranceAmount ()
 
 getInsuranceAmount ()
 
 getLandingPage ()
 
 getLandingPage ()
 
 getLocaleCode ()
 
 getLocaleCode ()
 
 getLogoImageUrl ()
 
 getLogoImageUrl ()
 
 getMaxAmount ()
 
 getMaxAmount ()
 
 getNoShipping ()
 
 getNoShipping ()
 
 getPassword ()
 
 getPassword ()
 
 getSellerPaypalAccountId ()
 
 getSellerPaypalAccountId ()
 
 getShippingAmount ()
 
 getShippingAmount ()
 
 getShippingDiscount ()
 
 getShippingDiscount ()
 
 getSignature ()
 
 getSignature ()
 
 getSolutionType ()
 
 getSolutionType ()
 
 getSubject ()
 
 getSubject ()
 
 getTaxAmount ()
 
 getTaxAmount ()
 
 getUsername ()
 
 getUsername ()
 
 sendData ($data)
 
 sendData ($data)
 
 setAddressOverride ($value)
 
 setAddressOverride ($value)
 
 setAllowNote ($value)
 
 setAllowNote ($value)
 
 setBorderColor ($value)
 
 setBorderColor ($value)
 
 setBrandName ($value)
 
 setBrandName ($value)
 
 setButtonSource ($value)
 
 setButtonSource ($value)
 
 setCustomerServiceNumber ($value)
 
 setCustomerServiceNumber ($value)
 
 setHandlingAmount ($value)
 
 setHandlingAmount ($value)
 
 setHeaderImageUrl ($value)
 
 setHeaderImageUrl ($value)
 
 setInsuranceAmount ($value)
 
 setInsuranceAmount ($value)
 
 setItems ($items)
 
 setItems ($items)
 
 setLandingPage ($value)
 
 setLandingPage ($value)
 
 setLocaleCode ($value)
 
 setLocaleCode ($value)
 
 setLogoImageUrl ($value)
 
 setLogoImageUrl ($value)
 
 setMaxAmount ($value)
 
 setMaxAmount ($value)
 
 setNoShipping ($value)
 
 setNoShipping ($value)
 
 setPassword ($value)
 
 setPassword ($value)
 
 setSellerPaypalAccountId ($value)
 
 setSellerPaypalAccountId ($value)
 
 setShippingAmount ($value)
 
 setShippingAmount ($value)
 
 setShippingDiscount ($value)
 
 setShippingDiscount ($value)
 
 setSignature ($value)
 
 setSignature ($value)
 
 setSolutionType ($value)
 
 setSolutionType ($value)
 
 setSubject ($value)
 
 setSubject ($value)
 
 setTaxAmount ($value)
 
 setTaxAmount ($value)
 
 setUsername ($value)
 
 setUsername ($value)
 
- Public Member Functions inherited from Omnipay\Common\Message\AbstractRequest
 __construct (ClientInterface $httpClient, HttpRequest $httpRequest)
 
 __construct (ClientInterface $httpClient, HttpRequest $httpRequest)
 
 formatCurrency ($amount)
 
 formatCurrency ($amount)
 
 getAmount ()
 
 getAmount ()
 
 getAmountInteger ()
 
 getAmountInteger ()
 
 getCancelUrl ()
 
 getCancelUrl ()
 
 getCard ()
 
 getCard ()
 
 getCardReference ()
 
 getCardReference ()
 
 getClientIp ()
 
 getClientIp ()
 
 getCurrency ()
 
 getCurrency ()
 
 getCurrencyDecimalPlaces ()
 
 getCurrencyDecimalPlaces ()
 
 getCurrencyNumeric ()
 
 getCurrencyNumeric ()
 
 getDescription ()
 
 getDescription ()
 
 getIssuer ()
 
 getIssuer ()
 
 getItems ()
 
 getItems ()
 
 getNotifyUrl ()
 
 getNotifyUrl ()
 
 getParameters ()
 
 getPaymentMethod ()
 
 getPaymentMethod ()
 
 getResponse ()
 
 getResponse ()
 
 getReturnUrl ()
 
 getReturnUrl ()
 
 getTestMode ()
 
 getTestMode ()
 
 getToken ()
 
 getToken ()
 
 getTransactionId ()
 
 getTransactionId ()
 
 getTransactionReference ()
 
 getTransactionReference ()
 
 initialize (array $parameters=array())
 
 initialize (array $parameters=array())
 
 send ()
 
 send ()
 
 setAmount ($value)
 
 setAmount ($value)
 
 setAmountInteger ($value)
 
 setCancelUrl ($value)
 
 setCancelUrl ($value)
 
 setCard ($value)
 
 setCard ($value)
 
 setCardReference ($value)
 
 setCardReference ($value)
 
 setClientIp ($value)
 
 setClientIp ($value)
 
 setCurrency ($value)
 
 setCurrency ($value)
 
 setDescription ($value)
 
 setDescription ($value)
 
 setIssuer ($value)
 
 setIssuer ($value)
 
 setMoney (Money $value)
 
 setNotifyUrl ($value)
 
 setNotifyUrl ($value)
 
 setPaymentMethod ($value)
 
 setPaymentMethod ($value)
 
 setReturnUrl ($value)
 
 setReturnUrl ($value)
 
 setTestMode ($value)
 
 setTestMode ($value)
 
 setToken ($value)
 
 setToken ($value)
 
 setTransactionId ($value)
 
 setTransactionId ($value)
 
 setTransactionReference ($value)
 
 setTransactionReference ($value)
 
 toFloat ($value)
 
 validate ()
 
- Public Member Functions inherited from Omnipay\Common\Message\MessageInterface
 getData ()
 
 getData ()
 

Data Fields

const API_VERSION = '119.0'
 

Protected Member Functions

 createResponse ($data)
 
 createResponse ($data)
 
 getBaseData ()
 
 getBaseData ()
 
 getEndpoint ()
 
 getEndpoint ()
 
 getItemData ()
 
 getItemData ()
 
- Protected Member Functions inherited from Omnipay\Common\Message\AbstractRequest
 getCurrencies ()
 
 getParameter ($key)
 
 setParameter ($key, $value)
 
 setParameter ($key, $value)
 

Protected Attributes

 $liveEndpoint = 'https://api-3t.paypal.com/nvp'
 
 $negativeAmountAllowed = true
 
 $testEndpoint = 'https://api-3t.sandbox.paypal.com/nvp'
 
- Protected Attributes inherited from Omnipay\Common\Message\AbstractRequest
 $currencies
 
 $httpClient
 
 $httpRequest
 
 $negativeAmountAllowed = false
 
 $parameters
 
 $response
 
 $zeroAmountAllowed = true
 

Detailed Description

PayPal Abstract Request

This class forms the base class for PayPal Express Checkout and Pro Checkout requests. These are also known as "Payflow Gateway" requests and also "PayPal Classic APIs".

According to the PayPal documentation:

  • This is the recommended way to integrate when you want to accept payments with a completely customizable solution. This integration method leverages the PayPal Payflow Gateway to transmit payments your PayPal Internet Merchant Account; it also gives the merchant the flexibility to change payment processors without having to re-do their technical integration. When using PayPal Payments Pro (Payflow Edition) using Payflow Gateway integration, merchants can use Transparent Redirect feature to help manage PCI compliance.

https://developer.paypal.com/docs/classic/express-checkout/gs_expresscheckout/ https://developer.paypal.com/docs/classic/products/ppp-payflow-edition/ https://devtools-paypal.com/integrationwizard/ http://paypal.github.io/sdk/

Definition at line 35 of file lib/vendor/omnipay/paypal/src/Message/AbstractRequest.php.

Member Function Documentation

◆ createResponse() [1/2]

◆ createResponse() [2/2]

◆ getAddressOverride() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getAddressOverride ( )

◆ getAddressOverride() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getAddressOverride ( )

◆ getAllowNote() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getAllowNote ( )

◆ getAllowNote() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getAllowNote ( )

◆ getBaseData() [1/2]

◆ getBaseData() [2/2]

◆ getBorderColor() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getBorderColor ( )

◆ getBorderColor() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getBorderColor ( )

◆ getBrandName() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getBrandName ( )

◆ getBrandName() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getBrandName ( )

◆ getButtonSource() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getButtonSource ( )

◆ getButtonSource() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getButtonSource ( )

◆ getCustomerServiceNumber() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getCustomerServiceNumber ( )

◆ getCustomerServiceNumber() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getCustomerServiceNumber ( )

◆ getEndpoint() [1/2]

◆ getEndpoint() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getEndpoint ( )
protected

◆ getHandlingAmount() [1/2]

◆ getHandlingAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getHandlingAmount ( )

◆ getHeaderImageUrl() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getHeaderImageUrl ( )

◆ getHeaderImageUrl() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getHeaderImageUrl ( )

◆ getInsuranceAmount() [1/2]

◆ getInsuranceAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getInsuranceAmount ( )

◆ getItemData() [1/2]

◆ getItemData() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getItemData ( )
protected

◆ getLandingPage() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getLandingPage ( )

◆ getLandingPage() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getLandingPage ( )

◆ getLocaleCode() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getLocaleCode ( )

◆ getLocaleCode() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getLocaleCode ( )

◆ getLogoImageUrl() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getLogoImageUrl ( )

◆ getLogoImageUrl() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getLogoImageUrl ( )

◆ getMaxAmount() [1/2]

◆ getMaxAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getMaxAmount ( )

◆ getNoShipping() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getNoShipping ( )

◆ getNoShipping() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getNoShipping ( )

◆ getPassword() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getPassword ( )

◆ getPassword() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getPassword ( )

◆ getSellerPaypalAccountId() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getSellerPaypalAccountId ( )

◆ getSellerPaypalAccountId() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getSellerPaypalAccountId ( )

◆ getShippingAmount() [1/2]

◆ getShippingAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getShippingAmount ( )

◆ getShippingDiscount() [1/2]

◆ getShippingDiscount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getShippingDiscount ( )

◆ getSignature() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getSignature ( )

◆ getSignature() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getSignature ( )

◆ getSolutionType() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getSolutionType ( )

◆ getSolutionType() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getSolutionType ( )

◆ getSubject() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getSubject ( )

◆ getSubject() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getSubject ( )

◆ getTaxAmount() [1/2]

◆ getTaxAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getTaxAmount ( )

◆ getUsername() [1/2]

Omnipay\PayPal\Message\AbstractRequest::getUsername ( )

◆ getUsername() [2/2]

Omnipay\PayPal\Message\AbstractRequest::getUsername ( )

◆ sendData() [1/2]

Omnipay\PayPal\Message\AbstractRequest::sendData (   $data)

◆ sendData() [2/2]

Omnipay\PayPal\Message\AbstractRequest::sendData (   $data)

Send the request with specified data

Parameters
mixed$dataThe data to send
Returns
ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

Definition at line 329 of file vendor/omnipay/paypal/src/Message/AbstractRequest.php.

References Omnipay\PayPal\Message\AbstractRequest\createResponse(), and Omnipay\PayPal\Message\AbstractRequest\getEndpoint().

◆ setAddressOverride() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setAddressOverride (   $value)

◆ setAddressOverride() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setAddressOverride (   $value)

◆ setAllowNote() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setAllowNote (   $value)

◆ setAllowNote() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setAllowNote (   $value)

◆ setBorderColor() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setBorderColor (   $value)

◆ setBorderColor() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setBorderColor (   $value)

◆ setBrandName() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setBrandName (   $value)

◆ setBrandName() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setBrandName (   $value)

◆ setButtonSource() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setButtonSource (   $value)

The Button Source (BN Code) is for PayPal Partners taking payments for a 3rd party

Definition at line 272 of file lib/vendor/omnipay/paypal/src/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setButtonSource() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setButtonSource (   $value)

The Button Source (BN Code) is for PayPal Partners taking payments for a 3rd party

Definition at line 280 of file vendor/omnipay/paypal/src/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCustomerServiceNumber() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setCustomerServiceNumber (   $value)

◆ setCustomerServiceNumber() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setCustomerServiceNumber (   $value)

◆ setHandlingAmount() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setHandlingAmount (   $value)

◆ setHandlingAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setHandlingAmount (   $value)

◆ setHeaderImageUrl() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setHeaderImageUrl (   $value)

◆ setHeaderImageUrl() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setHeaderImageUrl (   $value)

◆ setInsuranceAmount() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setInsuranceAmount (   $value)

◆ setInsuranceAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setInsuranceAmount (   $value)

◆ setItems() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setItems (   $items)

Set the items in this order

Parameters
ItemBag | array$itemsAn array of items in this order

Reimplemented from Omnipay\Common\Message\AbstractRequest.

Definition at line 345 of file lib/vendor/omnipay/paypal/src/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setItems() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setItems (   $items)

Set the items in this order

Parameters
ItemBag | array$itemsAn array of items in this order

Reimplemented from Omnipay\Common\Message\AbstractRequest.

Definition at line 351 of file vendor/omnipay/paypal/src/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setLandingPage() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setLandingPage (   $value)

◆ setLandingPage() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setLandingPage (   $value)

◆ setLocaleCode() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setLocaleCode (   $value)

◆ setLocaleCode() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setLocaleCode (   $value)

◆ setLogoImageUrl() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setLogoImageUrl (   $value)

◆ setLogoImageUrl() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setLogoImageUrl (   $value)

◆ setMaxAmount() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setMaxAmount (   $value)

◆ setMaxAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setMaxAmount (   $value)

◆ setNoShipping() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setNoShipping (   $value)

◆ setNoShipping() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setNoShipping (   $value)

◆ setPassword() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setPassword (   $value)

◆ setPassword() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setPassword (   $value)

◆ setSellerPaypalAccountId() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setSellerPaypalAccountId (   $value)

◆ setSellerPaypalAccountId() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setSellerPaypalAccountId (   $value)

◆ setShippingAmount() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setShippingAmount (   $value)

◆ setShippingAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setShippingAmount (   $value)

◆ setShippingDiscount() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setShippingDiscount (   $value)

◆ setShippingDiscount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setShippingDiscount (   $value)

◆ setSignature() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setSignature (   $value)

◆ setSignature() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setSignature (   $value)

◆ setSolutionType() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setSolutionType (   $value)

◆ setSolutionType() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setSolutionType (   $value)

◆ setSubject() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setSubject (   $value)

◆ setSubject() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setSubject (   $value)

◆ setTaxAmount() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setTaxAmount (   $value)

◆ setTaxAmount() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setTaxAmount (   $value)

◆ setUsername() [1/2]

Omnipay\PayPal\Message\AbstractRequest::setUsername (   $value)

◆ setUsername() [2/2]

Omnipay\PayPal\Message\AbstractRequest::setUsername (   $value)

Field Documentation

◆ $liveEndpoint

Omnipay\PayPal\Message\AbstractRequest::$liveEndpoint = 'https://api-3t.paypal.com/nvp'
protected

◆ $negativeAmountAllowed

bool Omnipay\PayPal\Message\AbstractRequest::$negativeAmountAllowed = true
protected

◆ $testEndpoint

Omnipay\PayPal\Message\AbstractRequest::$testEndpoint = 'https://api-3t.sandbox.paypal.com/nvp'
protected

◆ API_VERSION


The documentation for this class was generated from the following file: