Konten filtern, auf die Sie Zugriff haben

Mit der Merchant Accounts API können Sie eine gefilterte Liste der Konten aufrufen, auf die Sie Zugriff haben, einschließlich Unterkonten. Sie können nach Anzeigenamen und Beziehungen zu anderen Konten filtern. Sie können beispielsweise nach Konten mit Anzeigenamen filtern, die den String "store" und den Verknüpfungsstatus PENDING enthalten. So sehen Sie alle Ihre Geschäfte, die noch keine Anfrage zur Kontoverknüpfung akzeptiert haben.

Rufen Sie accounts.v1beta.accounts.listSubAccounts auf, um alle Ihre Unterkonten aufzurufen.

Wenn Sie eine gefilterte Liste aller Konten aufrufen möchten, auf die Sie Zugriff haben, einschließlich Unterkonten und aller Konten, in denen Sie als User verwendet werden, rufen Sie accounts.v1beta.accounts.list auf und geben Sie die Filterkriterien im Feld filter an.

Weitere Informationen zur Syntax des Felds filter finden Sie in der Referenz zur Filtersyntax.

Sie können folgende Arten von Filtern verwenden:

Kontofilter

Zum Filtern auf account-Ebene können Sie die folgenden Felder verwenden:

• accountName: Filtert nach accountName der Ressource account.
• relationship(...): Filtert nach der Art der Beziehung, die das Konto mit einem anderen Konto hat. Sie können mehrere relationship(...)-Filter in einer Anfrage verwenden.

Beziehungsfilter

Mit der Funktion relationship(...) können Sie nach den folgenden Kriterien filtern:

• providerId: Die Händler-ID des Dienstanbieters. Wenn der Filter beispielsweise nur Konten zurückgeben soll, die einen von account/123 bereitgestellten Dienst enthalten, verwenden Sie providerId = 123.
• callerHasAccessToProviderFilter(): Filtert für Konten, die eine Beziehung zu einem Dienstanbieter haben, auf den Sie Zugriff haben.
• externalAccountId: Die externe Konto-ID des Dienstanbieters für das Konto, für das er einen Dienst bereitstellt.
• accountIdAlias: Das Konto-ID-Alias, das für die Beziehung konfiguriert ist.
• service(...): Die Dienstleistung, die im Rahmen der Kundenbeziehung angeboten wird. Sie können mehrere service(...)-Funktionen in eine relationship(...)-Funktion aufnehmen.

Dienstfilter

Mit der Funktion service(...) können Sie Konten anhand des Status ihrer Beziehungen und der Arten von Diensten, die diese Beziehungen bieten, weiter filtern:

• handshakeState: Der Status einer Servicevereinbarung zwischen zwei Konten. Akzeptiert die folgenden Werte:
  • PENDING
  • APPROVED
• type: Die Art der Dienstleistung, die vom Anbieter bereitgestellt wird. Akzeptiert die folgenden Werte:
  • ACCOUNT_MANAGEMENT Der Anbieter verwaltet das Konto.
  • ACCOUNT_AGGREGATION Der Anbieter ist ein Dienstleister des Kontos.

Beispiele

Hier sind einige Beispiele für Filter, die Sie ausprobieren können.

Filtern Sie nach Konten, deren Anzeigenamen „Geschäft“ enthalten, und Anbietern mit der ID „123“:

accountName = "*store*" AND relationship(providerId = 123)

Nach allen Unterkonten des Kontos "123" filtern:

relationship(providerId = 123 AND service(type = "ACCOUNT_AGGREGATION"))

Filtern Sie nach Konten mit genehmigten Kontoverwaltungsdiensten:

relationship(service(handshakeState = "APPROVED" AND type = "ACCOUNT_MANAGEMENT"))

Sie können nach Konten mit einem bestimmten Alias und einer bestimmten ID filtern, die Zugriff auf einen Anbieter haben. Für diese Anfrage benötigen Sie außerdem Zugriff auf den Anbieter:

relationship(callerHasAccessToProviderFilter() AND externalAccountId = "extAcctId" AND accountIdAlias = "alias")

Nächste Schritte

• Weitere Informationen zum Filtern von Konten finden Sie unter Filtersyntax.