Filtra gli account a cui puoi accedere

Puoi utilizzare l'API Merchant Accounts per visualizzare un elenco filtrato degli account a cui hai accesso, inclusi i subaccount. Puoi filtrare i dati per nomi visualizzati e relazioni con altri account. Ad esempio, potresti filtrare gli account con nomi visualizzati contenenti la stringa "store", che hanno anche uno stato del link PENDING, per visualizzare tutti i negozi che non hanno ancora accettato una richiesta di collegamento dell'account.

Per visualizzare tutti i tuoi subaccount, chiama accounts.v1beta.accounts.listSubAccounts.

Per visualizzare un elenco filtrato di tutti gli account a cui hai accesso, inclusi i subaccount e gli account che ti hanno associato come User, chiama accounts.v1beta.accounts.list e specifica i criteri di filtro nel campo filter.

Per maggiori dettagli sulla sintassi per il campo filter, consulta la documentazione di riferimento sulla sintassi dei filtri.

Di seguito sono riportati i tipi di filtri che puoi utilizzare:

Filtri account

Puoi utilizzare i seguenti campi per filtrare a livello di account:

  • accountName: filtra in base a accountName della risorsa account.
  • relationship(...): filtra in base al tipo di relazione che l'account ha con un altro account. Puoi includere più filtri relationship(...) in una sola richiesta.

Filtri relazioni

Puoi utilizzare la funzione relationship(...) per filtrare in base ai seguenti criteri:

  • providerId: l'ID commerciante del fornitore di servizi. Ad esempio, se il filtro deve restituire solo gli account che dispongono di un servizio fornito da account/123, utilizza providerId = 123.
  • callerHasAccessToProviderFilter(): filtri per gli account che hanno una relazione con un fornitore di servizi a cui hai accesso.
  • externalAccountId: l'ID account esterno del fornitore di servizi per l'account a cui fornisce un servizio.
  • accountIdAlias: L'alias dell'ID account configurato per la relazione.
  • service(...): il servizio fornito nell'ambito della relazione. Puoi includere più funzioni service(...) in una funzione relationship(...).

Filtri servizio

Puoi utilizzare la funzione service(...) per filtrare ulteriormente gli account in base allo stato delle relazioni e ai tipi di servizi forniti da queste relazioni:

  • handshakeState: lo stato di un contratto di servizio tra due account. Accetta i seguenti valori:
    • PENDING
    • APPROVED
  • type: Il tipo di servizio fornito dal fornitore. Accetta i seguenti valori:
    • ACCOUNT_MANAGEMENT Il fornitore gestisce l'account.
    • ACCOUNT_AGGREGATION Il fornitore è un aggregatore dell'account.

Esempi

Ecco alcuni esempi di filtri che puoi provare.

Filtra per gli account i cui nomi visualizzati contengono "negozio" e i fornitori con l'ID "123":

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

Filtro per tutti i subaccount dell'account "123":

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

Filtra in base agli account con servizi di gestione degli account approvati:

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

Filtrare in base agli account con un alias e un ID specifici che hanno accesso a un provider. Devi inoltre avere accesso al provider per questa richiesta:

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

Passaggi successivi