v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Program attachment

Attach deposit product to program

Attach a time deposit product to a program. This endpoint generates the Program attached event.

At the program scope, deposit_configs.overrides only accepts renewal_term. Sending penalties returns 400 EIBACC0317 and sending maturity_instructions returns 400 EIBACC0318 — apply those per-account instead.

post/v1/deposits/programs/{programId}/attach

Path parameters

programIdstring required

Program 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

product_idstring required

Product identifier.

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",
  "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": "PAYOUT",
    "overrides": {
      "renewal_term": {
        "unit": "MONTHS",
        "value": 6,
        "renewal_calendar_maturity_date": "2027-05-22"
      }
    }
  },
  "metadata": {
    "key": "value"
  }
}

Response

Created

program_idinteger

Program identifier.

product_idstring

Product identifier.

Example response

{
  "program_id": 123,
  "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
  "deposit_configs": {
    "maturity_period": {
      "unit": "MONTHS",
      "value": 6,
      "calendar_maturity_date": "2027-06-15"
    },
    "interest_capitalization_mode": "PAYOUT",
    "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"
      }
    }
  }
}