Skip to content

PayPal

This Integration requires Fides Cloud or Fides Enterprise. For more information, talk to our solutions team. (opens in a new tab)

PayPal (opens in a new tab) provides online payment processing and invoicing solutions for businesses. The Fides connector supports the PayPal REST API for invoicing and the Vault API for payment tokens, enabling DSR automation to access and manage customer data.

Prerequisites

The connector uses OAuth2 client credentials to authenticate with the PayPal REST API. You must create a REST API app in the PayPal Developer Dashboard (opens in a new tab) and collect the following:

NameDescription
Domain*Your PayPal API domain (default: api-m.paypal.com). Use api-m.sandbox.paypal.com for sandbox.
Client ID*Your PayPal REST API application client ID from the dashboard.
Client secret*Your PayPal REST API application client secret from the dashboard.
PayPal customer ID fieldThe location in your owned database where you store PayPal Vault customer IDs. This external reference must be configured so Fides can look up payment tokens by customer.
To use the payment tokens endpoint, you must configure the PayPal customer ID field external reference to point to the field in your dataset that holds the PayPal Vault customer ID for each data subject.

Integrating with PayPal

To integrate an existing system with PayPal:

  1. Navigate to Data mapView Systems and choose the system that you want to connect.
  2. Click on the Integrations tab.
  3. Pick PayPal from the Connection type drop-down menu.
  4. Complete the required fields (Domain, Client ID, Client secret) and configure the PayPal customer ID field external reference if you use payment tokens.
  5. Click Save.

You may confirm your connection is working using the Test connection button, if desired.

To learn more, please see our guide for Managing Integrations.

Technical detail

Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.

PayPal endpoints

In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.

Privacy functionEndpointDescription
Access RequestsSearch Invoices (opens in a new tab)Searches for invoices by recipient email (POST /v2/invoicing/search-invoices).
Access RequestsPayment Method Tokens (opens in a new tab)Returns payment tokens for a customer by PayPal Vault customer ID (GET /v3/vault/payment-tokens). Requires the PayPal customer ID external reference.