---
updatedAt: 2026-05-04T20:47:50.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# List programs

List an organization's programs. The organization ID is parsed from the token.

For information about programs and organizations, refer to [Core objects](doc:setup-overview).


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Platform setup - Programs",
    "description": "Endpoints to handle Programs",
    "version": "v1.0",
    "contact": {
      "name": "Pismo Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Programs",
      "description": "Create and manage programs"
    }
  ],
  "components": {
    "parameters": {
      "BinValueQuery": {
        "name": "binValue",
        "in": "query",
        "description": "Bank Identification Number (BIN) value filter. Card network-issued 6 or 8 digit value identifying the card network, issuer, and product.",
        "schema": {
          "type": "string",
          "maxLength": 8
        },
        "example": "123456"
      },
      "OrderByQuery": {
        "name": "orderBy",
        "in": "query",
        "description": "Field to sort on. Default = `ID`.",
        "schema": {
          "type": "string",
          "enum": [
            "ID",
            "NAME"
          ]
        },
        "example": "NAME"
      },
      "OrderQuery": {
        "name": "order",
        "in": "query",
        "description": "Sort order. Default = `ASC`.",
        "schema": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        },
        "example": "DESC"
      },
      "PageQuery": {
        "name": "page",
        "in": "query",
        "description": "Current page number. Must be greater than `0`. Default = `1`.",
        "schema": {
          "type": "integer",
          "format": "int32"
        },
        "example": 2
      },
      "PerPageQuery": {
        "name": "perPage",
        "in": "query",
        "description": "Maximum number of items per page. Must be greater than `0`. Default = `10`.",
        "schema": {
          "type": "integer",
          "format": "int32"
        },
        "example": 20
      },
      "ProgramIdQuery": {
        "name": "id",
        "in": "query",
        "description": "Program ID filter",
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "example": 12345
      },
      "ProgramNameQuery": {
        "name": "name",
        "in": "query",
        "description": "Program name filter",
        "schema": {
          "type": "string",
          "maxLength": 50
        },
        "example": "Pismolabs"
      },
      "ProgramTypeQuery": {
        "name": "type",
        "in": "query",
        "description": "Program type:<br />\n  `CREDITO` — Full balance credit accounts<br />\n  `PRE-PAGO` — Full balance prepaid accounts<br />\n  `DEBITO` — Full balance debit accounts<br />\n  `MERCHANT` — Merchant accounts<br />\n  `CREDITO ZERO-BALANCE` — Zero balance credit accounts<br />\n  `PRE-PAGO ZERO-BALANCE` — Zero balance prepaid accounts<br />\n  `DEBITO ZERO-BALANCE` — Zero balance debit accounts<br />\n  `CURRENT ACCOUNTS` — Current accounts<br />\n  `INTERNAL ACCOUNTS` — Internal accounts<br />\n  `CORRESPONDENT ACCOUNTS` — Correspondent accounts<br />\n  `VOUCHER` - Prepaid voucher meal/food card<br />\n\nFor more information, refer to [Program types](https://developers.pismo.io/pismo-docs/docs/program-types).\n",
        "schema": {
          "type": "string",
          "enum": [
            "CREDITO",
            "PRE-PAGO",
            "DEBITO",
            "MERCHANT",
            "CREDITO ZERO-BALANCE",
            "PRE-PAGO ZERO-BALANCE",
            "DEBITO ZERO-BALANCE",
            "CURRENT ACCOUNTS",
            "INTERNAL ACCOUNTS",
            "CORRESPONDENT ACCOUNTS",
            "VOUCHER"
          ],
          "maxLength": 30
        },
        "example": "CURRENT ACCOUNTS"
      }
    },
    "schemas": {
      "BaseProgramID": {
        "type": "integer",
        "format": "int64",
        "description": "ID of program that was used to create this program.",
        "example": 2
      },
      "Bin": {
        "type": "object",
        "description": "Bank Identification Number (BIN) object. **REQUIRED** for card-issuing programs. \n",
        "properties": {
          "start_range": {
            "type": "string",
            "description": "BIN range start.  **REQUIRED** for card-issuing programs.",
            "example": "0"
          },
          "end_range": {
            "type": "string",
            "description": "BIN range end.  **REQUIRED** for card-issuing programs.",
            "example": "999999999"
          },
          "value": {
            "type": "string",
            "description": "Card network-issued Bank Identification Number (BIN). \n6 or 8-digit BIN identifying the card network, issuer, and product.\n **REQUIRED** for card-issuing programs.\n",
            "example": "999999"
          }
        }
      },
      "Brand": {
        "type": "string",
        "description": "Program's card brand.  **REQUIRED** for card-issuing programs.\n",
        "enum": [
          "VISA",
          "MASTERCARD",
          "ELO",
          "RUPAY",
          "PRIVATE",
          "CABAL",
          "GOODCARD",
          "GPN"
        ],
        "example": "VISA"
      },
      "CountryCode": {
        "type": "string",
        "description": "<a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3\" target=\"_blank\">ISO 3166 Alpha-3</a> program country code. For example, `BRA` = Brazil.",
        "example": "BRA"
      },
      "CreatedAt": {
        "type": "string",
        "description": "Program creation datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2021-07-06T13:11:05Z"
      },
      "CSS": {
        "type": "string",
        "description": "Card image. [Legacy - restricted]"
      },
      "CurrentPage": {
        "type": "integer",
        "format": "int32",
        "description": "Current page",
        "example": 1
      },
      "CurrencyNumericCode": {
        "type": "string",
        "description": "Program ISO 4217 currency code.",
        "example": "986"
      },
      "handler.HTTPError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Bad request code",
            "example": "EOA0017"
          },
          "message": {
            "type": "string",
            "description": "Bad request response",
            "example": "Bad Request"
          }
        }
      },
      "InitialCardStatus": {
        "type": "string",
        "enum": [
          "CREATED",
          "BLOCKED",
          "UNBLOCKED"
        ],
        "description": "Initial status for cards created in this program.",
        "example": "CREATED"
      },
      "Pages": {
        "type": "integer",
        "format": "int32",
        "description": "Number of pages",
        "example": 1
      },
      "PerPage": {
        "type": "integer",
        "format": "int32",
        "description": "Maximum items per page",
        "example": 10
      },
      "PrintCardBoolean": {
        "type": "boolean",
        "description": "Should physical cards be issued by default on creation? Default is `false`. [Legacy - restricted]",
        "example": true
      },
      "Program": {
        "type": "object",
        "properties": {
          "bin": {
            "$ref": "#/components/schemas/Bin"
          },
          "brand": {
            "$ref": "#/components/schemas/Brand"
          },
          "css": {
            "$ref": "#/components/schemas/CSS"
          },
          "id": {
            "$ref": "#/components/schemas/ProgramID"
          },
          "base_program_id": {
            "$ref": "#/components/schemas/BaseProgramID"
          },
          "initial_card_status": {
            "$ref": "#/components/schemas/InitialCardStatus"
          },
          "name": {
            "$ref": "#/components/schemas/ProgramName"
          },
          "print_card": {
            "$ref": "#/components/schemas/PrintCardBoolean"
          },
          "provider": {
            "$ref": "#/components/schemas/Provider"
          },
          "type": {
            "$ref": "#/components/schemas/ProgramType"
          },
          "url_image": {
            "$ref": "#/components/schemas/UrlImage"
          },
          "currency_numeric_code": {
            "$ref": "#/components/schemas/CurrencyNumericCode"
          },
          "timezone": {
            "$ref": "#/components/schemas/TimeZone"
          },
          "country_code": {
            "$ref": "#/components/schemas/CountryCode"
          },
          "created_at": {
            "$ref": "#/components/schemas/CreatedAt"
          },
          "status": {
            "$ref": "#/components/schemas/ProgramStatus"
          },
          "language": {
            "$ref": "#/components/schemas/ProgramLanguage"
          },
          "cycle_closing": {
            "$ref": "#/components/schemas/ProgramCycleClosing"
          },
          "holiday_calendar_id": {
            "$ref": "#/components/schemas/ProgramHolidayCalendarId"
          }
        }
      },
      "ProgramID": {
        "type": "integer",
        "format": "int64",
        "description": "Program ID",
        "example": 12345
      },
      "ProgramItems": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Program"
        }
      },
      "ProgramName": {
        "type": "string",
        "description": "Program name",
        "maxLength": 50,
        "example": "Acme debit program"
      },
      "ProgramLanguage": {
        "type": "string",
        "description": "Program Language:\n\n* `en-US` - US English\n* `pt-BR` - Brazilian Portuguese\n\nDefault is `en-US`\n",
        "enum": [
          "pt-BR",
          "en-US"
        ],
        "example": "en-US"
      },
      "ProgramHolidayCalendarId": {
        "type": "string",
        "description": "Program holiday calendar ID",
        "maxLength": 36,
        "example": "0c78714f-3e88-40f3-9eda-debd356faabc"
      },
      "ProgramCycleClosing": {
        "type": "string",
        "description": "Program cicle closing. \n\nThis field is used for things like accrual basis, interest calculation, taxes, penalties, tiers, and more.  \n\nFormat = HH:MM:SS. Default is null.\n",
        "example": "23:59:59"
      },
      "ProgramPage": {
        "type": "object",
        "properties": {
          "current_page": {
            "$ref": "#/components/schemas/CurrentPage"
          },
          "items": {
            "$ref": "#/components/schemas/ProgramItems"
          },
          "pages": {
            "$ref": "#/components/schemas/Pages"
          },
          "per_page": {
            "$ref": "#/components/schemas/PerPage"
          },
          "total_items": {
            "$ref": "#/components/schemas/TotalItems"
          }
        }
      },
      "ProgramStatus": {
        "type": "string",
        "description": "Program status:\n * `ACTIVE` - A program is active when PCI settings and accounting stages are configured.\n * `PENDING` - A program is pending when PCI settings and accounting stages are not configured. A program that is pending is not ready for use.\n",
        "enum": [
          "ACTIVE",
          "PENDING"
        ],
        "example": "PENDING"
      },
      "ProgramType": {
        "type": "string",
        "description": "Program type:<br />\n  `CREDITO` — Full balance credit accounts<br />\n  `PRE-PAGO` — Full balance prepaid accounts<br />\n  `DEBITO` — Full balance debit accounts<br />\n  `MERCHANT` — Merchant accounts<br />\n  `CREDITO ZERO-BALANCE` — Zero balance credit accounts<br />\n  `PRE-PAGO ZERO-BALANCE` — Zero balance prepaid accounts<br />\n  `DEBITO ZERO-BALANCE` — Zero balance debit accounts<br />\n  `CURRENT ACCOUNTS` — Current accounts<br />\n  `INTERNAL ACCOUNTS` — Internal accounts<br />\n  `CORRESPONDENT ACCOUNTS` — Correspondent accounts<br />\n  `VOUCHER` - Prepaid voucher meal/food card<br />\n\nFor more information, refer to [Program types](https://developers.pismo.io/pismo-docs/docs/program-types)\n",
        "enum": [
          "CREDITO",
          "PRE-PAGO",
          "DEBITO",
          "MERCHANT",
          "CREDITO ZERO-BALANCE",
          "PRE-PAGO ZERO-BALANCE",
          "DEBITO ZERO-BALANCE",
          "CURRENT ACCOUNTS",
          "INTERNAL ACCOUNTS",
          "CORRESPONDENT ACCOUNTS",
          "VOUCHER"
        ],
        "example": "CREDITO"
      },
      "Provider": {
        "type": "object",
        "description": "[Legacy - restricted]",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Provider ID (outdated)",
            "example": 12
          },
          "name": {
            "type": "string",
            "description": "Provider name (outdated)",
            "example": "Acme Services"
          }
        }
      },
      "TimeZone": {
        "type": "string",
        "description": "Program timezone. This is the <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"_blank\"> IANA (Internet Assigned Numbers Authority) time zone database</a> \"Region/City\" format.\n",
        "example": "America/Anchorage"
      },
      "TotalItems": {
        "type": "integer",
        "format": "int32",
        "description": "Total number of items",
        "example": 3
      },
      "UrlImage": {
        "type": "string",
        "description": "Program image URL [Legacy - restricted]"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/handler.HTTPError"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "S2SAuthentication": {
        "type": "http",
        "scheme": "bearer",
        "description": "All requests must be previoulsy authenticated."
      }
    }
  },
  "security": [
    {
      "S2SAuthentication": []
    }
  ],
  "paths": {
    "/programs/v1/programs": {
      "get": {
        "summary": "List programs",
        "description": "List an organization's programs. The organization ID is parsed from the token.\n\nFor information about programs and organizations, refer to [Core objects](https://developers.pismo.io/pismo-docs/docs/setup-overview).\n",
        "operationId": "programs",
        "tags": [
          "Programs"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/PageQuery"
          },
          {
            "$ref": "#/components/parameters/PerPageQuery"
          },
          {
            "$ref": "#/components/parameters/OrderQuery"
          },
          {
            "$ref": "#/components/parameters/OrderByQuery"
          },
          {
            "$ref": "#/components/parameters/ProgramIdQuery"
          },
          {
            "$ref": "#/components/parameters/ProgramNameQuery"
          },
          {
            "$ref": "#/components/parameters/ProgramTypeQuery"
          },
          {
            "$ref": "#/components/parameters/BinValueQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProgramPage"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          }
        }
      }
    }
  }
}
```