paygw_paypal\paypal_helper Class Reference

Public Member Functions
	__construct (string $clientid, string $secret, bool $sandbox)
	helper constructor.
	capture_authorization (string $authorizationid, float $amount, string $currency, bool $final=true)
	Captures an authorized payment, by ID.
	capture_order (string $orderid)
	Captures order details from PayPal.
	get_order_details (string $orderid)

Public Attributes
string const	CAPTURE_STATUS_COMPLETED = 'COMPLETED'
	The payment was authorized or the authorized payment was captured for the order.
string const	ORDER_INTENT_CAPTURE = 'CAPTURE'
	The merchant intends to capture payment immediately after the customer makes a payment.
string const	ORDER_STATUS_APPROVED = 'APPROVED'
	The customer approved the payment.

Constructor & Destructor Documentation

__construct()

paygw_paypal\paypal_helper::__construct	(	string	$clientid,
		string	$secret,
		bool	$sandbox )

helper constructor.

Parameters

string	$clientid	The client id.
string	$secret	PayPal secret.
bool	$sandbox	Whether we are working with the sandbox environment or not.

Member Function Documentation

capture_authorization()

paygw_paypal\paypal_helper::capture_authorization	(	string	$authorizationid,
		float	$amount,
		string	$currency,
		bool	$final = true )

Captures an authorized payment, by ID.

Parameters

string	$authorizationid	The PayPal-generated ID for the authorized payment to capture.
float	$amount	The amount to capture.
string	$currency	The currency code for the amount.
bool	$final	Indicates whether this is the final captures against the authorized payment.

Return values

array|null

Formatted API response.

capture_order()

paygw_paypal\paypal_helper::capture_order

(

string

$orderid

)

Captures order details from PayPal.

Parameters

string

$orderid

The order we want to capture.

Return values

array|null

Formatted API response.

---

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

• payment/gateway/paypal/classes/paypal_helper.php