v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Product

List products

Return a list of an organization's savings and time-deposit accounts.

get/v1/products

Query parameters

beginDatetimestring date-time

Queries for the date and time of products after the value of this field. Date and time are displayed in RFC 3339 format, for example: 2024-01-28T10:33:01Z.

endDatetimestring date-time

Queries for the date and time of products created before the value of this field. Date and time are displayed in RFC 3339 format, for example: 2024-01-29T10:33:01Z.

afterIdinteger

This is the last_id field returned in the response which you can use to get the next result set. This is displayed in UNIX timestamp.

perPagestring

Cards per page. Default is 10. To navigate between pages, set format=paged.

order'ASC' | 'DESC'

List result order of the created_at value. It can be sorted in ascending (ASC) or descending (DESC) order. Default is DESC.

productType'deposit' | 'savings-account'

Filter results by product type.

statusstring[]

Card status filter:

If nothing is passed, cards with status CREATED, NORMAL, and BLOCKED are returned.
If ALL is passed, all cards, regardless of status, are returned.
If one or more specific statuses are passed, cards with those statuses are returned.

Refer to the Card lifecycle and statuses guide for more information and a complete status list.

Headers

AuthorizationTokenstring required

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

Response

Success

last_idinteger

Pagination reference, displayed in UNIX timestamp.

next_pageboolean

Indicates whether there is a next page of results.

per_pageinteger

Number of items per page. Default 20, maximum is 100.

Example response

{
  "last_id": 1706027185000,
  "next_page": true,
  "per_page": 20,
  "items": {
    "created_at": "2024-01-23T13:26:25.000Z",
    "funding_duration": 12,
    "interest_plan_id": "263d509a-d5d0-4b3a-b909-ce1b9174beff",
    "maturity_instructions": {
      "principal": "ROLLOVER",
      "interest": "PAY"
    },
    "min_amount": 1000,
    "max_amount": 5000,
    "min_term": 265,
    "max_term": 1025,
    "grace_period_duration_days": 30,
    "name": "Tax 1 Default",
    "penalties": {
      "early_withdrawal_after_opening": {
        "applicable_within_days": 30,
        "penalty_interest_days": 90
      },
      "grace_period": {
        "duration_days": 7,
        "penalty_interest_days": 30
      },
      "tiered_interest_forfeiture": [
        {
          "min_days_held": 1,
          "max_days_held": 90,
          "forfeited_interest_days": 30
        }
      ],
      "withdrawal_fee": {
        "type": "PERCENTAGE",
        "value": 1.5
      },
      "subsequent_withdrawals": {
        "applicable_within_days": 30,
        "window_behavior": "ROLLING",
        "penalty_interest_days": 7
      }
    },
    "notices": [
      {
        "days_before_maturity": 30,
        "description": "30-day advance notice"
      }
    ],
    "processing_codes": {
      "interest_processing_code": "009797",
      "detach_processing_code": "009696"
    },
    "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
    "status": "ACTIVE",
    "term_type": "FIXED",
    "start_date": "2025-11-01",
    "end_date": "2027-12-31",
    "metadata": {
      "key": "value"
    },
    "updated_at": "2024-01-23T13:26:25.000Z"
  }
}