Changelog

All notable changes to the enza TX API documentation are documented in this page.

---

v2.0.0

Released: June 2026

New major API version line published at /TX/v2, alongside /TX/v1 (legacy, still supported).

Added

• RESTful resource model — verbs removed from paths, plural collections, kebab-case naming
• PATCH for partial updates; the safe {cardId} lives in the path, not the body
• Idempotency — Idempotency-Key (UUID v4) header required on every write (POST/PATCH); same key + same body within 24h replays the original response
• ApiKeyAuth security scheme — API key formally declared via x-api-key

Changed

• Sensitive identifiers (PAN, account number, national id) stay in the request body, never the URL
• Mailing/delivery address uses countryCode (ISO 3166-1 numeric, e.g. 826) instead of countryId
• Unenveloped responses — success returns the resource at the root plus a meta sidecar; errors return { code, message, details? }
• Resource creation returns 201

API Base Path

Environment	Base URL
UAT	https://uat-api.enza.cloud/TX/v2

---

v1.1.3

Released: April 30, 2026

Changed

• Updated /cards/joint-account endpoint to require cards for both customers
  • Made primaryCard and secondaryCard required fields
  • Removed support for account-only scenarios
  • Updated validation to ensure both card objects are provided with cardProductRid
  • Updated response schema to always include card details for both customers
  • Simplified examples to reflect the single valid scenario

---

v1.1.2

Released: April 27, 2026

Changed

• Enhanced /cards/joint-account endpoint with flexible card issuance options
  • Removed accountTypeRid requirement
  • Added support for 3 scenarios:
    1. Account Only (No Cards)
    2. Account + Primary Customer Card
    3. Account + Both Customer Cards
  • Updated request schema with optional primaryCard and secondaryCard objects
  • Updated response schema to handle optional card details
  • Added comprehensive examples for all scenarios

---

v1.1.1

Released: April 6, 2026

Changed

• Enhanced transaction management endpoint documentation
  • Added comprehensive descriptions for transaction types (Goods, Cash, CashDec, CashInc, Return)
  • Clarified settlement status logic (Presentment vs Unsettled)
  • Improved date range handling documentation
  • Updated examples to reflect correct status values

---

v1.1.0

Released: March 30, 2026

Added

• New endpoint GET /products/accounts to retrieve account types (financial contract types) available for a financial institution
• Supports retrieving contract types like AccountPrepaidAPI, CBSFinancialContractTypeAPI, GHSAccountPrepaidAPI

---

v1.0.0

Released: March 17, 2026

Added

• Initial release of TX API documentation
• Card issuance endpoints (physical, virtual, prepaid, debit, supplementary)
• Customer management endpoints
• Account management endpoints
• Card lifecycle management (renewal, reissuance, replacement)
• Card controls (status, security settings, risk levels)
• PIN management operations
• Money transfer functionality
• Limits and holds management
• Transaction monitoring capabilities

API Base Path

Environment	Base URL
UAT	https://uat-api.enza.cloud/TX/v1

Notes

This is the first stable release of the enza TX API documentation. The public API version is v1 and follows the URL path /TX/v1.