PayPal-Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8804 des Connectors.

Erste Schritte

PayPal Versionsunterstützung

Der Connector verwendet die PayPal SOAP API, um Transaktionsansichten anzuzeigen, und die REST- API, um alle anderen Ansichten anzuzeigen.

Herstellen einer Verbindung

Mit PayPal verbinden

Der Anbieter stellt Tabellen aus zwei PayPal APIs bereit. Jede API verwendet eine andere Authentifizierungsmethode.

• Die SOAP API erfordert Signature API Anmeldeinformationen. Um sich bei der SOAP API zu authentifizieren, müssen Sie die AuthScheme Zu Basic, und setzen Sie die Username, Password, Und Signature Eigenschaften. Diese API Anmeldeinformationen werden generiert, wenn Sie die SOAP API aktivieren.
• Die REST- API verwendet den OAuth-Authentifizierungsstandard. Um sich bei der REST- API zu authentifizieren, müssen Sie das AuthScheme Zu OAuth, und setzen Sie die OAuthClientId, Und OAuthClientSecret Eigenschaften.

Um Ihre bevorzugte API anzugeben, setzen Sie das Schema Eigenschaft entweder REST oder SOAP. Wenn nein Schema ist gesetzt, PayPal verwendet das SOAP Schema.

Setzen Sie zu Testzwecken UseSandbox auf true setzen und Sandbox-Anmeldeinformationen verwenden.

SOAP API

Sie können die SOAP API verwenden, um alle Transaktionen für das aktuelle Konto abzurufen. Die SOAP API verwendet den Signatur API-Anmeldeinformationstyp, der über drei Anmeldeinformationswerte verfügt:

• API Benutzername
• API Passwort
• API Signatur

So generieren Sie die API Anmeldeinformationen:

1. Melden Sie sich bei Ihrem PayPal-Geschäftskonto an und wählen Sie Profile > My Selling Tools.
2. Klicken Sie im Abschnitt „Online verkaufen“ auf Update für das API Zugriffselement.
3. Um die API Signatur zu generieren, klicken Sie auf Request API Credentials auf der API Zugriffsseite.
4. Wählen Sie Request API Signature und klick Agree and Submit um die API Signatur zu generieren.

Nachdem Sie die folgenden Verbindungseigenschaften festgelegt haben, können Sie eine Verbindung herstellen:

• User = der API Benutzername.
• Password = das API Passwort.
• Signature = die Signatur.
• UseSandbox = true wenn Sie Sandbox-Anmeldeinformationen verwenden.

REST API

Nachdem Sie die folgenden Verbindungseigenschaften festgelegt haben, können Sie eine Verbindung herstellen:

• InitiateOAuth = GETANDREFRESH. Sie können verwenden InitiateOAuth um den OAuth-Austausch und das manuelle Setzen der zu vermeiden OAuthAccessToken Verbindungseigenschaft.
• OAuthClientId = die Client-ID in Ihren App-Einstellungen.
• OAuthClientSecret = das Client Secret in Ihren App-Einstellungen.
• UseSandbox = true wenn Sie Sandbox-Anmeldeinformationen verwenden.

Wenn Sie eine Verbindung herstellen, schließt der Connector den OAuth-Prozess ab.

1. Tauscht die OAuthClientId Und OAuthClientSecret für die OAuthAccessToken.
2. Aktualisiert das Zugriffstoken, wenn es abläuft.
3. Speichert OAuth-Werte in OAuthSettingsLocation soll über mehrere Verbindungen hinweg bestehen bleiben.

PayPal unterstützt nur die OAuth-Authentifizierung für die Verwendung mit der REST API. Um diese Authentifizierung für alle OAuth-Flows zu aktivieren, müssen Sie festlegen AuthScheme Zu OAuth, und Sie müssen eine benutzerdefinierte OAuth-Anwendung erstellen.

In den folgenden Unterabschnitten wird die Authentifizierung bei PayPal anhand von drei gängigen Authentifizierungsabläufen beschrieben. Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung. Eine vollständige Liste der in PayPal verfügbaren Verbindungszeichenfolgeneigenschaften finden Sie unter Connection.

Desktop-Anwendungen

Um sich mit den Anmeldeinformationen für eine benutzerdefinierte OAuth-Anwendung zu authentifizieren, müssen Sie das OAuth-Zugriffstoken abrufen und aktualisieren. Danach können Sie eine Verbindung herstellen.

