Skip to main content
Version: 1.0.0

Administration Products API

Admin API for managing the product catalog and per-tenant product configuration.

Two-layer model

  1. Banking-products catalog (/v1/admin/clients/{slug}/banking-products) — the raw product definitions sourced from the core banking connector. Each entry carries a coreBankingProductKey, a productCategory, and zero or more card product definitions. Use PUT to seed or refresh the catalog after a connector change.

  2. 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)

ValueMeaning
TRANS_AND_SAVINGS_ACCOUNTSTransaction and savings accounts
TERM_DEPOSITSTerm deposits
TRAVEL_CARDSTravel cards
CRED_AND_CHRG_CARDSCredit and charge cards
PERS_LOANSPersonal loans
BUSINESS_LOANSBusiness loans
LEASESLeases
MARGIN_LOANSMargin loans
OVERDRAFTSOverdrafts
RESIDENTIAL_MORTGAGESResidential mortgages
REGULATED_TRUST_ACCOUNTSRegulated trust accounts
TRADE_FINANCETrade finance
BUY_NOW_PAY_LATERBuy now pay later

CardProductType values: PHYSICAL, VIRTUAL, PHYSICAL_AND_VIRTUAL

CardBrand values: VISA, MASTERCARD, DEBIT

Authentication

Security Scheme Type: oauth2
OAuth Flow (clientCredentials): Scopes:
  • ADMIN: Access to admin functionality