Você pode usar a API Merchant Accounts para ver uma lista filtrada das contas.
aos quais você tem acesso, incluindo subcontas. É possível filtrar por nomes de exibição.
relacionamentos com outras contas.
Por exemplo, é possível filtrar por contas com nomes de exibição que contêm
string "store"
, que também têm um status de link PENDING
, para ver todas as suas
lojas que ainda não aceitaram um pedido de vinculação de conta.
Para acessar todas as subcontas, chame
accounts.v1beta.accounts.listSubAccounts
Para ver uma lista filtrada de todas as contas a que você tem acesso, incluindo
subcontas e contas em que você é
User
, chamar
accounts.v1beta.accounts.list
e especifique os critérios de filtro no campo filter
.
Para detalhes sobre a sintaxe do campo filter
, consulte a sintaxe de filtro
Referência.
Confira os tipos de filtro que você pode usar:
Filtros da conta
É possível usar os seguintes campos para filtrar no nível do account
:
accountName
: filtra peloaccountName
do recursoaccount
.relationship(...)
: filtra pelo tipo de relação que a conta tem. com outra conta. Você pode incluir vários filtrosrelationship(...)
em uma solicitação.
Filtros de relacionamento
Você pode usar a função relationship(...)
para filtrar com base no seguinte
critérios:
providerId
: o ID do comerciante do provedor de serviços. Por exemplo, se o o filtro deve retornar somente contas que tenham um serviço fornecido peloaccount/123
, useproviderId = 123
.callerHasAccessToProviderFilter()
: filtros para contas que têm um relação com um provedor de serviços ao qual você tenha acesso.externalAccountId
: o ID da conta externa do provedor de serviços para o conta a que ele fornece um serviço.accountIdAlias:
O alias do ID da conta que está configurado para o relação.service(...)
: o serviço fornecido como parte do relacionamento. Você pode incluir várias funçõesservice(...)
em umarelationship(...)
. função.
Filtros de serviço
É possível usar a função service(...)
para filtrar ainda mais as contas com base no
status das suas relações e os tipos de serviços que essas relações oferecem
fornecem:
handshakeState
: o estado de um contrato de serviço entre duas contas. Aceita os seguintes valores:PENDING
APPROVED
type:
: o tipo de serviço oferecido pelo provedor. Aceita o seguinte valores:ACCOUNT_MANAGEMENT
O provedor gerencia a conta.ACCOUNT_AGGREGATION
O provedor é um agregador da conta.
Exemplos
Veja a seguir alguns exemplos de filtros.
Filtrar contas com nomes de exibição que contenham "loja" e provedores com ID "123":
accountName = "*store*" AND relationship(providerId = 123)
Filtrar todas as subcontas da conta "123":
relationship(providerId = 123 AND service(type = "ACCOUNT_AGGREGATION"))
Filtre as contas com serviços de gerenciamento aprovados:
relationship(service(handshakeState = "APPROVED" AND type = "ACCOUNT_MANAGEMENT"))
Filtre as contas com um alias e um ID específicos que tenham acesso a um provedor. Você também precisa ter acesso ao provedor para esta solicitação:
relationship(callerHasAccessToProviderFilter() AND externalAccountId = "extAcctId" AND accountIdAlias = "alias")
A seguir
- Para mais informações sobre como filtrar contas, consulte Filtrar sintaxe.