OAuth-Zugriffstoken abrufen und aktualisieren:

• InitiateOAuth = GETANDREFRESH. Wird verwendet, um automatisch die abzurufen und zu aktualisieren OAuthAccessToken.
• OAuthClientId = die Client-ID, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthClientSecret = das Client-Geheimnis, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• CallbackURL = die Umleitungs-URI, die bei der Registrierung Ihrer Anwendung definiert wurde.

Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von PayPal in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen.

Nachdem Sie der Anwendung Berechtigungen erteilt haben, schließt der Connector den OAuth-Prozess ab:

1. Der Connector erhält einen Zugriffstoken von PayPal und verwendet ihn, um Daten anzufordern.
2. Die OAuth-Werte werden im in angegebenen Pfad gespeichert OAuthSettingsLocation. Diese Werte bleiben über Verbindungen hinweg bestehen.

Wenn das Zugriffstoken abläuft, aktualisiert der Connector es automatisch.

Automatische Aktualisierung des OAuth-Zugriffstokens:

Damit der Connector das OAuth-Zugriffstoken automatisch aktualisiert, gehen Sie wie folgt vor:

1. Legen Sie vor der ersten Verbindung mit Daten die folgenden Verbindungsparameter fest:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = die Client-ID in Ihren Anwendungseinstellungen.
   • OAuthClientSecret = das Client-Geheimnis in Ihren Anwendungseinstellungen.
   • OAuthAccessToken = der von GetOAuthAccessToken zurückgegebene Zugriffstoken.
   • OAuthSettingsLocation = der Pfad, in dem der Connector die OAuth-Werte speichern soll, die über Verbindungen hinweg bestehen bleiben.
2. Legen Sie bei nachfolgenden Datenverbindungen Folgendes fest:
   • InitiateOAuth
   • OAuthSettingsLocation

Manuelle Aktualisierung des OAuth-Zugriffstokens:

Der einzige Wert, der zur manuellen Aktualisierung des OAuth-Zugriffstokens benötigt wird, ist das OAuth-Aktualisierungstoken.

1. Um das OAuthAccessToken nach dem ExpiresIn-Zeitraum (zurückgegeben von GetOAuthAccessToken manuell zu aktualisieren) abgelaufen ist, rufen Sie den RefreshOAuthAccessToken gespeicherte Prozedur.
2. Legen Sie die folgenden Verbindungseigenschaften fest:
   • OAuthClientId = die Client-ID in Ihren Anwendungseinstellungen.
   • OAuthClientSecret = das Client Secret in Ihren Anwendungseinstellungen.
3. Rufen Sie RefreshOAuthAccessToken auf wobei OAuthRefreshToken auf den von GetOAuthAccessToken zurückgegebenen OAuth-Aktualisierungstoken gesetzt ist.
4. Nachdem die neuen Token abgerufen wurden, setzen Sie die OAuthAccessTokenEigenschaft auf den von RefreshOAuthAccessToken zurückgegebenen Wert. Dadurch wird eine neue Verbindung geöffnet.

Speichern Sie das OAuth-Aktualisierungstoken, damit Sie es nach Ablauf zum manuellen Aktualisieren des OAuth-Zugriffstokens verwenden können.

Wenn Sie fertig sind, konfigurieren Sie den Treiber so, dass das Zugriffstoken auf der Headless-Maschine automatisch aktualisiert wird.

Erstellen einer benutzerdefinierten OAuth-Anwendung

Erstellen einer benutzerdefinierten OAuth-Anwendung

Zur Authentifizierung bei Desktop-Anwendungen, Web-Anwendungen oder Headless-Rechnern bei Verwendung der REST- API ist eine benutzerdefinierte OAuth-Anwendung erforderlich.

So registrieren Sie eine OAuth-Anwendung und erhalten die OAuth-Clientanmeldeinformationen, die Client-ID und das Client-Geheimnis:

1. Melden Sie sich bei Ihrem PayPal Entwickler an.
2. Navigieren Sie zu My Apps & Credentials (unter Dashboard).
3. Scrollen Sie zum Abschnitt „REST API -Apps“.
4. Klicken Sie auf Create App.
5. Geben Sie einen Namen für Ihre Anwendung an.
6. Wählen Sie aus der Dropdown-Liste das Sandbox-Konto aus, von dem die Daten abgerufen werden.

