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.
| Method | Path | Code | Does |
|---|---|---|---|
GET | /v1/admin/clients/{slug}/banking-products | 200 | Read the provider's full product catalogue for the tenant |
PUT | /v1/admin/clients/{slug}/banking-products | 200 | Update the provider's product definitions |
GET | /v1/admin/clients/{slug}/products | 200 | List the tenant's mapped products (catalogue ∩ allow-list) |
PUT | /v1/admin/clients/{slug}/products | 200 | Create or update the tenant's product mappings |
DELETE | /v1/admin/clients/{slug}/products/{productKey} | 204 | Remove one product mapping |
Notes for operators
banking-productsvsproducts. Thebanking-productsroutes read and write the provider's catalogue (no platform data is stored). Theproductsroutes 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 .../productschecks every(productKey, productVersion)against the provider's catalogue first; if any is absent, the whole request is rejected with404 ADM004002and nothing is written. - Idempotent.
PUT .../productsupserts, and re-adding a previously removed mapping re-activates it. - Stale mappings are hidden.
GET .../productsreturns 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
productKeyreturns404 ADM004010.
Errors
| HTTP | Code | When |
|---|---|---|
404 | ADM004009 | Client slug not found |
404 | ADM004002 | A requested product (productKey, productVersion) is not in the provider catalogue |
404 | ADM004010 | Product mapping not found (delete) |
500 | ADM100001 | Unexpected row count on delete (corruption guard) |