Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a PayPal source in Nexla.
paypal_api.png

PayPal

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the PayPal connector tile from the list of available connectors. Then, select the credential that will be used to connect to your PayPal account, and click Next; or, create a new PayPal credential for use in this flow.

  3. In Nexla, PayPal data sources can be created using pre-built endpoint templates, which expedite source setup for common PayPal endpoints. Each template is designed specifically for the corresponding PayPal endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    PayPal sources can also be configured manually, allowing you to ingest data from PayPal endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common PayPal endpoints. Each template is designed specifically for the corresponding PayPal endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Transactions

    This endpoint template lists all transactions from your PayPal account. Use this template when you need to retrieve transaction data, including transaction IDs, amounts, dates, statuses, and other transaction details. Check out the API documentation URL for more details.

    • This endpoint automatically retrieves all transactions from your PayPal account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

    This endpoint lists all transactions from your PayPal account, including transaction IDs, amounts, dates, statuses, and other transaction details. The endpoint uses incrementing page-based pagination with page and page_size parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page number. The endpoint returns up to 500 transactions per page by default.

    For detailed information about transaction management, API response structures, pagination, and available transaction data, see the PayPal API documentation.

    Get Invoices

    This endpoint template lists all invoices from your PayPal account. Use this template when you need to retrieve invoice data, including invoice IDs, amounts, dates, statuses, and other invoice details. Check out the API documentation URL for more details.

    • This endpoint automatically retrieves all invoices from your PayPal account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

    This endpoint lists all invoices from your PayPal account, including invoice IDs, amounts, dates, statuses, and other invoice details. The endpoint uses incrementing page-based pagination with page and page_size parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page number. The endpoint returns up to 100 invoices per page by default.

    For detailed information about invoice management, API response structures, pagination, and available invoice data, see the PayPal API documentation.

    Get Disputes

    This endpoint template lists all customer disputes from your PayPal account. Use this template when you need to retrieve dispute data, including dispute IDs, amounts, dates, statuses, and other dispute details. Check out the API documentation URL for more details.

    • This endpoint automatically retrieves all customer disputes from your PayPal account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

    This endpoint lists all customer disputes from your PayPal account, including dispute IDs, amounts, dates, statuses, and other dispute details. The endpoint uses incrementing page-based pagination with page and page_size parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page number. The endpoint returns up to 50 disputes per page by default.

    For detailed information about dispute management, API response structures, pagination, and available dispute data, see the PayPal API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

PayPal data sources can be manually configured to ingest data from any valid PayPal API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex PayPal sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the PayPal API from the Method pulldown menu. PayPal API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the PayPal API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your API URL (from your credential), the API path (e.g., /v1/reporting/transactions, /v2/invoicing/invoices), and any required query parameters. Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The PayPal API uses incrementing page-based pagination with page and page_size for some endpoints. The endpoint URL should include your API URL and the appropriate API path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For PayPal API responses, use $.transaction_details[*] to extract all transactions from the transaction_details array, or $.items[*] to extract all items from the items array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your PayPal API response. PayPal API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. PayPal API uses incrementing page-based pagination with page and page_size for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For incrementing page-based pagination, specify the page parameter name (page), the starting page value (1), and the page size parameter name (page_size).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.