Inheritance diagram for Omnipay\PayPal\RestGateway:

Public Member Functions
	authorize (array $parameters=array())

	authorize (array $parameters=array())

	cancelSubscription (array $parameters=array())

	cancelSubscription (array $parameters=array())

	capture (array $parameters=array())

	capture (array $parameters=array())

	completePurchase (array $parameters=array())

	completePurchase (array $parameters=array())

	completeSubscription (array $parameters=array())

	completeSubscription (array $parameters=array())

	createCard (array $parameters=array())

	createCard (array $parameters=array())

	createPlan (array $parameters=array())

	createPlan (array $parameters=array())

	createRequest ($class, array $parameters=array())

	createRequest ($class, array $parameters=array())

	createSubscription (array $parameters=array())

	createSubscription (array $parameters=array())

	createToken ()

	createToken ()

	deleteCard (array $parameters=array())

	deleteCard (array $parameters=array())

	fetchPurchase (array $parameters=array())

	fetchPurchase (array $parameters=array())

	fetchTransaction (array $parameters=array())

	fetchTransaction (array $parameters=array())

	getClientId ()

	getClientId ()

	getDefaultParameters ()

	getDefaultParameters ()

	getName ()

	getName ()

	getSecret ()

	getSecret ()

	getToken ($createIfNeeded=true)

	getToken ($createIfNeeded=true)

	getTokenExpires ()

	getTokenExpires ()

	hasToken ()

	hasToken ()

	listPlan (array $parameters=array())

	listPlan (array $parameters=array())

	listPurchase (array $parameters=array())

	listPurchase (array $parameters=array())

	purchase (array $parameters=array())

	purchase (array $parameters=array())

	reactivateSubscription (array $parameters=array())

	reactivateSubscription (array $parameters=array())

	refund (array $parameters=array())

	refund (array $parameters=array())

	refundCapture (array $parameters=array())

	refundCapture (array $parameters=array())

	searchTransaction (array $parameters=array())

	searchTransaction (array $parameters=array())

	setClientId ($value)

	setClientId ($value)

	setSecret ($value)

	setSecret ($value)

	setToken ($value)

	setToken ($value)

	setTokenExpires ($value)

	setTokenExpires ($value)

	suspendSubscription (array $parameters=array())

	suspendSubscription (array $parameters=array())

	updatePlan (array $parameters=array())

	updatePlan (array $parameters=array())

	void (array $parameters=array())

	void (array $parameters=array())

Public Member Functions inherited from Omnipay\Common\AbstractGateway
	__construct (ClientInterface $httpClient=null, HttpRequest $httpRequest=null)

	__construct (ClientInterface $httpClient=null, HttpRequest $httpRequest=null)

	getCurrency ()

	getCurrency ()

	getParameter ($key)

	getParameter ($key)

	getParameters ()

	getShortName ()

	getShortName ()

	getTestMode ()

	getTestMode ()

	initialize (array $parameters=array())

	initialize (array $parameters=array())

	setCurrency ($value)

	setCurrency ($value)

	setParameter ($key, $value)

	setParameter ($key, $value)

	setTestMode ($value)

	setTestMode ($value)

	supportsAcceptNotification ()

	supportsAcceptNotification ()

	supportsAuthorize ()

	supportsAuthorize ()

	supportsCapture ()

	supportsCapture ()

	supportsCompleteAuthorize ()

	supportsCompleteAuthorize ()

	supportsCompletePurchase ()

	supportsCompletePurchase ()

	supportsCreateCard ()

	supportsCreateCard ()

	supportsDeleteCard ()

	supportsDeleteCard ()

	supportsFetchTransaction ()

	supportsPurchase ()

	supportsPurchase ()

	supportsRefund ()

	supportsRefund ()

	supportsUpdateCard ()

	supportsUpdateCard ()

	supportsVoid ()

	supportsVoid ()

Data Fields
const	BILLING_PLAN_FREQUENCY_DAY = 'DAY'

