Paypal
The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.
To choose the API you want to work with, set the Schema property to REST or SOAP. By default, the SOAP schema will be used.
The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the AuthScheme to OAuth, the OAuthClientId, and OAuthClientSecret properties.
The SOAP API requires Signature API credentials. To authenticate to the SOAP API, you will need to set the AuthScheme to Basic, set the Username, Password, and Signature properties. You generate these API credentials when you enable the SOAP API.
For testing purposes, set UseSandbox to true and use Sandbox credentials.
Connecting to the SOAP API
Using API Credentials for SOAP API Calls
You can use the SOAP API to retrieve all transactions for the current account. The SOAP API uses the Signature API-credentials type, which has three credential values:
API Username
API Password
API Signature
To generate the API credentials:
Log in to your PayPal business account and select Profile > My Selling Tools.
In the Selling Online section, click Update for the API Access item.
To generate the API signature, click Request API Credentials on the API Access page.
Select Request API Signature and click Agree and Submit to generate the API signature.
After setting the following connection properties, you are ready to connect:
User: Set this to the API Username.
Password: Set this to the API Password.
Signature: Set this to the Signature.
UseSandbox: Set this to true if you are using sandbox credentials.
Connecting to the REST API
Create an App
To register an app and obtain the OAuth client credentials, the Client Id, and Client Secret:
Log in to your PayPal developer account and My Apps & Credentials (under Dashboard).
Scroll to the REST API apps section and click Create App.
Enter the App Name.
From the drop down list, select the sandbox account that will be used to get data from.
PayPal generates a set of sandbox and live OAuth keys for the application. The sandbox credentials are shown after creating the app. For the live credentials, select the Live option.
The sandbox credentials will be used to get data only for the sandbox account selected when creating the App, while the Live credentials will be used to get data only for the developer account used to create this app.
Authenticate to PayPal
After setting the following connection properties, you are ready to connect:
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
OAuthClientId: Set this to the Client Id in your app settings.
OAuthClientSecret: Set this to the Client Secret in your app settings.
UseSandbox: Set this to true if you are using sandbox credentials.
When you connect, the provider completes the OAuth process.
Exchanges the OAuthClientId and OAuthClientSecret for the OAuthAccessToken.
Refreshes the access token when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Last updated