PayPal generiert einen Satz Sandbox- und Live-OAuth-Schlüssel für die Anwendung. Die Sandbox-Anmeldeinformationen werden angezeigt, nachdem die Anwendung erstellt wurde. Um die Live-Anmeldeinformationen anzuzeigen, wählen Sie Live Option.

Die Sandbox-Anmeldeinformationen werden nur zum Abrufen von Daten für das Sandbox-Konto verwendet, das Sie beim Erstellen der Anwendung ausgewählt haben. Die Live-Anmeldeinformationen werden nur zum Abrufen von Daten für das Entwickler verwendet, das zum Erstellen dieser Anwendung verwendet wurde.

Wichtige Hinweise

Konfigurationsdateien und ihre Pfade

• Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.

Erweiterte Funktionen

In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des PayPal Connectors beschrieben.

Benutzerdefinierte Ansichten

Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.

SSL-Konfiguration

Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.

Proxy

So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.

Abfrageverarbeitung

Der Connector verlagert die Verarbeitung der SELECT-Anweisung so weit wie möglich auf PayPal und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).

Benutzerdefinierte Ansichten

Mit dem PayPal Connector können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.

Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:

• Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
• DDL-Anweisungen.

Definieren von Ansichten mithilfe einer Konfigurationsdatei

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

• Jedes Stammelement definiert den Namen einer Ansicht.
• Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Payments WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Definieren von Ansichten mit DDL-Anweisungen

Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.

Erstellen einer Ansicht

Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:

CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;

Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews Verbindungseigenschaft.

Ändern einer Ansicht

Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:

ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.

Löschen einer Ansicht

Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.

DROP LOCAL VIEW [MyViewName]

Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.

Schema für benutzerdefinierte Ansichten

Benutzerdefinierte Ansichten werden im angezeigt UserViews Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName Eigentum.

Arbeiten mit benutzerdefinierten Ansichten

Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers listet nur Kunden in Raleigh auf:

SELECT * FROM Customers WHERE City = 'Raleigh';

Ein Beispiel für eine Abfrage an den Treiber:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Daraus ergibt sich die effektive Abfrage an die Quelle:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.

SSL-Konfiguration

Anpassen der SSL-Konfiguration

Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.

Um ein anderes Zertifikat anzugeben, siehe SSLServerCert Eigenschaft für die verfügbaren Formate, um dies zu tun.

Datenmodell

Der PayPal Connector modelliert zwei PayPal APIs als relationale Datenbanken, die REST- API und die SOAP API. Setzen Sie die Schema Eigenschaft und verwenden Sie die Informationen in jedem Abschnitt, um basierend auf den Anforderungen Ihres Projekts die richtige API auszuwählen.

Verwenden der REST- API

Die REST- API ist die neuere API und erfreut sich bei PayPal-Benutzern immer größerer Beliebtheit. Allerdings listet die REST- API nur die Transaktionen und Aktionen auf, die über die REST- API durchgeführt werden, und schließt die Benutzeroberfläche und die SOAP API aus.

Siehe REST-Datenmodell für die verfügbaren Entitäten in der REST- API.

Verwenden der SOAP API

Die SOAP (Classic) API verfügt über umfassende Informationen zu Transaktionen, darunter auch über die Benutzeroberfläche, die REST- API und die SOAP API erstellte Transaktionen.

Siehe SOAP Datenmodell für die verfügbaren Entitäten in der SOAP API.

REST-Datenmodell

Der PayPal Connector modelliert die PayPal REST- APIs als Datenbankansichten und gespeicherte Prozeduren. Diese werden in Schema definiert, bei denen es sich um einfache, textbasierte Konfigurationsdateien handelt, mit denen Schemas leicht angepasst werden können.

Dieser Abschnitt enthält die API Einschränkungen und-Anforderungen für das REST-Datenmodell. Sie können die SupportEnhancedSQL-Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Ansichten

Ansichten sind Tabellen, die nicht geändert werden können. Normalerweise werden schreibgeschützte Daten als Ansichten angezeigt.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu PayPal. Sie können verwendet werden, um auf andere Funktionen in PayPal zuzugreifen, die nicht in den Ansichten.

Einschränkungen der PayPal REST- API

