Filtrer les comptes auxquels vous pouvez accéder

Vous pouvez utiliser l'API Merchant Accounts pour afficher une liste filtrée des comptes. auxquels vous avez accès, y compris les sous-comptes. Vous pouvez filtrer par nom à afficher relations avec d'autres comptes. Par exemple, vous pouvez filtrer les comptes dont le nom à afficher contient le paramètre "store", associées à l'état PENDING, pour afficher toutes vos les magasins qui n'ont pas encore accepté une demande d'association de compte.

Pour afficher tous vos sous-comptes, appelez accounts.v1beta.accounts.listSubAccounts

Pour afficher une liste filtrée de tous les comptes auxquels vous avez accès, y compris et tous les comptes dont vous êtes User, appel accounts.v1beta.accounts.list et spécifiez vos critères de filtre dans le champ filter.

Pour plus d'informations sur la syntaxe du champ filter, consultez la section Syntaxe du filtre référence.

Voici les types de filtres que vous pouvez utiliser:

Filtres de compte

Vous pouvez utiliser les champs suivants pour filtrer au niveau account:

  • accountName: filtre en fonction du accountName de la ressource account.
  • relationship(...): filtre en fonction du type de relation entre le compte avec un autre compte. Vous pouvez inclure plusieurs filtres relationship(...) en une seule requête.

Filtres sur les relations

Vous pouvez utiliser la fonction relationship(...) pour filtrer en fonction des éléments suivants : critères:

  • providerId: ID du marchand du fournisseur de services. Par exemple, si le le filtre doit renvoyer uniquement les comptes dont le service est fourni par account/123, utilisez providerId = 123.
  • callerHasAccessToProviderFilter(): filtres pour les comptes ayant un avec un fournisseur de services auquel vous avez accès.
  • externalAccountId: ID de compte externe du fournisseur de services pour le auquel il fournit un service.
  • accountIdAlias: : alias d'ID de compte configuré pour le relation.
  • service(...): service fourni dans le cadre de la relation. Vous pouvez inclure plusieurs fonctions service(...) dans une seule relationship(...) .

Filtres de service

Vous pouvez utiliser la fonction service(...) pour filtrer davantage les comptes en fonction du l'état de leurs relations et les types de services auxquels ces relations fournissent:

  • handshakeState: état d'un contrat de service entre deux comptes. Accepte les valeurs suivantes: <ph type="x-smartling-placeholder">
      </ph>
    • PENDING
    • APPROVED
  • type: Type de service fourni par le fournisseur. Accepte les éléments suivants : <ph type="x-smartling-placeholder">
      </ph>
    • ACCOUNT_MANAGEMENT Le fournisseur gère le compte.
    • ACCOUNT_AGGREGATION Le fournisseur est un agrégateur du compte.

Exemples

Voici quelques exemples de filtres que vous pouvez essayer.

Filtrez les comptes dont les noms à afficher contiennent "magasin" et les fournisseurs ID "123" :

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

Filtrez tous les sous-comptes du compte "123" :

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

Filtrez les comptes disposant de services de gestion des comptes approuvés:

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

Filtrez les comptes associés à un alias et un ID spécifiques qui ont accès à un fournisseur. Vous devez également avoir accès au fournisseur pour cette demande:

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

Étape suivante

  • Pour en savoir plus sur le filtrage des comptes, consultez la section Filtrer syntaxe.