Deposit account lifecycle

Get cycle snapshot for deposit account

Return a consolidated point‑in‑time snapshot of a deposit account lifecycle, providing current and previous cycle details such as active and prior product attachments, key dates (cycle start, maturity, rollover), interest plan information, and principal context to support audit, statement, and reconciliation use cases.

get/v1/deposits/accounts/{accountId}/cycle-snapshot

Request

Base URL
https://sandbox.pismolabs.io/savings-products
URL
https://sandbox.pismolabs.io/savings-products/v1/deposits/accounts/{accountId}/cycle-snapshot
Auth
HTTP bearer

Path parameters

accountIdinteger required

Account ID

Response

Cycle snapshot returned successfully

account_idinteger

Deposit account ID

status'ACTIVE' | 'INACTIVE'

Cycle status, this can be either ACTIVE or INACTIVE

current_product_idstring

Product ID currently attached to the account

current_attachment_idstring

Current attachment ID

current_interest_plan_idstring

Current interest plan ID

current_grace_periodinteger

Grace‑period duration in days for the current cycle. For non‑first cycles, the grace window opens at the start of the cycle, spanning cycle_start_date, cycle_start_date + current_grace_period. The first cycle does not include a grace window.

current_rollover_datestring date-time

Date the current cycle rolls into the next one (current_calendar_maturity_date + 1 or the next cycle’s cycle_start_date). Rollover occurs at the maturity date, so grace no longer sits between maturity and rollover. Format = yyyy-mm-ddThh:mm:ss.sssZ.

current_calendar_maturity_datestring date-time

Maturity date of the current cycle. Uses inclusive day count (day 1 is cycle_start_date). For the first cycle, the maturity date is cycle_start_date + term - 1. For a renewed cycle, the maturity date is cycle_start_date + current_grace_period + term - 1 because grace extends the cycle. Format = yyyy-mm-ddThh:mm:ss.sssZ.

previous_product_idstring

Previous product ID

previous_attachment_idstring

Previous attachment ID

previous_interest_plan_idstring

Previous interest plan ID

previous_grace_periodinteger

Previous grace period in days

previous_calendar_maturity_datestring date-time nullable

Previous calendar maturity date. The datetime format follows the ISO 8601 standard yyyy-mm-ddThh:mm:ss.sssZ.

cycle_start_datestring date-time

Cycle start date. The datetime format follows the ISO 8601 standard yyyy-mm-ddThh:mm:ss.sssZ.

start_datestring date-time

Start date of the cycle. The datetime format follows the ISO 8601 standard yyyy-mm-ddThh:mm:ss.sssZ.

Example response

{
  "account_id": 1234567,
  "status": "ACTIVE",
  "current_product_id": "ze2b8k77-f6a0-4ba4-890a-0dc23f13fhg4",
  "current_attachment_id": "1234test",
  "current_interest_plan_id": "ee2b8b77-f6a0-4ba4-890a-0dc23f13fcb4",
  "current_grace_period": 10,
  "current_rollover_date": "2026-02-01T00:00:00Z",
  "current_calendar_maturity_date": "2026-01-26T12:00:00Z",
  "previous_product_id": "ae2b8k77-f6a0-4ba4-890a-0dc23f13fcb4",
  "previous_attachment_id": "attach685",
  "previous_interest_plan_id": "ee2b8b77-f6a0-4ba4-890a-0dc23f13fcb4",
  "previous_grace_period": 5,
  "previous_calendar_maturity_date": "2025-12-01T00:00:00Z",
  "cycle_start_date": "2026-01-26T12:00:00Z",
  "start_date": "2024-12-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.