---
updatedAt: 2026-05-29T16:44:17.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 payment requests

List previously created payment requests. Filter with either (but not both) account ID in `from` or `to`.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Core platform - Payment methods",
    "version": "1.0.0",
    "description": "API to handle payments.",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    },
    {
      "url": "https://gw-pci.pismolabs.io",
      "description": "Sandbox PCI API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Payment requests",
      "description": "APIs to manage payment requests."
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "ErrorModel": {
        "description": "API generic returned error.",
        "type": "object",
        "properties": {
          "error_code": {
            "type": "string",
            "description": "Error code.",
            "deprecated": true
          },
          "code": {
            "type": "string",
            "description": "Error code."
          },
          "message": {
            "type": "string",
            "description": "Error description."
          }
        },
        "title": "ErrorModel"
      },
      "Location": {
        "properties": {
          "lat": {
            "description": "Request latitude.",
            "type": "number",
            "format": "float",
            "example": 12.2
          },
          "lng": {
            "description": "Request longitude.",
            "type": "number",
            "format": "float",
            "example": -12.2
          }
        },
        "description": "Request latitude and longitude object.",
        "title": "Location"
      },
      "PaymentRequestItemResponse": {
        "type": "object",
        "title": "PaymentRequestItemResponse",
        "description": "Response object from `GET v1/payment-requests`.",
        "additionalProperties": false,
        "properties": {
          "amount": {
            "type": "number",
            "minimum": 0.01,
            "example": 9.95,
            "description": "Payment request amount."
          },
          "processing_code": {
            "type": "string",
            "description": "Payment request processing code.",
            "example": "004000"
          },
          "to": {
            "type": "integer",
            "minimum": 1,
            "example": 10,
            "description": "Target account ID."
          },
          "expiration": {
            "type": "string",
            "description": "Payment request expiration date in UTC-0 (RFC3339) format.",
            "example": "2020-05-11T10:39:00.000Z"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "tracking_id": {
            "type": "string",
            "description": "Optional unique ID correlating the payment request's associated credit and debit authorizations.",
            "example": "1ff51e99-3a05-448a-bc19-7b5c05274174"
          },
          "status": {
            "$ref": "#/components/schemas/PaymentRequestStatus"
          },
          "id": {
            "type": "string",
            "example": "0f45e7a3-0d9e-4454-be8b-c74a58427946",
            "description": "Payment request unique ID."
          },
          "creation_date": {
            "type": "string",
            "format": "date-time",
            "description": "Payment request creation date in UTC-0 (RFC3339) format.",
            "example": "2020-06-11T10:39:00.000Z"
          },
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          }
        }
      },
      "PaymentRequestStatus": {
        "description": "Payment request status",
        "type": "string",
        "enum": [
          "PAID",
          "PENDING",
          "EXPIRED",
          "DELETED",
          "REJECTED",
          "CANCELLED",
          "ACTIVE"
        ]
      },
      "Metadata": {
        "type": "object",
        "description": "This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. \n\nThe Pismo platform does not perform any validation or processing on this field but passes this object to the acquirer in transactions involving calls to the acquirer and sends it in the events related to the stream of data produced at the end of the request.\n\n**Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).\n",
        "example": {
          "any-key": "any-value"
        }
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/payments/v1/payment-requests": {
      "get": {
        "operationId": "get-payments-v1-payment-requests",
        "summary": "List payment requests",
        "description": "List previously created payment requests. Filter with either (but not both) account ID in `from` or `to`.",
        "tags": [
          "Payment requests"
        ],
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "from",
            "description": "Filter results with destination account ID"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "to",
            "description": "Filter results with source account ID"
          },
          {
            "schema": {
              "type": "string",
              "example": "TN-c0e4c660-9059-404c-ab22-761aa431766c",
              "pattern": "TN\\-[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}",
              "minLength": 39,
              "maxLength": 39
            },
            "in": "header",
            "name": "x-tenant",
            "description": "Unique Org ID."
          },
          {
            "schema": {
              "type": "string",
              "example": "c737895c-8159-4c0c-a92a-a4f8600bff37"
            },
            "in": "header",
            "name": "x-cid",
            "description": "Related correlation ID. If none is provided, a random one is generated."
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "status",
            "description": "Filter results with this payment request status"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "description": "Payment request list",
                  "uniqueItems": true,
                  "items": {
                    "$ref": "#/components/schemas/PaymentRequestItemResponse"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                },
                "examples": {
                  "No account specified": {
                    "value": {
                      "error_code": "WP2P0009",
                      "code": "WP2P0009",
                      "message": "No account specified in request."
                    }
                  },
                  "Only one account can be specified": {
                    "value": {
                      "error_code": "WP2P0009",
                      "code": "WP2P0009",
                      "message": "Request can specify only one account."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                },
                "examples": {
                  "Unable to proceed with request": {
                    "value": {
                      "error_code": "EP2P9999",
                      "code": "EP2P9999",
                      "message": "Unable to proceed with request!"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```