Program attachment

Attach savings accounts to program

Attach a savings accounts product to a program. This endpoint generates the Program attached event.

post/v1/savings-accounts/programs/{programId}/attach

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/savings-accounts/programs/{programId}/attach
  • Auth
    none declared. Required headers: AuthorizationToken

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 ID

metadataobject

The metadata object contains user-defined key-value pairs that offer additional context or custom information.<br> The platform has no control over its content, it's 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",
  "metadata": {
    "key": "value"
  }
}

Response

Success - No Content

Changes

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