Skip to main content

Admin endpoints — products

Two distinct product surfaces for a tenant: the backing provider's own product catalogue, and the platform's per-tenant product mappings (the allow-list that decides which catalogue products a tenant may use). Auth: Entra ID JWT bearer with the ADMIN role. The formal schema is on the API Reference.

MethodPathCodeDoes
GET/v1/admin/clients/{slug}/banking-products200Read the provider's full product catalogue for the tenant
PUT/v1/admin/clients/{slug}/banking-products200Update the provider's product definitions
GET/v1/admin/clients/{slug}/products200List the tenant's mapped products (catalogue ∩ allow-list)
PUT/v1/admin/clients/{slug}/products200Create or update the tenant's product mappings
DELETE/v1/admin/clients/{slug}/products/{productKey}204Remove one product mapping

Notes for operators

  • banking-products vs products. The banking-products routes read and write the provider's catalogue (no platform data is stored). The products routes manage the platform-side mappings that gate which catalogue products the tenant's customers can see and use.
  • Mappings are validated against the live catalogue. A PUT .../products checks every (productKey, productVersion) against the provider's catalogue first; if any is absent, the whole request is rejected with 404 ADM004002 and nothing is written.
  • Idempotent. PUT .../products upserts, and re-adding a previously removed mapping re-activates it.
  • Stale mappings are hidden. GET .../products returns only the mappings the provider still offers; a mapping whose product the provider has dropped is silently omitted (not an error).
  • Delete soft-removes one mapping; an unknown productKey returns 404 ADM004010.

Errors

HTTPCodeWhen
404ADM004009Client slug not found
404ADM004002A requested product (productKey, productVersion) is not in the provider catalogue
404ADM004010Product mapping not found (delete)
500ADM100001Unexpected row count on delete (corruption guard)