laravel-paypal

The package does not require Laravel. You can use it in any PHP project by instantiating the PayPal service and passing your credentials directly using setApiCredentials().

use Srmklive\
PayPal\Services\PayPal as PayPalClient;

$provider = new PayPalClient;

$provider->setApiCredentials([
    'mode' => 'sandbox', // or 'live'
    'sandbox' => [
        'client_id'     => 'YOUR_SANDBOX_CLIENT_ID',
        'client_secret' => 'YOUR_SANDBOX_CLIENT_SECRET',
        'app_id'        => 'APP-80W284485P519543T',
    ],
    'live' => [
        'client_id'     => 'YOUR_LIVE_CLIENT_ID',
        'client_secret' => 'YOUR_LIVE_CLIENT_SECRET',
        'app_id'        => 'YOUR_LIVE_APP_ID',
    ],
    'payment_action' => 'Sale',
    'currency'       => 'USD',
    'notify_url'     => '',
    'locale'         => 'en_US',
    'validate_ssl'   => true,
]);

$provider->getAccessToken();

// API methods are now available
$order = $provider->createOrder([...]);

The library provides two ways to verify PayPal webhooks:

1. API Roundtrip (verifyWebHook): Sends the payload and headers to PayPal to verify the signature. Best for maximum security.
2. Local Verification (verifyWebHookLocally): Performs an offline RSA-SHA256 check using the signing certificate fetched from PayPal's PAYPAL-CERT-URL. This is faster and suitable for high-volume environments. Note that the request body must be the raw, unmodified bytes.

Once verified, use the WebhookEvent class to parse the raw body and route events by type.

// Verify locally (offline)
$valid = $provider->verifyWebHookLocally(
    $request->headers->all(),
    'your-webhook-id',
    $request->getContent(), // must be the raw body bytes
);

// Handling events
use Srmklive\PayPal\Events\WebhookEvent;

$rawBody = $request->getContent();
if ($provider->verifyWebHookLocally($request->headers->all(), 'your-webhook-id', $rawBody)) {
    $event = WebhookEvent::fromRawBody($rawBody);

    if ($event->is('PAYMENT.CAPTURE.COMPLETED')) {
        $this->handleCapture($event->resource);
    }
}

Use MockPayPalClient to write unit tests without making real network calls to the PayPal sandbox.

Basic Usage:

1. Instantiate MockPayPalClient.
2. Queue responses using addResponse($body, $status_code). If an operation returns an empty body (like a 204), pass false as the body.
3. Use mockProvider() to get a pre-configured PayPal instance.

Advanced Mocking:

• Multiple Responses: Queue multiple responses; they are consumed sequentially per API call.
• Inspecting Requests: Use lastRequest() to get the Psr\Http\Message\RequestInterface object to assert on headers, methods, or URIs. Use requests() to see all captured requests.
• Injecting into existing providers: If you have an existing provider, use $provider->setClient($mock) to inject the mock client.

use Srmklive//PayPal//Testing//MockPayPalClient;

$mock = new MockPayPalClient();
$mock->addResponse(['id' => '5O190127TN364715T', 'status' => 'CREATED']);

// mockProvider() returns a ready PayPal instance
$provider = $mock->mockProvider();
$order = $provider->createOrder($data);

expect($order['id'])->toBe('5O190127TN364715T');

// Inspecting the request
$request = $mock->lastRequest();
$request->getMethod(); // 'POST'

For merchants in Germany and Austria, you can enable 'Pay Upon Invoice'. This requires specific buyer details (name, email, birth date, phone, and billing address) to be set via setPaymentSourcePayUponInvoice() before calling createOrderWithPaymentSource().

$provider->getAccessToken();

$provider->setPaymentSourcePayUponInvoice([
    'name'       => ['given_name' => 'John', 'surname' => 'Doe'],
    'email'      => 'john.doe@example.com',
    'birth_date' => '1990-01-01',
    'phone'      => ['country_code' => '49', 'national_number' => '1234567890'],
    'billing_address' => [
        'address_line_1' => 'Hauptstraße 1',
        'admin_area_2'   => 'Berlin',
        'postal_code'    => '10115',
        'country_code'   => 'DE',
    ],
    'experience_context' => [
        'locale'     => 'de-DE',
        'return_url' => 'https://example.com/paypal-success',
        'cancel_url' => 'https://example.com/paypal-cancel',
    ],
]);

$order = $provider->createOrderWithPaymentSource([
    'intent'         => 'CAPTURE',
    'purchase_units' => [
        ['amount' => ['currency_code' => 'EUR', 'value' => '99.00']],
    ],
]);

$capture = $provider->capturePaymentOrder($order['id']);

PayPal Fastlane provides a one-click guest checkout. The server's role is to generate a client token and manage the Order v2 lifecycle.

1. Generate Client Token: Call generateClientToken() and pass the resulting client_token to your frontend.
2. Create Order: After the client-side Fastlane UI provides a single_use_token (from Fastlane.FastlaneCardComponent), call createOrder() with the payment_source containing that token.
3. Capture Order: Use capturePaymentOrder($orderId) to finalize the transaction.

// 1. Generate token
$provider->getAccessToken();
$result = $provider->generateClientToken();
$clientToken = $result['client_token'];

// 2. Create Order
$order = $provider->createOrder([
    'intent' => 'CAPTURE',
    'purchase_units' => [
        ['amount' => ['currency_code' => 'USD', 'value' => '49.99']],
    ],
    'payment_source' => [
        'card' => [
            'single_use_token' => $singleUseToken, // From frontend
        ],
    ],
]);

// 3. Capture
$capture = $provider->capturePaymentOrder($order['id']);
$captureId = $provider->getCaptureIdFromOrder($capture);

To use the modern Orders v2 API (replacing the sunsetting v1 Payments API), follow a two-step process: 1. Create the order and redirect the buyer to the PayPal approval URL. 2. Capture the payment after the buyer approves.

// 1. Create the order and redirect the buyer
$order = $provider->createOrder([
    'intent' => 'CAPTURE',
    'purchase_units' => [
        ['amount' => ['currency_code' => 'USD', 'value' => '49.99']],
    ],
    'payment_source' => [
        'paypal' => [
            'experience_context' => [
                'return_url' => 'https://example.com/paypal/return',
                'cancel_url' => 'https://example.com/paypal/cancel',
            ],
        ],
    ],
]);

// Redirect the buyer to: $order['links'][href where rel === 'payer-action']

// 2. After the buyer approves, capture the payment
$capture = $provider->capturePaymentOrder($order['id']);
$captureId = $provider->getCaptureIdFromOrder($capture); // store this