---
search:
  tags:
    - organization-reads
    - POST
seo:
  description: >-
    List payment provider states. An organization-scoped… Reference for the POST
    /queries/list_payment_provider_states endpoint in the Soljio Organization
    API.
sidebar:
  label: List payment provider states.
  badge: POST
title: List payment provider states.
type: openapi-operation
---
List payment provider states. An organization-scoped read using JSON filter arguments; requires payments.read. Pagination cursors must be reused only with the same organization, operation and filters.

`POST /queries/list_payment_provider_states`

**Request body** (`application/json`, required)

- `kind` (string)
- `pagination_opts` (object, required)

Request body example:

```json
{
  "kind": "checkout",
  "pagination_opts": {
    "cursor": "string",
    "num_items": 1
  }
}
```

**Responses**

- `200` — Successful read.
- `400` — invalid\_request
- `401` — unauthorized
- `403` — forbidden
- `404` — not\_found
- `405` — method\_not\_allowed
- `409` — conflict, idempotency\_conflict
- `413` — payload\_too\_large
- `415` — unsupported\_media\_type
- `429` — rate\_limited
- `500` — internal\_error

Response example, 200:

```json
{
  "data": {
    "page": [
      {
        "amount_minor": 0,
        "currency": "string",
        "failure_code": "string",
        "id": "string",
        "kind": "checkout",
        "reconciliation_state": "pending",
        "status": "string",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
    "continue_cursor": "string",
    "is_done": true,
    "split_cursor": "string",
    "page_status": "SplitRecommended"
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}
```

Response example, 400:

```json
{
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 401:

```json
{
  "error": {
    "code": "unauthorized",
    "message": "A valid service token is required."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 403:

```json
{
  "error": {
    "code": "forbidden",
    "message": "The service token lacks a required scope."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 404:

```json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 405:

```json
{
  "error": {
    "code": "method_not_allowed",
    "message": "The method is not supported for this resource."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 409:

```json
{
  "error": {
    "code": "conflict",
    "message": "The command conflicts with the current state."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 413:

```json
{
  "error": {
    "code": "payload_too_large",
    "message": "The request body exceeds the byte limit for this operation."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 415:

```json
{
  "error": {
    "code": "unsupported_media_type",
    "message": "Use application/json for command requests."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 429:

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the indicated delay."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 500:

```json
{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```