const	BILLING_PLAN_FREQUENCY_MONTH = 'MONTH'

const	BILLING_PLAN_FREQUENCY_WEEK = 'WEEK'

const	BILLING_PLAN_FREQUENCY_YEAR = 'YEAR'

const	BILLING_PLAN_STATE_ACTIVE = 'ACTIVE'

const	BILLING_PLAN_STATE_CREATED = 'CREATED'

const	BILLING_PLAN_STATE_DELETED = 'DELETED'

const	BILLING_PLAN_STATE_INACTIVE = 'INACTIVE'

const	BILLING_PLAN_TYPE_FIXED = 'FIXED'

const	BILLING_PLAN_TYPE_INFINITE = 'INFINITE'

const	PAYMENT_REGULAR = 'REGULAR'

const	PAYMENT_TRIAL = 'TRIAL'

Data Fields inherited from Omnipay\Common\AbstractGateway
getParameter as	traitGetParameter

Additional Inherited Members
Protected Member Functions inherited from Omnipay\Common\AbstractGateway
	getDefaultHttpClient ()

	getDefaultHttpClient ()

	getDefaultHttpRequest ()

	getDefaultHttpRequest ()

Protected Attributes inherited from Omnipay\Common\AbstractGateway
	$httpClient

	$httpRequest

	$parameters

Detailed Description

PayPal Pro Class using REST API

This class forms the gateway class for PayPal REST requests via the PayPal REST APIs.

The PayPal API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Request and response payloads are formatted as JSON.

The PayPal REST APIs are supported in two environments. Use the Sandbox environment for testing purposes, then move to the live environment for production processing. When testing, generate an access token with your test credentials to make calls to the Sandbox URIs. When you’re set to go live, use the live credentials assigned to your app to generate a new access token to be used with the live URIs.

Test Mode

In order to use this for testing in sandbox mode you will need at least two sandbox test accounts. One will need to be a business account, and one will need to be a personal account with credit card details. To create these you will need to go to the sandbox accounts section of the PayPal developer dashboard, here: https://developer.paypal.com/webapps/developer/applications/accounts On that page click "Create Account" and follow the prompts. When you are creating the Personal account, ensure that it is created with a credit card – either Visa or MasterCard or one of the other types. When you are testing in the sandbox, use the credit card details you will receive for this Personal account rather than any other commonly used test credit card numbers (e.g. visa card 4111111111111111 or 4444333322221111 both of which will result in Error 500 / INTERNAL_SERVICE_ERROR type errors from the PayPal gateway).

With each API call, you’ll need to set request headers, including an OAuth 2.0 access token. Get an access token by using the OAuth 2.0 client_credentials token grant type with your clientId:secret as your Basic Auth credentials. For more information, see Make your first call (link). This class sets all of the headers associated with the API call for you, including making preliminary calls to create or update the OAuth 2.0 access token before each call you make, if required. All you need to do is provide the clientId and secret when you initialize the gateway, or use the set*() calls to set them after creating the gateway object.

Credentials

To create production and sandbox credentials for your PayPal account:

Log into your PayPal account.
Navigate to your Sandbox accounts at https://developer.paypal.com/webapps/developer/applications/accounts to ensure that you have a valid sandbox account to use for testing. If you don't already have a sandbox account, one can be created on this page. You will actually need 2 accounts, a personal account and a business account, the business account is the one you need to use for creating API applications.
Check your account status on https://developer.paypal.com/webapps/developer/account/status to ensure that it is valid for live transactions.
Navigate to the My REST apps page: https://developer.paypal.com/webapps/developer/applications/myapps
Click Create App
On the next page, enter an App name and select the sandbox account to use, then click Create app.
On the next page the sandbox account, endpoint, Client ID and Secret should be displayed. Record these. The Sandbox account should match the one that you selected on the previous page, and the sandbox endpoint should be ai.sandbox.paypal.com
Adjacent to Live credentials click Show to display your live credentials. The endpoint for these should be api.paypal.com, there should also be a Client ID and Secret.

