---
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.
# Get program V1
Get details for a specific [program](doc:program-types).
# 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": {
"ProgramIdPath": {
"description": "Program ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 12345
}
},
"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": "ISO 3166 Alpha-3 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]"
},
"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"
},
"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
},
"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"
},
"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:
\n `CREDITO` — Full balance credit accounts
\n `PRE-PAGO` — Full balance prepaid accounts
\n `DEBITO` — Full balance debit accounts
\n `MERCHANT` — Merchant accounts
\n `CREDITO ZERO-BALANCE` — Zero balance credit accounts
\n `PRE-PAGO ZERO-BALANCE` — Zero balance prepaid accounts
\n `DEBITO ZERO-BALANCE` — Zero balance debit accounts
\n `CURRENT ACCOUNTS` — Current accounts
\n `INTERNAL ACCOUNTS` — Internal accounts
\n `CORRESPONDENT ACCOUNTS` — Correspondent accounts
\n `VOUCHER` - Prepaid voucher meal/food card
\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 IANA (Internet Assigned Numbers Authority) time zone database \"Region/City\" format.\n",
"example": "America/Anchorage"
},
"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/{id}": {
"get": {
"summary": "Get program V1",
"description": "Get details for a specific [program](https://developers.pismo.io/pismo-docs/docs/program-types).",
"operationId": "get-program-v1",
"tags": [
"Programs"
],
"parameters": [
{
"$ref": "#/components/parameters/ProgramIdPath"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Program"
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
}
}
}
}
}
}
```