## List payment systems

`GET /v1/pay-systems`

Finds payment systems in a Bitrix24 account that match the specified conditions. Use this method to choose a system for an order payment.

Scope: `pay_system`.

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|:--------:|-------------|
| `filter` (query) | object / string | no | Filter by [payment system fields](./fields.md). Accepts a JSON object encoded as a string or bracket parameters. Supports equality, `$eq`, arrays of values, and `$in`.<br>[Filtering syntax](/docs/filtering). Example: `?filter[id]=1` |
| `sort` (query) | string | no | Comma-separated field names. Prefix a field with `-` for descending order. Example: `?sort=-id` |
| `select` (query) | string | no | Comma-separated names of fields to return, or `*` for all fields. Example: `?select=id,name,active` |

Pagination: the method retrieves the complete list matching the filter. It does not accept `limit` or `offset`.

## Examples

### curl — personal key

```bash
curl -g "https://vibecode.bitrix24.com/v1/pay-systems?filter[id]=1&select=id,name,active&sort=-id" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl -g "https://vibecode.bitrix24.com/v1/pay-systems?filter[id]=1&select=id,name,active&sort=-id" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const response = await fetch(
  'https://vibecode.bitrix24.com/v1/pay-systems?filter%5Bid%5D=1&select=id,name,active&sort=-id',
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  },
);

console.log(await response.json());
```

### JavaScript — OAuth application

```javascript
const response = await fetch(
  'https://vibecode.bitrix24.com/v1/pay-systems?filter%5Bid%5D=1&select=id,name,active&sort=-id',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
);

console.log(await response.json());
```

## Response fields

| Field | Type | Description |
|-------|------|-------------|
| `success` | boolean | `true` on success |
| `data` | array | Array of payment systems. For record fields, see [Payment system fields](./fields.md). When `select` is provided, only the selected fields are returned |
| `meta.total` | integer | Number of records in the `data` array |

## Response example

Response to a request with `filter[id]=1`, `select=id,name,active`, and `sort=-id`:

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Bank transfer (Companies)",
      "active": "Y"
    }
  ],
  "meta": {
    "total": 1
  }
}
```

## Error response example

400 — the request includes `limit`:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Only filter, sort and select are supported; the full list has no pagination"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|------|-------------|
| 400 | `INVALID_PARAMS` | A parameter other than `filter`, `sort`, or `select` was supplied, `sort` or `select` was repeated or malformed, or a sort field was specified more than once |
| 400 | `INVALID_FILTER` | JSON and bracket parameters were mixed, or a filter condition was repeated |
| 400 | `INVALID_FILTER_SHAPE` | The filter, its conditions, or an array of values has an invalid structure |
| 400 | `INVALID_FILTER_OPERATOR` | An operator other than equality or selection from an array of values was supplied |
| 400 | `INVALID_DUPLICATE_FILTER_FIELD` | The same filter field was specified in more than one way |
| 400 | `UNKNOWN_FILTER_FIELD` | Unknown filter field. For available names, see [Payment system fields](./fields.md) |
| 400 | `UNKNOWN_SELECT_FIELD` | Unknown field in `select` |
| 400 | `UNKNOWN_SORT_FIELD` | Unknown field in `sort` |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to payment systems |
| 422 | `BITRIX_ERROR` | Bitrix24 refused the operation. The reason is provided in `error.message` |
| 502 | `BITRIX_RESPONSE_INVALID` | The Bitrix24 response has an invalid structure |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `INVALID_API_KEY` | The API key is invalid |
| 401 | `TOKEN_MISSING` | The API key has no configured Bitrix24 tokens |
| 403 | `SCOPE_DENIED` | The API key lacks the `pay_system` scope |

For the complete list of common API errors, see [Errors](/docs/errors).

## See also

- [Payment systems](/docs/entities/pay-systems)
- [Get a payment system](./get.md)
- [Payment system handlers](./handlers.md)
- [Filtering syntax](/docs/filtering)