---
updatedAt: 2026-06-29T20:36:51.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 transaction types

List transaction types that match the search parameters. If no search parameters are given, then all transaction types are returned.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "tags": [
    {
      "name": "Transaction types",
      "description": "Endpoints to manage transaction types\n"
    }
  ],
  "info": {
    "title": "Core platform - Transactions",
    "version": "1.0.0",
    "description": "API used to configure transactions domain and get transactions information.",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/transactions-core",
      "description": "Sandbox API server for testing"
    }
  ],
  "components": {
    "parameters": {
      "transactionTypeIdQuery": {
        "in": "query",
        "name": "transactionTypeId",
        "description": "Transaction type ID filter.",
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "example": 101010
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "TransactionTypeId": {
        "type": "integer",
        "format": "int64",
        "description": "Transaction type ID. Certain IDs are reserved by the platform and cannot be used.",
        "minimum": 1
      },
      "ListTransactionTypes": {
        "type": "array",
        "items": {
          "properties": {
            "transaction_type_id": {
              "$ref": "#/components/schemas/TransactionTypeId"
            },
            "description": {
              "type": "string",
              "description": "Transaction type description",
              "maxLength": 30
            },
            "credit": {
              "type": "boolean",
              "description": "Indicates whether the transaction type is a credit (`true`) a debit (`false`)."
            },
            "posted_transaction": {
              "type": "boolean",
              "description": "Indicates whether transactions are posted on statements (`true`) or not (`false`)"
            }
          }
        },
        "example": [
          {
            "transaction_type_id": 7001,
            "description": "Purchase",
            "credit": false,
            "posted_transaction": true
          },
          {
            "transaction_type_id": 7002,
            "description": "Purchase reversal",
            "credit": true,
            "posted_transaction": true
          }
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error description."
          },
          "error": {
            "type": "string",
            "description": "Error description."
          },
          "code": {
            "type": "string",
            "description": "Code description."
          }
        }
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/transaction-types": {
      "get": {
        "tags": [
          "Transaction types"
        ],
        "summary": "List transaction types",
        "description": "List transaction types that match the search parameters. If no search parameters are given, then all transaction types are returned.",
        "operationId": "SearchTransactionTypes",
        "parameters": [
          {
            "$ref": "#/components/parameters/transactionTypeIdQuery"
          },
          {
            "in": "query",
            "name": "description",
            "description": "Wildcard filter used to search transaction types by description.",
            "schema": {
              "type": "string",
              "minLength": 3
            }
          },
          {
            "in": "query",
            "name": "credit",
            "description": "Filters transaction types by credit (`true`) or debit (`false`).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "pageSize",
            "description": "Maximum number of items per page. If not provided, defaults to 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 100
            }
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "Transaction type sort parameter",
            "schema": {
              "type": "string",
              "enum": [
                "transactionId",
                "description"
              ],
              "default": "transactionId"
            }
          },
          {
            "in": "query",
            "name": "pageOffset",
            "description": "Page offset. Indicates which page to start with when returning the results. For example, value `2` returns the third page. Defaults to `0`, which returns the first page.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "has_next": {
                      "type": "boolean",
                      "description": "Indicates whether there are more pages after the current page"
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ListTransactionTypes"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/ErrorResponse"
                    }
                  ]
                },
                "examples": {
                  "invalidFilterValue": {
                    "summary": "Invalid filter value",
                    "value": {
                      "message": "Invalid filter value",
                      "error": "Invalid filter value",
                      "code": "WTRC00001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal error",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/ErrorResponse"
                    }
                  ]
                },
                "examples": {
                  "failedToFetch": {
                    "summary": "Failed to get transaction type",
                    "value": {
                      "message": "Failed to get transaction type",
                      "error": "Failed to get transaction type",
                      "code": "ETRC05001"
                    }
                  },
                  "internalProcessingError": {
                    "summary": "Internal processing error",
                    "value": {
                      "message": "Internal processing error",
                      "error": "Internal processing error",
                      "code": "ETRC00001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```