You can create additional REST APIs apps for other websites – because the webhooks are stored per app then it pays to have one API app per website that you are using (and an additional one for things like command line testing, etc).

Example

Initialize Gateway

// Create a gateway for the PayPal RestGateway // (routes to GatewayFactory::create) $gateway = Omnipay::create('PayPal_Rest');

// Initialise the gateway $gateway->initialize(array( 'clientId' => 'MyPayPalClientId', 'secret' => 'MyPayPalSecret', 'testMode' => true, // Or false when you are ready for live transactions ));

Direct Credit Card Payment

// Create a credit card object // DO NOT USE THESE CARD VALUES – substitute your own // see the documentation in the class header. $card = new CreditCard(array( 'firstName' => 'Example', 'lastName' => 'User', 'number' => '4111111111111111', 'expiryMonth' => '01', 'expiryYear' => '2020', 'cvv' => '123', 'billingAddress1' => '1 Scrubby Creek Road', 'billingCountry' => 'AU', 'billingCity' => 'Scrubby Creek', 'billingPostcode' => '4999', 'billingState' => 'QLD', ));

// Do a purchase transaction on the gateway try { $transaction = $gateway->purchase(array( 'amount' => '10.00', 'currency' => 'AUD', 'description' => 'This is a test purchase transaction.', 'card' => $card, )); $response = $transaction->send(); $data = $response->getData(); echo "Gateway purchase response data == " . print_r($data, true) . "\n";

if ($response->isSuccessful()) { echo "Purchase transaction was successful!\n"; } } catch (\Exception $e) { echo "Exception caught while attempting authorize.\n"; echo "Exception type == " . get_class($e) . "\n"; echo "Message == " . $e->getMessage() . "\n"; }

Dashboard

Once you have processed some payments you can go to the PayPal sandbox site, at https://www.sandbox.paypal.com/ and log in with the email address and password of your PayPal sandbox business test account. You will then see the result of those transactions on the "My recent activity" list under the My Account tab.

