## Get a payment system

`GET /v1/pay-systems/:id`

Retrieves a payment system by its ID. Use this method to check its settings before creating an order payment.

Scope: `pay_system`.

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|:--------:|-------------|
| `id` (path) | integer | yes | Positive integer payment system ID. Source: [List payment systems](./list.md) |

This method takes no query parameters after `?`.

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/pay-systems/41" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/pay-systems/41" \
  -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/41', {
  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/41', {
  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` | object | Payment system object. For all fields, see [Payment system fields](./fields.md) |

## Response example

Main fields are shown. For all fields, see [Payment system fields](./fields.md).

```json
{
  "success": true,
  "data": {
    "id": 41,
    "name": "Invoice payment",
    "psaName": "Invoice payment",
    "description": null,
    "newWindow": "N",
    "sort": 100,
    "active": "N",
    "entityRegistryType": "ORDER",
    "personTypeId": 5,
    "xmlId": "invoice-20261014"
  }
}
```

## Error response example

404 — payment system not found:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Entity not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|------|-------------|
| 400 | `INVALID_PARAMS` | `id` is not a positive integer within the JavaScript safe integer range, or query parameters after `?` were supplied |
| 404 | `ENTITY_NOT_FOUND` | No payment system with the specified `id` was found |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to the payment system |
| 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)
- [List payment systems](./list.md)
- [Payment system handlers](./handlers.md)