Set up PayPal in UAT

Before you can pull commerce data from companies using PayPal, you need to set up an integration in Codat's environments, starting with UAT.

You'll need to:

  • Login to the Codat Portal in UAT.
  • Register as a Third Party Provider (TPP) to access PayPal’s X2SA API and request your sandbox credentials
  • PayPal will require you to provide them with either an eIDAS QWAC or OBWAC (i.e. an open banking certification)
  • Add your secure credentials to the Codat Portal in UAT and enable your test PayPal integration.
  • Check your sync settings.

Register as a Third Party Provider and request your sandbox credentials

  1. Go to https://sandbox.paypal.com/partnerexp/tppLanding and register as a Third Party Provider (TPP) for PayPal’s X2SA API
  2. Input https://paypal-uat.codat.io/oauth/callback in the "Your return URL" field.
  3. After submitting the form, your credentials (Client ID and Client Secret) will be available to download. Please note:
    a) PayPal need to enable the credentials after they are created. This may take a number of days; until this is completed by PayPal, you will not be able to access the PayPal X2SA API through Codat.
    b) You can contact PayPal for help or to chase enabling of credentials at [email protected]

🚧

Credentials

Make sure you keep this information safe, as it is not normally possible to retrieve this information from PayPal again after it has been initially requested.

📘

Production Access

Given the turnaround time for PayPal to review and approve your request, and then enable your credentials, you may wish to consider also registering for Production access to the API at the same time.

Add your secure credentials to the Codat Portal and enable your test PayPal application

  1. Open the Codat Portal in UAT and log in.
  2. Go to Integrations > Commerce.
  3. Find PayPal, and select the Manage button next to it.
  4. Copy the Client ID and Client Secret values obtained in the previous step into the boxes in the Codat portal.
  5. Select Save.
  6. Go back to Integrations > Commerce, and use the toggle to update the PayPal integration from Disabled to Enabled.

Check your sync settings in the Codat Portal

If this is your first commerce integration, update your sync settings to enable commerce data types.
Now follow the instructions in Test PayPal to test your setup.


Did this page help you?