Open Journal Systems  3.3.0
Omnipay\PayPal\Message\RestFetchPurchaseRequest Class Reference
Inheritance diagram for Omnipay\PayPal\Message\RestFetchPurchaseRequest:
Omnipay\PayPal\Message\AbstractRestRequest Omnipay\Common\Message\AbstractRequest Omnipay\Common\Message\RequestInterface Omnipay\Common\Message\MessageInterface

Public Member Functions

 getData ()
 
 getData ()
 
 getEndpoint ()
 
 getEndpoint ()
 
- Public Member Functions inherited from Omnipay\PayPal\Message\AbstractRestRequest
 getClientId ()
 
 getClientId ()
 
 getPayerId ()
 
 getPayerId ()
 
 getSecret ()
 
 getSecret ()
 
 getToken ()
 
 getToken ()
 
 sendData ($data)
 
 sendData ($data)
 
 setClientId ($value)
 
 setClientId ($value)
 
 setPayerId ($value)
 
 setPayerId ($value)
 
 setSecret ($value)
 
 setSecret ($value)
 
 setToken ($value)
 
 setToken ($value)
 
 toJSON ($data, $options=0)
 
 toJSON ($data, $options=0)
 
- 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 ()
 
 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)
 
 setItems ($items)
 
 setItems ($items)
 
 setMoney (Money $value)
 
 setNotifyUrl ($value)
 
 setNotifyUrl ($value)
 
 setPaymentMethod ($value)
 
 setPaymentMethod ($value)
 
 setReturnUrl ($value)
 
 setReturnUrl ($value)
 
 setTestMode ($value)
 
 setTestMode ($value)
 
 setTransactionId ($value)
 
 setTransactionId ($value)
 
 setTransactionReference ($value)
 
 setTransactionReference ($value)
 
 toFloat ($value)
 
 validate ()
 

Protected Member Functions

 getHttpMethod ()
 
 getHttpMethod ()
 
- Protected Member Functions inherited from Omnipay\PayPal\Message\AbstractRestRequest
 createResponse ($data, $statusCode)
 
 createResponse ($data, $statusCode)
 
- Protected Member Functions inherited from Omnipay\Common\Message\AbstractRequest
 getCurrencies ()
 
 getParameter ($key)
 
 setParameter ($key, $value)
 
 setParameter ($key, $value)
 

Additional Inherited Members

- Data Fields inherited from Omnipay\PayPal\Message\AbstractRestRequest
const API_VERSION = 'v1'
 
- Protected Attributes inherited from Omnipay\PayPal\Message\AbstractRestRequest
 $liveEndpoint = 'https://api.paypal.com'
 
 $payerId = null
 
 $testEndpoint = 'https://api.sandbox.paypal.com'
 
- Protected Attributes inherited from Omnipay\Common\Message\AbstractRequest
 $currencies
 
 $httpClient
 
 $httpRequest
 
 $negativeAmountAllowed = false
 
 $parameters
 
 $response
 
 $zeroAmountAllowed = true
 

Detailed Description

PayPal REST Fetch Purchase Request

Use this call to get details about payments that have not completed, such as payments that are created and approved, or if a payment has failed.

Example

See RestPurchaseRequest for the first part of this example transaction:

// Fetch the transaction so that details can be found for refund, etc. $transaction = $gateway->fetchPurchase(); $transaction->setTransactionReference($sale_id); $response = $transaction->send(); $data = $response->getData(); echo "Gateway fetchTransaction response data == " . print_r($data, true) . "\n";

See also
RestPurchaseRequest PayPal REST Fetch Purchase Request Use this call to get details about payments that have not completed, such as payments that are created and approved, or if a payment has failed. autotoc_md90 Example See RestPurchaseRequest for the first part of this example transaction: // Fetch the transaction so that details can be found for refund, etc. $transaction = $gateway->fetchPurchase(); $transaction->setTransactionReference($sale_id); $response = $transaction->send(); $data = $response->getData(); echo "Gateway fetchTransaction response data == " . print_r($data, true) . "\n"; RestPurchaseRequest https://developer.paypal.com/docs/api/#look-up-a-payment-resource

Definition at line 30 of file lib/vendor/omnipay/paypal/src/Message/RestFetchPurchaseRequest.php.

Member Function Documentation

◆ getData() [1/2]

Omnipay\PayPal\Message\RestFetchPurchaseRequest::getData ( )

Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement.

Returns
mixed

Implements Omnipay\Common\Message\MessageInterface.

Definition at line 32 of file lib/vendor/omnipay/paypal/src/Message/RestFetchPurchaseRequest.php.

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

◆ getData() [2/2]

Omnipay\PayPal\Message\RestFetchPurchaseRequest::getData ( )

Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement.

Returns
mixed

Implements Omnipay\Common\Message\MessageInterface.

Definition at line 32 of file vendor/omnipay/paypal/src/Message/RestFetchPurchaseRequest.php.

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

◆ getEndpoint() [1/2]

Omnipay\PayPal\Message\RestFetchPurchaseRequest::getEndpoint ( )

◆ getEndpoint() [2/2]

Omnipay\PayPal\Message\RestFetchPurchaseRequest::getEndpoint ( )

◆ getHttpMethod() [1/2]

Omnipay\PayPal\Message\RestFetchPurchaseRequest::getHttpMethod ( )
protected

Get HTTP Method.

The HTTP method for fetchTransaction requests must be GET. Using POST results in an error 500 from PayPal.

Returns
string

Reimplemented from Omnipay\PayPal\Message\AbstractRestRequest.

Definition at line 46 of file lib/vendor/omnipay/paypal/src/Message/RestFetchPurchaseRequest.php.

◆ getHttpMethod() [2/2]

Omnipay\PayPal\Message\RestFetchPurchaseRequest::getHttpMethod ( )
protected

Get HTTP Method.

The HTTP method for fetchTransaction requests must be GET. Using POST results in an error 500 from PayPal.

Returns
string

Reimplemented from Omnipay\PayPal\Message\AbstractRestRequest.

Definition at line 46 of file vendor/omnipay/paypal/src/Message/RestFetchPurchaseRequest.php.


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