אפשר להשתמש ב-Merchant Accounts API על מנת להציג רשימה מסוננת של החשבונות שיש לכם גישה אליהם, כולל חשבונות משנה. אפשר לסנן לפי שמות מוצגים וקשרים עם חשבונות אחרים.
לדוגמה, אפשר לסנן לפי חשבונות עם שמות מוצגים שמכילים את המחרוזת "store"
, שיש להם גם סטטוס קישור PENDING
, כדי לראות את כל החנויות שעדיין לא אישרו בקשה לקישור חשבון.
כדי להציג את כל חשבונות המשנה, צריך להתקשר אל accounts.v1beta.accounts.listSubAccounts
.
כדי להציג רשימה מסוננת של כל החשבונות שיש לכם גישה אליהם, כולל חשבונות משנה וכל חשבון שאתם מוגדרים כ-User
, צריך לקרוא לפונקציה accounts.v1beta.accounts.list
ולציין את הקריטריונים לסינון בשדה filter
.
מידע נוסף על התחביר בשדה filter
מופיע בחומר העזר בנושא תחביר של מסננים.
אלה סוגי המסננים שבהם אפשר להשתמש:
מסנני חשבון
אפשר להשתמש בשדות הבאים כדי לסנן ברמת account
:
accountName
: מסננים לפיaccountName
של המשאבaccount
.relationship(...)
: מסננים לפי סוג הקשר בין החשבון לבין חשבון אחר. תוכלו לכלול כמה מסננים שלrelationship(...)
בבקשה אחת.
מסננים של מערכות יחסים
אפשר להשתמש בפונקציה relationship(...)
על מנת לסנן לפי הקריטריונים הבאים:
providerId
: מספר המזהה של ספק השירות. לדוגמה, אם המסנן אמור להחזיר רק חשבונות שיש להם שירות שניתן על ידיaccount/123
, השתמשו ב-providerId = 123
.callerHasAccessToProviderFilter()
: מסננים לחשבונות שיש להם קשר עם ספק שירות שיש לכם גישה אליו.externalAccountId
: מזהה החשבון החיצוני של ספק השירות בחשבון שעבורו הוא מספק שירות.accountIdAlias:
כתובת האימייל החלופית של מספר החשבון שמוגדרת לקשר.service(...)
: השירות שניתן כחלק מהקשר הזה. אפשר לכלול כמה פונקציותservice(...)
בפונקציהrelationship(...)
אחת.
מסנני שירות
אפשר להשתמש בפונקציה service(...)
כדי לסנן חשבונות נוספים על סמך הסטטוס של קשרי הגומלין שלהם וסוגי השירותים שקשרי הגומלין האלה מספקים:
handshakeState
: המצב של הסכם שירות בין שני חשבונות. מקבלת את הערכים הבאים:PENDING
APPROVED
type:
סוג השירות שניתן על ידי הספק. מקבלת את הערכים הבאים:ACCOUNT_MANAGEMENT
הספק מנהל את החשבון.ACCOUNT_AGGREGATION
הספק הוא אתר אגרגטור של החשבון.
דוגמאות
הנה כמה דוגמאות למסננים שאפשר לנסות.
מסננים כדי לראות חשבונות עם שמות מוצגים שכוללים את "store" וספקים עם המזהה "123":
accountName = "*store*" AND relationship(providerId = 123)
סינון לפי כל חשבונות המשנה של חשבון "123":
relationship(providerId = 123 AND service(type = "ACCOUNT_AGGREGATION"))
סינון חשבונות עם שירותי ניהול חשבון שאושרו:
relationship(service(handshakeState = "APPROVED" AND type = "ACCOUNT_MANAGEMENT"))
סינון חשבונות עם כינוי ומזהה ספציפיים שיש להם גישה לספק. בנוסף, צריכה להיות לכם גישה לספק כדי לשלוח את הבקשה הזו:
relationship(callerHasAccessToProviderFilter() AND externalAccountId = "extAcctId" AND accountIdAlias = "alias")
מה עושים אחר כך
- מידע נוסף על סינון חשבונות זמין במאמר סינון תחביר.