Inheritance diagram for Omnipay\PayPal\Message\RestCompletePurchaseRequest:

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 ()

Additional Inherited Members
Data Fields inherited from Omnipay\PayPal\Message\AbstractRestRequest
const	API_VERSION = 'v1'

Protected Member Functions inherited from Omnipay\PayPal\Message\AbstractRestRequest
	createResponse ($data, $statusCode)

	createResponse ($data, $statusCode)

	getHttpMethod ()

	getHttpMethod ()

Protected Member Functions inherited from Omnipay\Common\Message\AbstractRequest
	getCurrencies ()

	getParameter ($key)

	setParameter ($key, $value)

	setParameter ($key, $value)

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 Complete Purchase Request

Use this message to execute (complete) a PayPal payment that has been approved by the payer. You can optionally update transaction information when executing the payment by passing in one or more transactions.

This call only works after a buyer has approved the payment using the provided PayPal approval URL.

Example

The payer ID and the payment ID returned from the callback after the purchase will be passed to the return URL as GET parameters payerId and paymentId respectively.

See RestPurchaseRequest for the first part of this example transaction:

$paymentId = $_GET['paymentId']; $payerId = $_GET['payerId'];

// Once the transaction has been approved, we need to complete it. $transaction = $gateway->completePurchase(array( 'payer_id' => $payer_id, 'transactionReference' => $sale_id, )); $response = $transaction->send(); if ($response->isSuccessful()) { // The customer has successfully paid. } else { // There was an error returned by completePurchase(). You should // check the error code and message from PayPal, which may be something // like "card declined", etc. }

See also: RestPurchaseRequest PayPal REST Complete Purchase Request Use this message to execute (complete) a PayPal payment that has been approved by the payer. You can optionally update transaction information when executing the payment by passing in one or more transactions. This call only works after a buyer has approved the payment using the provided PayPal approval URL. autotoc_md67 Example The payer ID and the payment ID returned from the callback after the purchase will be passed to the return URL as GET parameters payerId and paymentId respectively. See RestPurchaseRequest for the first part of this example transaction: $paymentId = $_GET['paymentId']; $payerId = $_GET['payerId']; // Once the transaction has been approved, we need to complete it. $transaction = $gateway->completePurchase(array( 'payer_id' => $payerId, 'transactionReference' => $paymentId, )); $response = $transaction->send(); if ($response->isSuccessful()) { // The customer has successfully paid. } else { // There was an error returned by completePurchase(). You should // check the error code and message from PayPal, which may be something // like "card declined", etc. } RestPurchaseRequest https://developer.paypal.com/docs/api/#execute-an-approved-paypal-payment

Definition at line 48 of file lib/vendor/omnipay/paypal/src/Message/RestCompletePurchaseRequest.php.

Member Function Documentation

◆ getData() [1/2]

Omnipay\PayPal\Message\RestCompletePurchaseRequest::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 56 of file lib/vendor/omnipay/paypal/src/Message/RestCompletePurchaseRequest.php.

References Omnipay\PayPal\Message\AbstractRestRequest\getPayerId(), and Omnipay\Common\Message\AbstractRequest\validate().

◆ getData() [2/2]

Omnipay\PayPal\Message\RestCompletePurchaseRequest::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.