Skip to main content

UDA endpoints

How to call the connector, grouped by resource. The formal schema is the OpenAPI specification under openapi/source/connector/; these pages are the call contract. Internal processing is in the architecture reference; caveats in the implementation notes.

Authentication & context

All /v1/* business routes require a bearer token (OAuth2 client-credentials JWT). Most also require party context (partyId), which the connector uses to resolve the customer in ULTRACS. Health endpoints are unauthenticated probes; GET /health runs a (heavy) ULTRACS reachability check, while /health/readiness and /health/liveness return 204 (see the architecture reference).

{accountId}, {cardId}, etc. in paths are Ark ids, not ULTRACS ids.

Resource groups

GroupPath prefixPage
Accounts/v1/accountsaccounts
Cards/v1/cardscards
Parties/v1/partiesparties
Payments/v1/paymentspayments
Payees/v1/payeespayees
Statements/v1/parties/statementsstatements
Products/v1/productsproducts
Admin/admin/mappingadmin

Errors

Errors use the domain-coded ErrorResponse envelope (ACC*, PAR*, PAY*, GEN*). Each group page lists the codes it raises. Note two cross-cutting behaviours: an ULTRACS fault with no mapping surfaces as 500 (see the implementation notes), and "customer not found" is handled inconsistently across groups (see the implementation notes).