https://devtools-paypal.com/integrationwizard/ http://paypal.github.io/sdk/ https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/ https://developer.paypal.com/docs/faq/ https://developer.paypal.com/docs/integration/direct/make-your-first-call/ https://developer.paypal.com/docs/integration/web/accept-paypal-payment/ https://developer.paypal.com/docs/api/#authentication–headers Omnipay PayPal Pro Class using REST API This class forms the gateway class for PayPal REST requests via the PayPal REST APIs. The PayPal API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Request and response payloads are formatted as JSON. The PayPal REST APIs are supported in two environments. Use the Sandbox environment for testing purposes, then move to the live environment for production processing. When testing, generate an access token with your test credentials to make calls to the Sandbox URIs. When you’re set to go live, use the live credentials assigned to your app to generate a new access token to be used with the live URIs. autotoc_md119 Test Mode In order to use this for testing in sandbox mode you will need at least two sandbox test accounts. One will need to be a business account, and one will need to be a personal account with credit card details. To create these you will need to go to the sandbox accounts section of the PayPal developer dashboard, here: https://developer.paypal.com/webapps/developer/applications/accounts On that page click "Create Account" and follow the prompts. When you are creating the Personal account, ensure that it is created with a credit card – either Visa or MasterCard or one of the other types. When you are testing in the sandbox, use the credit card details you will receive for this Personal account rather than any other commonly used test credit card numbers (e.g. visa card 4111111111111111 or 4444333322221111 both of which will result in Error 500 / INTERNAL_SERVICE_ERROR type errors from the PayPal gateway). With each API call, you’ll need to set request headers, including an OAuth 2.0 access token. Get an access token by using the OAuth 2.0 client_credentials token grant type with your clientId:secret as your Basic Auth credentials. For more information, see Make your first call (link). This class sets all of the headers associated with the API call for you, including making preliminary calls to create or update the OAuth 2.0 access token before each call you make, if required. All you need to do is provide the clientId and secret when you initialize the gateway, or use the set*() calls to set them after creating the gateway object. autotoc_md120 Credentials To create production and sandbox credentials for your PayPal account: Log into your PayPal account.Navigate to your Sandbox accounts at https://developer.paypal.com/webapps/developer/applications/accounts to ensure that you have a valid sandbox account to use for testing. If you don't already have a sandbox account, one can be created on this page. You will actually need 2 accounts, a personal account and a business account, the business account is the one you need to use for creating API applications.Check your account status on https://developer.paypal.com/webapps/developer/account/status to ensure that it is valid for live transactions.Navigate to the My REST apps page: https://developer.paypal.com/webapps/developer/applications/myappsClick Create AppOn the next page, enter an App name and select the sandbox account to use, then click Create app.On the next page the sandbox account, endpoint, Client ID and Secret should be displayed. Record these. The Sandbox account should match the one that you selected on the previous page, and the sandbox endpoint should be ai.sandbox.paypal.comAdjacent to Live credentials click Show to display your live credentials. The endpoint for these should be api.paypal.com, there should also be a Client ID and Secret. You can create additional REST APIs apps for other websites – because the webhooks are stored per app then it pays to have one API app per website that you are using (and an additional one for things like command line testing, etc). autotoc_md121 Example autotoc_md122 Initialize Gateway // Create a gateway for the PayPal RestGateway // (routes to GatewayFactory::create) $gateway = Omnipay::create('PayPal_Rest'); // Initialise the gateway $gateway->initialize(array( 'clientId' => 'MyPayPalClientId', 'secret' => 'MyPayPalSecret', 'testMode' => true, // Or false when you are ready for live transactions )); autotoc_md123 Direct Credit Card Payment // Create a credit card object // DO NOT USE THESE CARD VALUES – substitute your own // see the documentation in the class header. $card = new CreditCard(array( 'firstName' => 'Example', 'lastName' => 'User', 'number' => '4111111111111111', 'expiryMonth' => '01', 'expiryYear' => '2020', 'cvv' => '123', 'billingAddress1' => '1 Scrubby Creek Road', 'billingCountry' => 'AU', 'billingCity' => 'Scrubby Creek', 'billingPostcode' => '4999', 'billingState' => 'QLD', )); // Do a purchase transaction on the gateway try { $transaction = $gateway->purchase(array( 'amount' => '10.00', 'currency' => 'AUD', 'description' => 'This is a test purchase transaction.', 'card' => $card, )); $response = $transaction->send(); $data = $response->getData(); echo "Gateway purchase response data == " . print_r($data, true) . "\n"; if ($response->isSuccessful()) { echo "Purchase transaction was successful!\n"; } } catch ( $e) { echo "Exception caught while attempting authorize.\n"; echo "Exception type == " . get_class($e) . "\n"; echo "Message == " . $e->getMessage() . "\n"; } autotoc_md124 Dashboard Once you have processed some payments you can go to the PayPal sandbox site, at https://www.sandbox.paypal.com/ and log in with the email address and password of your PayPal sandbox business test account. You will then see the result of those transactions on the "My recent activity" list under the My Account tab. https://developer.paypal.com/docs/api/ https://devtools-paypal.com/integrationwizard/ http://paypal.github.io/sdk/ https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/ https://developer.paypal.com/docs/faq/ https://developer.paypal.com/docs/integration/direct/make-your-first-call/ https://developer.paypal.com/docs/integration/web/accept-paypal-payment/ https://developer.paypal.com/docs/api/#authentication–headers Omnipay

Definition at line 152 of file lib/vendor/omnipay/paypal/src/RestGateway.php.

Member Function Documentation

◆ authorize() [1/2]

Omnipay\PayPal\RestGateway::authorize ( array $parameters = array() )

