Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

PayPal

This documentation for the PayPal integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate PayPal, visit our connection instructions.

Version​

This integration utilizes the PayPal REST API v1 and v2.

Base URL​

The base URL used for all PayPal API endpoints:
https://api.paypal.com

Authentication & Authorization​

The DataGrail PayPal integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials
Publicly exposing your API credentials can allow unauthorized access to PayPal API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Limits​

Limits in PayPal are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

  • DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
  • DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

Capabilities​

Access​

DataGrail's PayPal integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions​

For Access requests, DataGrail will take the following actions:

  1. Search invoices by the Data Subject email.
  2. List transactions for the last 170 days and select the records where the payer’s email address is equal to the Data Subject email.
  3. List disputes for the last 170 days.
  4. Get dispute details by ID and select the records where the buyer's name is equal to the payer's name getting from the transactions collection on the previous step.

Endpoints Utilized​

MethodEndpointPurposeDocs
GET/v1/customer/disputesList disputes
GET/v1/customer/disputes/idGet dispute details by ID
GET/v1/reporting/transactionsList transactions
POST/v2/invoicing/search-invoicesSearch invoices

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.