How to add Paypal Classic as a payment provider

PayPal is a digital payments platform that enables users to make online payments.

Note

If you are using PayPal as your payment provider, with a few pages and clicks you can use our Theme blocks to have the checkout flow working on your site.

If you plan is to use Paypal as your Payment provider, consider the following:

• Based on the currencies supported by Arc XP Subscriptions and PayPal, the following currencies will work: BRL, CAD, EUR, JPY, MXN, NZD, GBP, USD.
• Only orders with total amount greater tan zero can be completed succesfully. This means, PayPal does not work for free-tier orders.

Prerequisites

1. Add PayPal as a payment provider through the Admin tool.

Checkout flow

Note

We will walk through this document using our SDK methods, but if you need to call the APIs directly, please check How to Connect with Arc XP Sales SDK and APIs on the web to see the API that our SDK methods are wrapping.

Unlike other payment providers, such as Stripe Intents, PayPal requires the user to be redirected to the PayPal page, where they must confirm the payment. The PayPal checkout workflow follows the steps defined on Checkout to purchase a subscription. The code provided below is explained according to the regular checkout flow.

Regardless of the payment provider, Steps 1 to 5 (Authenticate, Get products and prices, Add item(s) to cart, Create order and Get payment options) are exactly the same as described on Checkout to purchase a subscription. See How to add Stripe Intents as a payment provider for implementation details.

1. Authenticate.

2. Get products and prices.

3. Add item(s) to cart.

4. Create order.

5. Get payment options.

6. Initialize payment: On the previous step, you can identify payment methods set up for PayPal by checking if they have paymentMethodType: 10. For each element returned, you will see a paymentMethodID, this value, together with the orden number are required when calling Sales.initializePayment().

   If successful, Sales.initializePayment() will return a URL in parameter1. The end user needs to be redirect to that page.

       const orderNumber = Sales.currentOrder.orderNumber;
       const paymentProvider = chosenPaymentOption; // chosen by the user with paymentMethodType: 10,
       ...
       const payment = await Sales.initializePayment(orderNumber, paymentProvider.paymentMethodID);
       window.location.href = payment["parameter1"];

   Once the user is logged into their PayPal account and agrees to the payment, if the payment is confirmed on the PayPal side, the user will be redirected to the Return URL defined on settings, along with a token (e.g. {returnURL}?token=EC-6UK47484PR908XXXX).

7. Finalize payment: Since the end user is redirected to an external site, you need to make sure you store the reCAPTCHA token (if this features is enabled for checkout) and the orderNumber in the user’s browser. This information should be grabbed to be passed along with the token when calling Sales.finalizePayment()