Es gibt einige Einschränkungen in der PayPal REST API. Beispielsweise bietet sie keine Möglichkeit, alle Bestellungen/Zahlungen aufzulisten. Daher ist es nicht möglich, die zugehörigen Ansichten wie OrderItems Abfrage, Bestelldetails, Zahlungen müssen Sie die jeweilige ID kennen und angeben.

Ansichten

Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.

Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.

PayPal Connector-Ansichten

Autorisierungsdetails

Abfragedetails zu Autorisierungen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die erforderliche ID. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen Details für eine bestimmte Autorisierung ab.

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'

SELECT * FROM AuthorizationDetails WHERE ID IN ('70K15739YA1955155', '70K15739YA1955156')

Spalten

Guthaben

Liste aller nicht-kryptologischen Guthaben auf.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste der Streitigkeiten für den authentifizierten Benutzer zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Währung
• Stand der Zeit

Die Filter unterstützen nur den =-Operator.

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet.

• Die folgende Abfrage ruft Details für eine bestimmte Währung ab:

  SELECT * FROM Balances WHERE Currency = 'USD'
  

• Die folgende Abfrage gibt Details zu Saldendatensätzen zurück, die vor dem angegebenen Datum und der angegebenen Uhrzeit erstellt wurden:

  SELECT * FROM Balances WHERE AsOfTime = '2022-01-09 20:59:59.0'
  

Spalten

CaptureDetails

Abfragedetails zu einer erfassten Zahlung.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die erforderliche ID. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen Details für ein bestimmtes Capture ab.

SELECT * FROM CaptureDetails WHERE Id = '9G02572041588110H'

SELECT * FROM CaptureDetails WHERE ID IN ('9G02572041588110H', '9G02572041588111H')

Spalten

CreditCardDetails

Fragen Sie Details zum Zahlungsmittel des Zahlers ab, z. B. eine Kreditkarte oder ein Token, das eine Kreditkarte darstellt.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste von Kreditkarten oder Details zu einer bestimmten Kreditkarte zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Ausweis
• Zeit erstellen
• Händler-ID
• ExterneKartenID
• Externe Kunden-ID

Der CreateTime-Filter unterstützt die Operatoren >, >=, <, <= und =, während die anderen Filter nur den Operator = unterstützen.

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet.

• Die folgende Abfrage ruft Details zu einer bestimmten Kreditkarte ab:

  SELECT * FROM CreditCardDetails WHERE ID  = 'CARD-19H02474E2775740PKZYWVVI'
  

• Die folgende Abfrage gibt Details zu Kreditkartendatensätzen zurück, die nach dem angegebenen Datum erstellt wurden:

  SELECT * FROM CreditCardDetails WHERE CreateTime > '2016-01-01'
  

Spalten

KryptoGuthaben

Alle Kryptoguthaben auflisten.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste der Streitigkeiten für den authentifizierten Benutzer zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Stand der Zeit

Die Filter unterstützen nur den =-Operator.

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet.

• Die folgende Abfrage gibt Details zu Saldendatensätzen zurück, die vor dem angegebenen Datum und der angegebenen Uhrzeit erstellt wurden:

  SELECT * FROM CryptoBalances WHERE AsOfTime = '2022-01-09 20:59:59.0'
  

Spalten

Streitdetails

PayPal Händler, -Partner und externe Entwickler können die PayPal Disputes API zur Streitbeilegung nutzen.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste von Streitigkeiten mit detaillierten Informationen für den authentifizierten Benutzer zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Streit-ID

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet.

• Die folgende Abfrage ruft Details zu einem bestimmten Streitfall ab:

  SELECT * FROM DisputeDetails WHERE DisputeId = 'PP-D-12345'
  

Spalten

Streitigkeiten

PayPal Händler, -Partner und externe Entwickler können die PayPal Disputes API zur Streitbeilegung nutzen.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste der Streitigkeiten für den authentifizierten Benutzer zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Streit-ID
• Streitzustand
• Zeit erstellen

Der CreateTime-Filter unterstützt die Operatoren >, >=, <, <= und =, während die anderen Filter nur den Operator = unterstützen.

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet.

• Die folgende Abfrage ruft Details zu einem bestimmten Streitfall ab:

  SELECT * FROM Disputes WHERE DisputeId = 'PP-D-12345'
  

