---
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 flows

List transaction flow configurations that link transaction types and processing codes.

See [Processing codes and transaction types](doc:processing-codes-and-transaction-types) and [Payments configurations](doc:payments-configurations) for information on processing codes and transaction types, how to create them, and map them to each other.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "tags": [
    {
      "name": "Transaction flows",
      "description": "Endpoints to manage the link between transaction types and processing codes."
    }
  ],
  "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
      },
      "TransactionFlow": {
        "required": [
          "transaction_type_id",
          "processing_code",
          "key"
        ],
        "type": "array",
        "items": {
          "properties": {
            "transaction_type_id": {
              "$ref": "#/components/schemas/TransactionTypeId"
            },
            "processing_code": {
              "type": "string",
              "maximum": 6,
              "description": "Processing code that issues the transaction type"
            },
            "key": {
              "type": "string",
              "description": "Sets the relation key that links transaction type and processing code.\n\n* `PRINCIPAL` uses principal amount.\n* `INSTALLMENT` uses installment amount.\n* `CONTRACT` uses contract amount.\n* `OTHER` uses any custom amount, such as fees, taxes, or other charges. When the key is OTHER, you must define the `custom_key` value.\n",
              "enum": [
                "PRINCIPAL",
                "INSTALLMENT",
                "CONTRACT",
                "OTHER"
              ]
            },
            "custom_key": {
              "type": "string",
              "maximum": 200,
              "description": "Sets a customized relation between transaction type and processing code, usually to configure fees, taxes, or other charges. REQUIRED if the key is OTHER."
            }
          }
        },
        "example": [
          {
            "transaction_type_id": 7001,
            "processing_code": "00AB11",
            "key": "OTHER",
            "custom_key": "national_rate"
          },
          {
            "transaction_type_id": 7002,
            "processing_code": "00AB22",
            "key": "OTHER",
            "custom_key": "fee_amount"
          }
        ]
      },
      "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-flow": {
      "get": {
        "tags": [
          "Transaction flows"
        ],
        "summary": "List transaction flows",
        "description": "List transaction flow configurations that link transaction types and processing codes.\n\nSee [Processing codes and transaction types](https://developers.pismo.io/pismo-docs/docs/processing-codes-and-transaction-types) and [Payments configurations](https://developers.pismo.io/pismo-docs/docs/payments-configurations) for information on processing codes and transaction types, how to create them, and map them to each other.\n",
        "operationId": "SearchTransactionFlows",
        "parameters": [
          {
            "in": "query",
            "name": "processingCode",
            "description": "Processing code filter",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/transactionTypeIdQuery"
          },
          {
            "in": "query",
            "name": "pageOffset",
            "description": "Page offset. Indicates which page to start with when returning the results. Defaults to 0.",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "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/TransactionFlow"
                      }
                    }
                  }
                }
              }
            }
          },
          "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": {
                  "internalProcessingError": {
                    "summary": "Internal processing error",
                    "value": {
                      "message": "Internal processing error",
                      "error": "Internal processing error",
                      "code": "ETRC00001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```