Skip to main content
Version: 1.0.0

Banking Products API

Consumer Data Right (CDR) aligned banking product catalogue exposed to tenant customer-facing applications.

The list endpoint returns product definitions including category, branding, effectiveness windows, and supplementary information URIs. Filtering by category, brand, effectiveness period, and last-updated timestamp is supported.

Conventions

  • Resource IDs are UUIDs.
  • Errors follow the standard envelope { errorCode, message, timestamp, traceId } where errorCode uses the pattern {DOMAIN}{CLASSIFICATION}{SEQUENCE} (e.g. GEN004001).
  • Pagination is cursor-free (page + page-size); response includes links and meta objects.
  • The product schema is based on CDR Banking API BankingProductV6.

Authentication

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