• Die folgende Abfrage gibt Details zu Streitdatensätzen zurück, die nach dem angegebenen Datum erstellt wurden:

  SELECT * FROM Disputes WHERE CreateTime > '2016-01-01'
  

Spalten

Streittransaktionen

PayPal Händler, -Partner und externe Entwickler können die PayPal Disputes API zur Streitbeilegung nutzen.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste von Transaktionen mit Details zu einem bestimmten Streitfall zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Streit-ID

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet.

• Die folgende Abfrage ruft Transaktionsdetails für einen bestimmten Streitfall ab:

  SELECT * FROM DisputeTransactions WHERE DisputeId = 'PP-D-12345'
  

Spalten

Rechnungen

Rechnungen in PayPal abfragen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die ID. Die serverseitige Verarbeitung wird nur für den Operator „=“ unterstützt.

SELECT * FROM Invoices WHERE ID = 'INV2-LV8Z-5XH2-L4Z6-7LQ4'

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Spalten

Benachrichtigungen

Fragen Sie die Liste der Ereignistypen ab, die bei einem Webhook angemeldet sind.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist WebhookId, der nur den Operator = unterstützt. Dies ist ein erforderlicher Parameter. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet und ruft die Benachrichtigungsliste für den angegebenen Webhook ab.

SELECT * FROM Notifications WHERE WebhookId = '8BU398853V564980H'

Spalten

Bestelldetails

Details zu einer Bestellung abfragen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die erforderliche ID. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen Details zu einer bestimmten Bestellung ab.

SELECT * FROM OrderDetails WHERE Id = 'O-1HE90236LH9332431'

SELECT * FROM OrderDetails WHERE ID IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Spalten

Bestellartikel

Erhalten Sie die Artikel in einer Bestellung.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist OrderId, der erforderlich ist. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen Details zu einer bestimmten Bestellung ab.

SELECT * FROM OrderItems WHERE OrderId = 'O-1HE90236LH9332431'

SELECT * FROM OrderItems WHERE OrderId IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Spalten

Zahlungen

Details zu autorisierten Zahlungen abfragen.

Tabellenspezifische Informationen

Wählen

Die einzigen unterstützten Filter sind ID und OrderId. Filter unterstützen nur den Operator =. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet und ruft Zahlungen ab, die nach dem angegebenen Datum erstellt wurden.

SELECT * FROM Payments WHERE ID > 'P-41250-2' AND OrderId =  'O-123550-05'

Spalten

Zahlungstransaktionen

Transaktionsdetails abfragen, einschließlich Betrag und Artikeldetails.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist PaymentId, der erforderlich ist. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen eine Liste der Transaktionen für die angegebene Zahlung ab.

SELECT * FROM PaymentTransactions WHERE PaymentId = 'PAY-6SL93120VR4146201KZYWPVY'

SELECT * FROM PaymentTransactions WHERE PaymentId IN ('PAY-6SL93120VR4146201KZYWPVY', 'PAY-6SL93120VR0000201KZYWPVY')

Spalten

Auszahlungsdetails

Details zu Auszahlungen abrufen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist PayoutBatchId, der erforderlich ist. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet und ruft Details für eine bestimmte Auszahlung ab.

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Spalten

Auszahlungsposten

Auszahlungsposten aus einer Auszahlung abrufen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist PayoutBatchId, der erforderlich ist. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet und ruft alle Auszahlungselemente für eine bestimmte Auszahlung ab.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'

Spalten

Baupläne

Listen Sie die Abrechnungspläne auf.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste der Abonnementpläne für den authentifizierten Benutzer zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Ausweis
• Produkt-ID

SELECT * FROM Plans WHERE Id = '1234'
SELECT * FROM Plans WHERE ProductId = '1234'

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Spalten

Rückerstattungsdetails

Details zu einer bestimmten Rückerstattung abfragen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die erforderliche ID. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen Details für eine bestimmte Rückerstattung ab.

SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U'

SELECT * FROM RefundDetails WHERE ID IN ('4W92068757818534U', '4W91234757818534U')

Spalten

Verkaufsdetails

Abfragedetails zu einer Verkaufstransaktion.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die erforderliche ID. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet und rufen Details zu einem bestimmten Verkauf ab.

SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'

SELECT * FROM SaleDetails WHERE ID IN ('6M2430095X488331A', '6M2410805X488331A')