Create an authorization request.

To collect payment at a later time, first authorize a payment using the /payment resource. You can then capture the payment to complete the sale and collect payment.

https://developer.paypal.com/docs/api/#authorizations array $parameters

Definition at line 439 of file lib/vendor/omnipay/paypal/src/RestGateway.php.

References Omnipay\Common\AbstractGateway\$parameters, and Omnipay\PayPal\RestGateway\createRequest().

◆ authorize() [2/2]

Omnipay\PayPal\RestGateway::authorize ( array $parameters = array() )

Create an authorization request.

To collect payment at a later time, first authorize a payment using the /payment resource. You can then capture the payment to complete the sale and collect payment.

https://developer.paypal.com/docs/api/#authorizations array $parameters

Definition at line 439 of file vendor/omnipay/paypal/src/RestGateway.php.

References Omnipay\Common\AbstractGateway\$parameters, and Omnipay\PayPal\RestGateway\createRequest().

◆ cancelSubscription() [1/2]

Omnipay\PayPal\RestGateway::cancelSubscription ( array $parameters = array() )

Cancel a subscription.

Use this call to cancel an agreement.

Omnipay\PayPal\RestGateway::createRequest	(		$class,
		array	$parameters = `array()`
	)

string	$class
array	$parameters

string	$class
array	$parameters

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Test Mode

Credentials

Example

Initialize Gateway

Direct Credit Card Payment

Dashboard

Member Function Documentation

◆ authorize() [1/2]

◆ authorize() [2/2]

◆ cancelSubscription() [1/2]

◆ cancelSubscription() [2/2]

◆ capture() [1/2]

◆ capture() [2/2]

◆ completePurchase() [1/2]

◆ completePurchase() [2/2]

◆ completeSubscription() [1/2]

◆ completeSubscription() [2/2]

◆ createCard() [1/2]

◆ createCard() [2/2]

◆ createPlan() [1/2]

◆ createPlan() [2/2]

◆ createRequest() [1/2]

◆ createRequest() [2/2]

◆ createSubscription() [1/2]

◆ createSubscription() [2/2]

◆ createToken() [1/2]

◆ createToken() [2/2]

◆ deleteCard() [1/2]

◆ deleteCard() [2/2]

◆ fetchPurchase() [1/2]

◆ fetchPurchase() [2/2]

◆ fetchTransaction() [1/2]

◆ fetchTransaction() [2/2]

◆ getClientId() [1/2]

◆ getClientId() [2/2]

◆ getDefaultParameters() [1/2]

◆ getDefaultParameters() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getSecret() [1/2]

◆ getSecret() [2/2]

◆ getToken() [1/2]

◆ getToken() [2/2]

◆ getTokenExpires() [1/2]

◆ getTokenExpires() [2/2]

◆ hasToken() [1/2]

◆ hasToken() [2/2]

◆ listPlan() [1/2]

◆ listPlan() [2/2]

◆ listPurchase() [1/2]

◆ listPurchase() [2/2]

◆ purchase() [1/2]

◆ purchase() [2/2]

◆ reactivateSubscription() [1/2]

◆ reactivateSubscription() [2/2]

◆ refund() [1/2]

◆ refund() [2/2]

◆ refundCapture() [1/2]

◆ refundCapture() [2/2]

◆ searchTransaction() [1/2]

◆ searchTransaction() [2/2]

◆ setClientId() [1/2]

◆ setClientId() [2/2]

◆ setSecret() [1/2]

◆ setSecret() [2/2]

◆ setToken() [1/2]

◆ setToken() [2/2]

◆ setTokenExpires() [1/2]

◆ setTokenExpires() [2/2]

◆ suspendSubscription() [1/2]

◆ suspendSubscription() [2/2]

◆ updatePlan() [1/2]

◆ updatePlan() [2/2]

◆ void() [1/2]

◆ void() [2/2]

Field Documentation