Skip to main content

UDA endpoints — products

How to call the product routes. The formal schema is the OpenAPI specification (openapi/source/connector/products/); this page is the call contract. Internal processing is in the architecture reference; caveats in the implementation notes.

Both routes require a bearer token only — they are connector catalogue config, not party-scoped, so no partyId is required.

MethodPathCodePurpose
PUT/v1/products200Create or update products and their card products
GET/v1/products200List active products and card products

Notes for callers

  • Create or update (PUT /v1/products) takes { products: [...] }. Each product is keyed on coreBankingProductKey; each card product on its product + physicality type. active: false soft-deletes. productKey is generated by the connector when omitted on first create. The operation is applied per product (not as one transaction across the whole batch), so a partial failure can leave some products updated and others not (see the implementation notes).
  • List returns only active products and active card products. Card products always report collectionMethod: Mail regardless of what was stored (see the implementation notes).
  • These products are the catalogue the card and account routes resolve against — order a card and the account's product must have a matching card product here.

Errors

HTTPCodeWhen
400GEN000000request body fails schema validation; also covers an unknown card physicality type (thrown as SCHEMA_VALIDATION_ERROR in products.repository.ts)
500ADM100001an unsupported card brand or product category