Show Menu

Create a PayPal connector using the Flow Service API

The PayPal connector is in beta. See the Sources overview for more information on using beta-labelled connectors.
Flow Service is used to collect and centralize customer data from various disparate sources within Adobe Experience Platform. The service provides a user interface and RESTful API from which all supported sources are connectable.
This tutorial uses the Flow Service API to walk you through the steps to connect PayPal to Experience Platform.

Getting started

This guide requires a working understanding of the following components of Adobe Experience Platform:
  • Sources : Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Platform services.
  • Sandboxes : Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.
The following sections provide additional information that you will need to know in order to successfully connect to PayPal using the Flow Service API.

Gather required credentials

In order for Flow Service to connect with PayPal, you must provide values for the following connection properties:
The URL of the PayPal instance. (default:
Client ID
The client ID associated with your PayPal application.
Client secret
The client secret associated with your PayPal application.
Connection specification ID
The unique identifier needed to create a connection. The connection specification ID for PayPal is: 221c7626-58f6-4eec-8ee2-042b0226f03b
For more information about getting started refer to this PayPal document .

Reading sample API calls

This tutorial provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Gather values for required headers

In order to make calls to Platform APIs, you must first complete the authentication tutorial . Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
All resources in Experience Platform, including those belonging to the Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:
  • x-sandbox-name: {SANDBOX_NAME}
All requests that contain a payload (POST, PUT, PATCH) require an additional media type header:
  • Content-Type: application/json

Create a connection

A connection specifies a source and contains your credentials for that source. Only one connection is required per PayPal account as it can be used to create multiple source connectors to bring in different data.
API format
POST /connections

In order to create a PayPal connection, its unique connection specification ID must be provided as part of the POST request. The connection specification ID for PayPal is 221c7626-58f6-4eec-8ee2-042b0226f03b .
curl -X POST \
    '' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Paypal connection",
        "description": "Paypal connection",
        "auth": {
        "specName": "Client-Id-Secret Based Authentication",
        "params": {
            "host": "{HOST}",
            "clientId": "{CLIENT_ID}",
            "clientSecret": "{CLIENT_SECRET}"
        "connectionSpec": {
            "id": "221c7626-58f6-4eec-8ee2-042b0226f03b",
            "version": "1.0"

The URL of the PayPal instance.
The client ID associated with your PayPal instance.
The client secret associated with your PayPal instance.
The PayPal connection specification ID: 221c7626-58f6-4eec-8ee2-042b0226f03b .
A successful response returns details of the newly created connection, including its unique identifier ( id ). This ID is required to explore your data in the next tutorial.
    "id": "24151d58-ffa7-4960-951d-58ffa7396097",
    "etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""

Next steps

By following this tutorial, you have created a PayPal connection using the Flow Service API and have obtained the connection's unique ID value. You can use this ID in the next tutorial as you learn how to explore payments application using the Flow Service API .