Account attachment

Attach deposit to account

Attach a time deposit product to an account. This endpoint generates the Account attached event.

post/v1/deposits/accounts/{accountId}/attach

Request

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

Path parameters

accountIdstring required

Account ID. Accepts either the Pismo account_id or your external_account_id. Send the same ID used to generate the access token.

Request body

product_idstring required

Product identifier.

effective_datestring date

Backdated effective date for the attachment in YYYY-MM-DD format. This is the date starting from which the attachment is considered valid.

If omitted, it defaults to the current date
Must be less than or equal to the current date (cannot be in the future)
Cannot be more than ATTACHMENT_MAX_BACKDATING_DAYS (default: 90 days) in the past
Maturity date is calculated from this date, not from the date when you call the API.
No retroactive interest accrual, capitalization, or postings are triggered

metadataobject

The metadata object contains user-defined key-value pairs that provide additional context or custom information.<br> The platform has no control over its content, but rather controlled by the user.<br>

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example request

{
  "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
  "effective_date": "2025-12-01",
  "deposit_configs": {
    "maturity_period": {
      "unit": "MONTHS",
      "value": 6,
      "calendar_maturity_date": "2027-06-15"
    },
    "payout_account": {
      "label": "My payout account",
      "type": "INTERNAL",
      "internal_account_id": 123456,
      "external_account": {
        "key": "value"
      }
    },
    "interest_capitalization_mode": "REINVEST",
    "overrides": {
      "maturity_instructions": {
        "principal": "ROLLOVER",
        "interest": "PAY",
        "reason": "Customer preference at onboarding"
      },
      "renewal_term": {
        "unit": "MONTHS",
        "value": 6,
        "renewal_calendar_maturity_date": "2027-05-22"
      },
      "penalties": {
        "reason": "Q4 2026 VIP retention package",
        "withdrawal_fee": {
          "value": 1.5
        }
      }
    }
  },
  "metadata": {
    "key": "value"
  }
}

Response

Created

account_idinteger

Account ID

product_idstring

Product ID

external_account_idstring

External account ID. Returned only when the account has an external account identifier.

effective_datestring date

The effective value date of the attachment. Format is YYYY-MM-DD. This is the date when the attachment becomes valid. Maturity is calculated from this date.

Example response

{
  "account_id": 123456,
  "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
  "external_account_id": "ext-acct-001",
  "effective_date": "2025-12-01",
  "deposit_configs": {
    "maturity_period": {
      "unit": "MONTHS",
      "value": 6,
      "calendar_maturity_date": "2027-06-15"
    },
    "interest_capitalization_mode": "REINVEST",
    "accrual_model": "DEPOSIT_BASIS",
    "balance_type": "VALUE_DATED_BALANCE",
    "overrides": {
      "maturity_instructions": {
        "principal": "ROLLOVER",
        "interest": "PAY",
        "reason": "Customer preference at onboarding"
      },
      "renewal_term": {
        "unit": "MONTHS",
        "value": 6,
        "renewal_calendar_maturity_date": "2027-05-22"
      },
      "penalties": {
        "reason": "Q4 2026 VIP retention package",
        "withdrawal_fee": {
          "value": 1.5
        }
      }
    }
  }
}

Changes

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