Skip to main content

​
[0.8.6] - 2026-02-21

​
Added

  • Events: Added endpoints for creating events and retrieving event types, and introduced default event types.
  • Notifications: Added merchantId to email and SMS DTOs.
  • Webhooks: Updated createWebhookEndpoint to include session data and gracefully handle invalid event types.

​
Changed

  • Checkout: Simplified session listing logic and removed image URL attachment.
  • Auth: Commented out IsUrl validation for callback URLs in DTOs.
  • Lookup: Refactored the retrieval logic for event types to integrate default event types.

​
Fixed

  • Auth: Corrected example URLs in DTOs to point to the correct domain and provided a default callback URL.

​
[0.8.4] - 2026-02-18

​
Added

  • Checkout: Enhanced Checkout Sessions with hostedCheckoutConfig, totalAmount, and improved line item support (including images).
  • Payment Links: Added line items and hosted checkout configuration to Payment Links.
  • iVeri Integration:
    • Full 3DS integration for Checkout Session and Payment Intent confirmation.
    • Redirect support and enhanced card normalization.
    • Added caching for plaintext card data to support 3DS callbacks.
  • Events: Added createEventsForType method for streamlined webhook event emission.
  • Products: New endpoint to retrieve multiple products by a list of IDs.
  • SDK: Added Makefile for managing SDK pulls and updates.

​
Changed

  • DTOs: Enhanced validation for line items and updated Evervault encryption DTOs.
  • Storage: Updated S3 bucket naming and added folder support for object keys.
  • Logging: Added configurable log level to Winston console transport.

​
Fixed

  • iVeri: Corrected 3DS return form field names and added ECI whitelist validation.
  • Seeding: Enhanced seeders with dynamic product selection and automated amount calculation.

​
Documentation

  • Updated module READMEs and payment flow documentation to reflect iVeri 3DS and enhanced checkout features.

​
[0.7.0] - 2026-01-25

​
Added

  • Authentication: GET /api/canary/authentication/token (JWT issuance) and GET /api/canary/authentication/jwks (JWKS) for public key discovery and token validation.
  • Transfers: New transfers APIs for creating and listing transfers:
    • POST /api/canary/transfers — create a transfer between customers.
    • GET /api/canary/transfers — list transfers for the authenticated merchant with limit/offset pagination.
  • Products: Product responses now include imageId and imageUrl (public image URL) to support product images.
  • Storage: File metadata now includes isPublic and upload/confirm examples updated for public product images.
  • Pagination: List endpoints now return consistent pagination metadata (limit, offset, total, hasMore).

​
Changed

  • OpenAPI / Swagger: Specs and examples updated to include the new endpoints and schemas; server entries are clearer for Testing / Live environments.

​
Fixed

  • Transfers: Improved validation (amount must be > 0, cannot transfer to same customer) and clearer error mapping for insufficient balance and other conditions.
  • List responses: Consistent pagination metadata across endpoints.

​
Documentation

  • Updated DTO examples and module READMEs for Authentication, Transfers, Products, and Storage. Swagger specs and SDK generation artifacts were updated to reflect the new APIs.

​
[0.6.1] - 2026-01-17

​
Changed

  • API Documentation URL: Updated the API documentation URL in the TypeScript SDK generator configuration to https://api.cashful.africa/reference.
  • API Environments: Added distinct server entries for Live, and Testing environments in the Swagger documentation.

​
[0.6.0] - 2026-01-17

​
Changed

  • Prisma Schema Alignment: Refactored multiple modules to align with Prisma schema:
    • Balance, Customers, Events, Payment Intents, Payment Links
    • Payment Methods, Products, Storage, Webhooks
  • Logging Module: Enhanced logging infrastructure with improved configuration.
  • OpenAPI Spec: Updated API specifications to reflect current implementation.

​
Fixed

  • Balance Module: Removed unused CommonModule import.
  • Compliance Module: Fixed getCompliance to retrieve exactly one record matching the organizationId.

​
[0.5.0] - 2026-01-15

​
Added

  • Products API: Introduced a new set of endpoints for managing products (/api/canary/products).
    • POST /api/canary/products to create a product.
    • GET /api/canary/products to list products with pagination and filtering.
    • PATCH /api/canary/products/{id} to update product details.
  • Storage Service: Added a comprehensive storage API for accessible and secure file management.
    • POST /api/canary/storage/upload-url: Request a pre-signed URL for secure file uploads.
    • POST /api/canary/storage/confirm-upload: Confirm a successful upload and register the file.
    • GET /api/canary/storage: List uploaded files with support for filtering by tags (e.g., ‘compliance’).
    • GET /api/canary/storage/{id}/download-url: Generate a temporary download URL for a file.
  • Compliance API: Introduced endpoints for managing compliance entities, fully integrated with the new Storage Service.
    • POST /api/canary/compliance: Create compliance records.
    • PATCH /api/canary/compliance/{id}: Update compliance information.

​
Changed

  • OpenAPI Spec: Bumped API version from 0.4.0 to 0.5.0 to reflect breaking changes and new features.