Administration Products API
Admin API for managing the product catalog and per-tenant product configuration.
Two-layer model
-
Banking-products catalog (
/v1/admin/clients/{slug}/banking-products) — the raw product definitions sourced from the core banking connector. Each entry carries acoreBankingProductKey, aproductCategory, and zero or more card product definitions. UsePUTto seed or refresh the catalog after a connector change. -
Client/brand product mappings (
/v1/admin/clients/{slug}/products) — the subset of catalog products that are enabled for a specific client/brand, identified by{slug}. The platform uses this list to validate product selections at account-opening time.
Authentication: ADMIN role required (OAuth2 client-credentials,
ADMIN scope).
Error envelope: { errorCode, message, timestamp, traceId } where
errorCode follows the pattern {DOMAIN}{CLASSIFICATION}{SEQUENCE}.
productCategory values (Open Banking)
| Value | Meaning |
|---|---|
TRANS_AND_SAVINGS_ACCOUNTS | Transaction and savings accounts |
TERM_DEPOSITS | Term deposits |
TRAVEL_CARDS | Travel cards |
CRED_AND_CHRG_CARDS | Credit and charge cards |
PERS_LOANS | Personal loans |
BUSINESS_LOANS | Business loans |
LEASES | Leases |
MARGIN_LOANS | Margin loans |
OVERDRAFTS | Overdrafts |
RESIDENTIAL_MORTGAGES | Residential mortgages |
REGULATED_TRUST_ACCOUNTS | Regulated trust accounts |
TRADE_FINANCE | Trade finance |
BUY_NOW_PAY_LATER | Buy now pay later |
CardProductType values: PHYSICAL, VIRTUAL, PHYSICAL_AND_VIRTUAL
CardBrand values: VISA, MASTERCARD, DEBIT
Authentication
- OAuth 2.0: OAuth2
| Security Scheme Type: | oauth2 |
|---|---|
| OAuth Flow (clientCredentials): | Scopes:
|