Filter akun yang dapat Anda akses

Anda dapat menggunakan Merchant Accounts API untuk melihat daftar akun yang difilter dan dapat Anda akses, termasuk sub-akun. Anda dapat memfilter menurut nama tampilan, dan hubungan ke akun lain. Misalnya, Anda dapat memfilter akun dengan nama tampilan yang berisi string "store", yang juga memiliki status penautan PENDING, untuk melihat semua toko Anda yang belum menerima permintaan penautan akun.

Untuk melihat semua sub-akun Anda, panggil accounts.v1beta.accounts.listSubAccounts.

Untuk melihat daftar semua akun yang difilter dan aksesnya Anda miliki, termasuk sub-akun dan akun lain yang memiliki Anda sebagai User, panggil accounts.v1beta.accounts.list dan tentukan kriteria filter Anda di kolom filter.

Guna mengetahui detail tentang sintaksis untuk kolom filter, lihat referensi sintaksis filter.

Berikut adalah jenis filter yang dapat Anda gunakan:

Filter akun

Anda dapat menggunakan kolom berikut untuk memfilter di tingkat account:

• accountName: Memfilter menurut accountName dari resource account.
• relationship(...): Memfilter menurut jenis hubungan yang dimiliki akun dengan akun lain. Anda dapat menyertakan beberapa filter relationship(...) dalam satu permintaan.

Filter hubungan

Anda dapat menggunakan fungsi relationship(...) untuk memfilter berdasarkan kriteria berikut:

• providerId: ID penjual penyedia layanan. Misalnya, jika filter hanya menampilkan akun yang memiliki layanan yang disediakan oleh account/123, gunakan providerId = 123.
• callerHasAccessToProviderFilter(): Memfilter akun yang memiliki hubungan dengan penyedia layanan yang dapat Anda akses.
• externalAccountId: ID akun eksternal penyedia layanan untuk akun yang mendapatkan layanan tersebut.
• accountIdAlias: Alias ID akun yang dikonfigurasi untuk hubungan.
• service(...): Layanan yang disediakan sebagai bagian dari hubungan. Anda dapat menyertakan beberapa fungsi service(...) dalam satu fungsi relationship(...).

Filter layanan

Anda dapat menggunakan fungsi service(...) untuk memfilter akun lebih lanjut berdasarkan status hubungannya, dan jenis layanan yang disediakan hubungan tersebut:

• handshakeState: Status perjanjian layanan antara dua akun. Menerima nilai berikut:
  • PENDING
  • APPROVED
• type: Jenis layanan yang diberikan oleh penyedia. Menerima nilai berikut:
  • ACCOUNT_MANAGEMENT Penyedia akan mengelola akun.
  • ACCOUNT_AGGREGATION Penyedia adalah agregator akun.

Contoh

Berikut beberapa contoh filter yang dapat Anda coba.

Filter akun dengan nama tampilan yang berisi "toko" dan penyedia dengan ID "123":

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

Filter untuk semua sub-akun akun "123":

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

Filter akun dengan layanan pengelolaan akun yang disetujui:

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

Filter akun dengan alias dan ID tertentu, yang memiliki akses ke penyedia. Anda juga harus memiliki akses ke penyedia untuk permintaan ini:

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

Langkah selanjutnya

• Untuk informasi selengkapnya tentang memfilter akun, lihat Filter sintaksis.