Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Account attachment

Update deposit account attachment overrides

Partially updates deposit_configs.overrides and deposit_configs.interest_capitalization_mode on an active deposit account attachment. Each field is processed using three‑state PATCH semantics, allowing values to be added, changed, or cleared as part of the update.

  • Omitted: Keeps the current value
  • null: Removes the override; falls back through the cascade (program → product)
  • Value: Replaces the current override with the supplied value

NOTES:

  • At least one of deposit_configs.overrides or deposit_configs.interest_capitalization_mode must be provided.
  • The overrides envelope, if provided, must contain at least one field. Sending an empty object returns 400 EIBACC0315.
  • renewal_term still requires ROLLOVER configured in maturity_instructions somewhere in the fallback sequence (400 EIBACC0310 otherwise).

This endpoint generates an Account attachment updated event.

patch/v1/deposits/accounts/{accountId}/attachment

Path parameters

accountIdinteger required

Account ID

Headers

AuthorizationTokenstring required

Account token. Token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

Request body

Example request

{
  "deposit_configs": {
    "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": "Update — Q1 2027 VIP retention package"
      }
    }
  }
}

Response

OK

account_idinteger

Pismo account ID

attach_datetimestring date-time

Datetime when the product was attached to the account. Format: YYYY-MM-DDThh:mm:ss.sss.

statusstring

Status of the product attachment

metadataobject

Additional details about the product attachment. The information must be in key:value pair format. For example, name:<your_name>.<br> minLength = 0 maxLength = 1024<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 response

{
  "overdraft": {
    "name": "Overdraft Limit 1000",
    "processing_code": "99066"
  }
}