Spalten

Abonnements

Rechnungs- und Abonnementdetails abrufen.

Tabellenspezifische Informationen

Wählen

Der einzige von der PayPal API unterstützte Filter ist die erforderliche ID. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

SELECT * FROM Subscriptions WHERE ID = '1234'

Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors.

Spalten

Abonnementtransaktionen

Listet Transaktionen für ein Abonnement auf.

Tabellenspezifische Informationen

Wählen

Diese Ansicht gibt eine Liste von Transaktionen mit Details für ein bestimmtes Abonnement zurück.

Die folgenden Filter werden von der PayPal API unterstützt:

• Abonnement-ID
• Startzeit
• Endzeit

SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234'
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' AND StartTime = '2018-01-21T07:50:20.940Z' AND EndTime = '2018-08-21T07:50:20.940Z'

2. Wir können die Abonnement-ID erhalten, indem wir das Abonnement mit der gespeicherten Prozedur „CreateSubscription“ erstellen.

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Transaktionsberichte

Listet Transaktionsberichte auf.

Tabellenspezifische Informationen

Wählen

Die von der PayPal API unterstützten Filter sind StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Die serverseitige Verarbeitung wird nur für den Operator „=“ unterstützt.

SELECT * FROM TransactionReports WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

TransaktionsberichteWarenkorbInfoArtikeldetails

Warenkorbinformationen der Transaktionsberichte auflisten.

Tabellenspezifische Informationen

Wählen

Die von der PayPal API unterstützten Filter sind StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Die serverseitige Verarbeitung wird nur für den Operator „=“ unterstützt.

SELECT * FROM TransactionReportsCartInfoItemDetails WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

Der Connector verarbeitet weitere Filter clientseitig innerhalb des Connectors.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

TransaktionsberichteAnreizdetails

Anreizdetails der Transaktionsberichte auflisten.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Webhooks

Fragen Sie die Liste der Webhooks ab.

Tabellenspezifische Informationen

Wählen

Die PayPal API unterstützt keine Filter für diese Tabelle. Projektionen werden jedoch unterstützt. Alle Filter werden clientseitig innerhalb des Connectors verarbeitet.

Spalten

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT-Operationen mit PayPal hinaus erweitern.

Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von PayPal zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.

Gespeicherte Prozeduren für den PayPal Connector

Auszahlungen erstellen

Führt Auszahlungen über PayPal durch.

Tabellenspezifische Informationen

Auszahlungselemente

Sie können keine Auszahlung ohne Auszahlungselemente erstellen. Um Auszahlungselemente zu erstellen, müssen Sie Daten entweder mithilfe eines JSON-Aggregats oder über eine temporäre Tabelle namens „PayoutItem#TEMP“ einfügen. Weitere Informationen finden Sie in den folgenden Beispielen.

Beispiel: Erstellen von Auszahlungen mithilfe eines JSON-Aggregats

EXECUTE CreatePayouts SenderBatchId = '1247', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!', PayoutItem = '[{\n" +
          "\"recipient_type\": \"EMAIL\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "},\n" +
          "\"note\": \"Thanks for your patronage3333!\",\n" +
          "\"receiver\": \"receiver@example.com\",\n" +
          "\"sender_item_id\": \"201403140001\"\n" +
          "}, {\n" +
          "\"recipient_type\": \"PHONE\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "\t},\n" +
          "\"note\": \"Thanks for your support!\",\n" +
          "\"receiver\": \"91-734-234-1234\",\n" +
          "\"sender_item_id\": \"201403140002\"\n" +
          "}\n" +

"]'

Beispiel: Auszahlungen mithilfe einer temporären Tabelle erstellen

Um Auszahlungselemente zu erstellen, müssen Sie zuerst PayoutItem#TEMP einfügen.

INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('EMAIL', '3.2', 'USD', 'Thanks for your patronage!', '201403140001', 'receiver@example.com')
INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('PHONE', '8.98', 'USD', 'Thanks for your support!', '201403140002', '91-734-234-1234')

Ausführen

Nachdem Sie mindestens einen Auszahlungsposten erstellt haben, können Sie die gespeicherte Prozedur ausführen.

EXECUTE CreatePayouts SenderBatchId = '123', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!'

Die folgenden Spalten sind erforderlich, um einen Auszahlungsposten zu erstellen:

• Empfängertyp
• Betragswert
• Betragwährung
• Absenderposten-ID
• Empfänger

Eingabe

Ergebnissatzspalten

Abonnement erstellen

Erstellen Sie ein Abonnement für PayPal.

Gespeicherte Prozedurspezifische Informationen

Die gespeicherte Prozedur „CreateSubscription“ erfordert PlanId, um ein PayPal Abonnement zu erstellen.

EXECUTE CreateSubscription PlanId = 'P-5ML4271244454362WXNWU5NQ', StartTime = '2021-11-01T00:00:00Z', ShippingAmount = '{\n" +
          "    \"currency_code\": \"USD\",\n" +
          "    \"value\": \"10.00\"\n" +
          "  }', subscriber = '{\n" +
          "    \"name\": {\n" +
          "      \"given_name\": \"John\",\n" +
          "      \"surname\": \"Doe\"\n" +
          "    },\n" +
          "    \"email_address\": \"customer@example.com\",\n" +
          "    \"shipping_address\": {\n" +
          "      \"name\": {\n" +
          "        \"full_name\": \"John Doe\"\n" +
          "      },\n" +
          "      \"address\": {\n" +
          "        \"address_line_1\": \"2211 N First Street\",\n" +
          "        \"address_line_2\": \"Building 17\",\n" +
          "        \"admin_area_2\": \"San Jose\",\n" +
          "        \"admin_area_1\": \"CA\",\n" +
          "        \"postal_code\": \"95131\",\n" +
          "        \"country_code\": \"US\"\n" +
          "      }\n" +
          "    }\n" +
"  }'

Die folgenden Spalten sind zum Erstellen eines Abonnements erforderlich:

• PlanId

Eingabe

Spalten des Ergebnissatzes

GetOAuthAccessToken

Ruft den OAuth-Zugriffstoken von PayPal ab.

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen PayPal Diensten verwendet wird.

Ergebnissatzspalten

Rechnung senden

Senden Sie einem Kunden eine Rechnung per ID.

Eingang

SOAP Datenmodell

Der PayPal Connector modelliert die PayPal SOAP APIs als Datenbank-Ansichten. Normalerweise werden schreibgeschützte Daten als Ansichten angezeigt. Diese werden in Schema definiert, bei denen es sich um einfache, textbasierte Konfigurationsdateien handelt, mit denen Schemata leicht angepasst werden können.

Dieser Abschnitt enthält die API Einschränkungen und-Anforderungen für das SOAP Datenmodell. Sie können die SupportEnhancedSQL-Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Ansichten

Ansichten sind Tabellen, die nicht geändert werden können. Normalerweise werden schreibgeschützte Daten als Ansichten angezeigt.

Ansichten

Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.

Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.

PayPal Connector-Ansichten

Gleichgewicht

Alle Währungen des Kontos und deren Salden anzeigen.

Spalten

GleichgewichtBeeinflussend

Transaktionen abfragen, die den Kontostand beeinflussen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Guthabentransfer

Abfragetransaktionen mit Saldenübertragungen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

BillPay

Transaktionen abfragen, die BillPay-Transaktionen beinhalten.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Währungsumrechnungen

Abfragetransaktionen mit Währungsumrechnungen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Dividend

Abfragetransaktionen mit Dividenden.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

ECheck

Abfragetransaktionen mit eChecks.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Gebühr

Abfrage von Transaktionen mit Gebühren.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Fonds hinzugefügt

Abfragetransaktionen, die generiert werden, wenn Geldmittel zum Kontostand hinzugefügt werden.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Abgehobene Mittel

Abfragetransaktionen, die generiert werden, wenn Geld vom Guthaben abgehoben wird.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Massenzahlung

Massenzahlungstransaktionen abfragen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

GeldAnfrage

Geldanforderungstransaktionen abfragen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Erhalten

Zahlungseingangstransaktionen abfragen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Empfehlung

Abfragetransaktionen mit Empfehlungen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Erstattung

Transaktionen mit Rückerstattungen abfragen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Umkehrung

Transaktionen mit BillPay-Rückbuchungen abfragen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Gesendet

Abfrage gesendeter Zahlungen-Transaktionen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Versand

Transaktionen abfragen, die UPS-Versandgebühren betreffen.

Spalten

Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.