---
title: "List payment requests"
method: GET
path: "/payments/v1/payment-requests"
tags: ["Payment requests"]
---

# List payment requests

`GET /payments/v1/payment-requests`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/payments/v1/payment-requests`
- Auth: HTTP bearer

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

## Query parameters

- `from` string
- `to` string
- `status` string

## Headers

- `x-tenant` string
- `x-cid` string

## Response `200`

OK

- PaymentRequestItemResponse[]: Payment request list
  - `amount` number: Payment request amount.
  - `processing_code` string: Payment request processing code.
  - `to` integer: Target account ID.
  - `expiration` string: Payment request expiration date in UTC-0 (RFC3339) format.
  - `location` Location: Request latitude and longitude object.
    - `lat` number, float: Request latitude.
    - `lng` number, float: Request longitude.
  - `tracking_id` string: Optional unique ID correlating the payment request's associated credit and debit authorizations.
  - `status` 'PAID' | 'PENDING' | 'EXPIRED' | 'DELETED' | 'REJECTED' | 'CANCELLED' | 'ACTIVE': Payment request status
  - `id` string: Payment request unique ID.
  - `creation_date` string, date-time: Payment request creation date in UTC-0 (RFC3339) format.
  - `metadata` Metadata: 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. The 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. **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](ref:get-started-with-pismo-apis#metadata).

## Other responses

- `400`: Bad request
- `500`: Internal server error

---

[API](https://skmtc.dev/pismo/apis/core-platform-payment-methods.md) - [All operations](https://skmtc.dev/pismo/apis/core-platform-payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/core-platform-payment-methods/revisions/ab9e879a54e0?raw)