[{"data":1,"prerenderedAt":13},["ShallowReactive",2],{"docs-entities\u002Fpay-systems":3,"docs-tabs-entities\u002Fpay-systems":6},{"content":4,"lastmod":5},"# Pay systems\n\nSelect a pay system for orders and invoices. Create your own records using a registered REST handler. Scope: `pay_system`.\n\nBuilt-in pay systems are readable. Bitrix24 permits updates and deletion only for REST-handler records; OAuth applications are also checked against handler ownership. The `sale` scope alone is insufficient.\n\n## Operations\n\n- [List](.\u002Fpay-systems\u002Flist.md) — `GET \u002Fv1\u002Fpay-systems`\n- [Get](.\u002Fpay-systems\u002Fget.md) — `GET \u002Fv1\u002Fpay-systems\u002F:id`\n- [Create](.\u002Fpay-systems\u002Fcreate.md) — `POST \u002Fv1\u002Fpay-systems`\n- [Update](.\u002Fpay-systems\u002Fupdate.md) — `PATCH \u002Fv1\u002Fpay-systems\u002F:id`\n- [Delete](.\u002Fpay-systems\u002Fdelete.md) — `DELETE \u002Fv1\u002Fpay-systems\u002F:id`\n- [Handlers](.\u002Fpay-systems\u002Fhandlers.md) — `GET \u002Fv1\u002Fpay-systems\u002Fhandlers`\n\n## Key fields\n\nPass `id` as the payment `paySystemId`. Use the `code` field from the [handler list](.\u002Fpay-systems\u002Fhandlers.md) as `bxRestHandler`. The payment list does not return a logo.\n\n[All fields](.\u002Fpay-systems\u002Ffields.md).\n\n## Before you start\n\nHandlers are registered separately: these routes only read their definitions. `active` and `newWindow` use `Y`\u002F`N` strings, not booleans.\n\nWithout `active`, a new pay system is inactive (`N`). When CRM is installed and `entityRegistryType` is omitted, the default is `CRM_INVOICE`. For orders, send `ORDER` and a payer type from that registry.\n\n## Typical workflow\n\nRead the [handler list](.\u002Fpay-systems\u002Fhandlers.md), select a `code`, create an inactive pay system, get it, update `name`, then delete only your own record. Readback can fail after a successful write: do not blindly retry creation.\n\n## Limits\n\nLists are complete, without `limit` or `offset`. `meta.total` equals the length of `data`. The `logo` field takes a `[filename, base64]` array of up to 2 MiB decoded. The JSON body limit is 3 MiB. `settings` is accepted only on creation.\n\n## Write restrictions\n\n| Record | GET | PATCH \u002F DELETE |\n|---|---|---|\n| Built-in | Yes | 403 |\n| REST | Yes | Subject to Bitrix24 rights and OAuth ownership |\n\n## See also\n\n- [Payments](\u002Fdocs\u002Fentities\u002Fpayments)\n- [CRM payments](\u002Fdocs\u002Fentities\u002Fcrm-payments)\n","2026-10-14",{"pay-systems\u002Flist.md":7,"pay-systems\u002Fget.md":8,"pay-systems\u002Fcreate.md":9,"pay-systems\u002Fupdate.md":10,"pay-systems\u002Fdelete.md":11,"pay-systems\u002Fhandlers.md":12},"## List payment systems\n\n`GET \u002Fv1\u002Fpay-systems`\n\nFinds payment systems in a Bitrix24 account that match the specified conditions. Use this method to choose a system for an order payment.\n\nScope: `pay_system`.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|-----------|------|:--------:|-------------|\n| `filter` (query) | object \u002F string | no | Filter by [payment system fields](.\u002Ffields.md). Accepts a JSON object encoded as a string or bracket parameters. Supports equality, `$eq`, arrays of values, and `$in`.\u003Cbr>[Filtering syntax](\u002Fdocs\u002Ffiltering). Example: `?filter[id]=1` |\n| `sort` (query) | string | no | Comma-separated field names. Prefix a field with `-` for descending order. Example: `?sort=-id` |\n| `select` (query) | string | no | Comma-separated names of fields to return, or `*` for all fields. Example: `?select=id,name,active` |\n\nPagination: the method retrieves the complete list matching the filter. It does not accept `limit` or `offset`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -g \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems?filter[id]=1&select=id,name,active&sort=-id\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl -g \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems?filter[id]=1&select=id,name,active&sort=-id\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst response = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems?filter%5Bid%5D=1&select=id,name,active&sort=-id',\n  {\n    headers: {\n      'X-Api-Key': 'YOUR_API_KEY',\n    },\n  },\n);\n\nconsole.log(await response.json());\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems?filter%5Bid%5D=1&select=id,name,active&sort=-id',\n  {\n    headers: {\n      'X-Api-Key': 'YOUR_APP_KEY',\n      'Authorization': 'Bearer USER_SESSION_TOKEN',\n    },\n  },\n);\n\nconsole.log(await response.json());\n```\n\n## Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `success` | boolean | `true` on success |\n| `data` | array | Array of payment systems. For record fields, see [Payment system fields](.\u002Ffields.md). When `select` is provided, only the selected fields are returned |\n| `meta.total` | integer | Number of records in the `data` array |\n\n## Response example\n\nResponse to a request with `filter[id]=1`, `select=id,name,active`, and `sort=-id`:\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"name\": \"Bank transfer (Companies)\",\n      \"active\": \"Y\"\n    }\n  ],\n  \"meta\": {\n    \"total\": 1\n  }\n}\n```\n\n## Error response example\n\n400 — the request includes `limit`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Only filter, sort and select are supported; the full list has no pagination\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|------|-------------|\n| 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 |\n| 400 | `INVALID_FILTER` | JSON and bracket parameters were mixed, or a filter condition was repeated |\n| 400 | `INVALID_FILTER_SHAPE` | The filter, its conditions, or an array of values has an invalid structure |\n| 400 | `INVALID_FILTER_OPERATOR` | An operator other than equality or selection from an array of values was supplied |\n| 400 | `INVALID_DUPLICATE_FILTER_FIELD` | The same filter field was specified in more than one way |\n| 400 | `UNKNOWN_FILTER_FIELD` | Unknown filter field. For available names, see [Payment system fields](.\u002Ffields.md) |\n| 400 | `UNKNOWN_SELECT_FIELD` | Unknown field in `select` |\n| 400 | `UNKNOWN_SORT_FIELD` | Unknown field in `sort` |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to payment systems |\n| 422 | `BITRIX_ERROR` | Bitrix24 refused the operation. The reason is provided in `error.message` |\n| 502 | `BITRIX_RESPONSE_INVALID` | The Bitrix24 response has an invalid structure |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n| 401 | `INVALID_API_KEY` | The API key is invalid |\n| 401 | `TOKEN_MISSING` | The API key has no configured Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The API key lacks the `pay_system` scope |\n\nFor the complete list of common API errors, see [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Payment systems](\u002Fdocs\u002Fentities\u002Fpay-systems)\n- [Get a payment system](.\u002Fget.md)\n- [Payment system handlers](.\u002Fhandlers.md)\n- [Filtering syntax](\u002Fdocs\u002Ffiltering)\n","## Get a payment system\n\n`GET \u002Fv1\u002Fpay-systems\u002F:id`\n\nRetrieves a payment system by its ID. Use this method to check its settings before creating an order payment.\n\nScope: `pay_system`.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|-----------|------|:--------:|-------------|\n| `id` (path) | integer | yes | Positive integer payment system ID. Source: [List payment systems](.\u002Flist.md) |\n\nThis method takes no query parameters after `?`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n});\n\nconsole.log(await response.json());\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n});\n\nconsole.log(await response.json());\n```\n\n## Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `success` | boolean | `true` on success |\n| `data` | object | Payment system object. For all fields, see [Payment system fields](.\u002Ffields.md) |\n\n## Response example\n\nMain fields are shown. For all fields, see [Payment system fields](.\u002Ffields.md).\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 41,\n    \"name\": \"Invoice payment\",\n    \"psaName\": \"Invoice payment\",\n    \"description\": null,\n    \"newWindow\": \"N\",\n    \"sort\": 100,\n    \"active\": \"N\",\n    \"entityRegistryType\": \"ORDER\",\n    \"personTypeId\": 5,\n    \"xmlId\": \"invoice-20261014\"\n  }\n}\n```\n\n## Error response example\n\n404 — payment system not found:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Entity not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|------|-------------|\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer within the JavaScript safe integer range, or query parameters after `?` were supplied |\n| 404 | `ENTITY_NOT_FOUND` | No payment system with the specified `id` was found |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to the payment system |\n| 422 | `BITRIX_ERROR` | Bitrix24 refused the operation. The reason is provided in `error.message` |\n| 502 | `BITRIX_RESPONSE_INVALID` | The Bitrix24 response has an invalid structure |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n| 401 | `INVALID_API_KEY` | The API key is invalid |\n| 401 | `TOKEN_MISSING` | The API key has no configured Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The API key lacks the `pay_system` scope |\n\nFor the complete list of common API errors, see [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Payment systems](\u002Fdocs\u002Fentities\u002Fpay-systems)\n- [List payment systems](.\u002Flist.md)\n- [Payment system handlers](.\u002Fhandlers.md)\n","## Create a pay system\n\n`POST \u002Fv1\u002Fpay-systems`\n\nCreates a pay system using a registered REST handler. Send the fields directly in the JSON body, without a `fields` wrapper.\n\n## Request body fields\n\n|Field|Type|Required|Description|\n|---|---|---|---|\n|`name`|string|yes|Pay system name. Must not be empty.|\n|`personTypeId`|integer|yes|Payer type ID from [`GET \u002Fv1\u002Fperson-types`](\u002Fdocs\u002Fentities\u002Fperson-types\u002Flist). Must belong to the registry specified in `entityRegistryType`.|\n|`bxRestHandler`|string|yes|Handler code from the `code` field returned by [`GET \u002Fv1\u002Fpay-systems\u002Fhandlers`](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fhandlers). The handler must already be registered.|\n|`description`|string|no|Pay system description.|\n|`active`|string|no|Activity flag: `Y` for active, `N` for inactive.|\n|`newWindow`|string|no|Open the payment page in a new window: `Y` or `N`.|\n|`xmlId`|string|no|External ID.|\n|`logo`|array|no|Logo as `[filename, base64]`. Decoded file size must not exceed 2 MiB.|\n|`settings`|object \\| array|no|Handler settings with the original business keys. Each entry must be an object or array using `TYPE` and `VALUE`.|\n|`entityRegistryType`|string|no|Registry: `ORDER`, `CRM_INVOICE` or `CRM_QUOTE`. Use `ORDER` for orders.|\n\nSend a nonempty JSON object. Fields outside the table are rejected.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"Invoice payment\",\n    \"personTypeId\": 5,\n    \"bxRestHandler\": \"my_payment_handler\",\n    \"entityRegistryType\": \"ORDER\",\n    \"active\": \"N\",\n    \"xmlId\": \"invoice-20261014\"\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"Invoice payment\",\n    \"personTypeId\": 5,\n    \"bxRestHandler\": \"my_payment_handler\",\n    \"entityRegistryType\": \"ORDER\",\n    \"active\": \"N\",\n    \"xmlId\": \"invoice-20261014\"\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    \"name\": \"Invoice payment\",\n    \"personTypeId\": 5,\n    \"bxRestHandler\": \"my_payment_handler\",\n    \"entityRegistryType\": \"ORDER\",\n    \"active\": \"N\",\n    \"xmlId\": \"invoice-20261014\"\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    \"name\": \"Invoice payment\",\n    \"personTypeId\": 5,\n    \"bxRestHandler\": \"my_payment_handler\",\n    \"entityRegistryType\": \"ORDER\",\n    \"active\": \"N\",\n    \"xmlId\": \"invoice-20261014\"\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\nHTTP 201. Returns the created pay system.\n\n|Field|Type|Description|\n|---|---|---|\n|`success`|boolean|Always `true` on success.|\n|`data`|object|Created pay system. Full field reference: [Pay system fields](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Ffields).|\n\n## Response example\n\nMain fields are shown. Full field reference: [Pay system fields](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Ffields).\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 41,\n    \"name\": \"Invoice payment\",\n    \"actionFile\": \"my_payment_handler\",\n    \"newWindow\": \"N\",\n    \"active\": \"N\",\n    \"entityRegistryType\": \"ORDER\",\n    \"personTypeId\": 5,\n    \"xmlId\": \"invoice-20261014\"\n  }\n}\n```\n\n## Error response example\n\n400 — the request body contains the unsupported field `unexpected`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"READONLY_FIELD\",\n    \"message\": \"Field 'unexpected' is not writable for this operation\"\n  }\n}\n```\n\n## Errors\n\n|HTTP|Code|Description|\n|---|---|---|\n|400|`INVALID_PARAMS`|A field has an invalid type, the logo has an invalid format, or a settings entry is not an object or array.|\n|400|`MISSING_REQUIRED_FIELDS`|The JSON body is empty, a required field is missing, or `name` is empty.|\n|400|`READONLY_FIELD`|The body contains a field not supported by this operation.|\n|413|`PAYLOAD_TOO_LARGE`|The decoded logo exceeds 2 MiB or the JSON body exceeds 3 MiB.|\n|404|`ENTITY_NOT_FOUND`|The created pay system was not found during the subsequent read.|\n|403|`BITRIX_ACCESS_DENIED`|Access to the create operation is denied.|\n|422|`BITRIX_ERROR`|A business error occurred. Details are in `error.message`.|\n|502|`BITRIX_RESPONSE_INVALID`|The response to the operation or subsequent read has an invalid structure.|\n|403|`SCOPE_DENIED`|The API key lacks the `pay_system` scope.|\n|403|`WRITE_BLOCKED_READONLY_KEY`|The key is restricted to read operations.|\n|401|`TOKEN_MISSING`|The key has no configured Bitrix24 credentials.|\n\nFor common API errors, see [Error codes](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Flist)\n- [Get a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fget)\n- [Update a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fupdate)\n- [Delete a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fdelete)\n- [Pay system handlers](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fhandlers)\n- [Pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems)\n","## Update a pay system\n\n`PATCH \u002Fv1\u002Fpay-systems\u002F:id`\n\nUpdates selected fields of a pay system. Send the fields directly in the JSON body, without a `fields` wrapper.\n\n## Parameters\n\n|Parameter|Type|Required|Description|\n|---|---|---|---|\n|`id` (path)|integer|yes|Positive integer ID of the pay system. Source: [`GET \u002Fv1\u002Fpay-systems`](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Flist).|\n\n## Request body fields\n\n|Field|Type|Required|Description|\n|---|---|---|---|\n|`name`|string|no|New pay system name. Must not be empty.|\n|`personTypeId`|integer|no|Payer type ID from [`GET \u002Fv1\u002Fperson-types`](\u002Fdocs\u002Fentities\u002Fperson-types\u002Flist). Must belong to the pay system's registry.|\n|`bxRestHandler`|string|no|Handler code from the `code` field returned by [`GET \u002Fv1\u002Fpay-systems\u002Fhandlers`](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fhandlers).|\n|`description`|string|no|Pay system description.|\n|`active`|string|no|Activity flag: `Y` for active, `N` for inactive.|\n|`newWindow`|string|no|Open the payment page in a new window: `Y` or `N`.|\n|`xmlId`|string|no|External ID.|\n|`logo`|array|no|Logo as `[filename, base64]`. Decoded file size must not exceed 2 MiB.|\n\nSend a nonempty JSON object. Fields outside the table are rejected.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"Business invoice payment\"\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"Business invoice payment\"\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    \"name\": \"Business invoice payment\"\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    \"name\": \"Business invoice payment\"\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\nHTTP 200. Returns the updated pay system.\n\n|Field|Type|Description|\n|---|---|---|\n|`success`|boolean|Always `true` on success.|\n|`data`|object|Updated pay system. Full field reference: [Pay system fields](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Ffields).|\n\n## Response example\n\nMain fields are shown. Full field reference: [Pay system fields](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Ffields).\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 41,\n    \"name\": \"Business invoice payment\",\n    \"actionFile\": \"my_payment_handler\",\n    \"newWindow\": \"N\",\n    \"active\": \"N\",\n    \"entityRegistryType\": \"ORDER\",\n    \"personTypeId\": 5,\n    \"xmlId\": \"invoice-20261014\"\n  }\n}\n```\n\n## Error response example\n\n400 — the request body contains the unsupported field `unexpected`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"READONLY_FIELD\",\n    \"message\": \"Field 'unexpected' is not writable for this operation\"\n  }\n}\n```\n\n## Errors\n\n|HTTP|Code|Description|\n|---|---|---|\n|400|`INVALID_PARAMS`|`id` is not a positive integer, a field has an invalid type, or the logo has an invalid format.|\n|400|`MISSING_REQUIRED_FIELDS`|The JSON body is empty or `name` is empty.|\n|400|`READONLY_FIELD`|The body contains a field not supported by this operation.|\n|413|`PAYLOAD_TOO_LARGE`|The decoded logo exceeds 2 MiB or the JSON body exceeds 3 MiB.|\n|404|`ENTITY_NOT_FOUND`|The pay system was not found during the update or subsequent read.|\n|403|`BITRIX_ACCESS_DENIED`|Insufficient permissions, a built-in pay system, or the OAuth application does not own the handler.|\n|422|`BITRIX_ERROR`|A business error occurred. Details are in `error.message`.|\n|502|`BITRIX_RESPONSE_INVALID`|The response to the operation or subsequent read has an invalid structure.|\n|403|`SCOPE_DENIED`|The API key lacks the `pay_system` scope.|\n|403|`WRITE_BLOCKED_READONLY_KEY`|The key is restricted to read operations.|\n|401|`TOKEN_MISSING`|The key has no configured Bitrix24 credentials.|\n\nFor common API errors, see [Error codes](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Flist)\n- [Get a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fget)\n- [Create a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fcreate)\n- [Delete a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fdelete)\n- [Pay system handlers](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fhandlers)\n- [Pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems)\n","## Delete a pay system\n\n`DELETE \u002Fv1\u002Fpay-systems\u002F:id`\n\nDeletes a pay system by ID. Deleted records cannot be restored through the API.\n\n## Parameters\n\n|Parameter|Type|Required|Description|\n|---|---|---|---|\n|`id` (path)|integer|yes|Positive integer ID of the pay system. Source: [`GET \u002Fv1\u002Fpay-systems`](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Flist).|\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002F41', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\nHTTP 200.\n\n|Field|Type|Description|\n|---|---|---|\n|`success`|boolean|Always `true` on success.|\n|`data`|boolean|`true` when deletion is confirmed.|\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": true\n}\n```\n\n## Error response example\n\n404 — the pay system was not found:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Entity not found\"\n  }\n}\n```\n\n## Errors\n\n|HTTP|Code|Description|\n|---|---|---|\n|400|`INVALID_PARAMS`|`id` is not a positive integer.|\n|404|`ENTITY_NOT_FOUND`|The pay system does not exist.|\n|403|`BITRIX_ACCESS_DENIED`|Insufficient permissions, a built-in pay system, or the OAuth application does not own the handler.|\n|422|`BITRIX_ERROR`|A business error occurred. Details are in `error.message`.|\n|502|`BITRIX_RESPONSE_INVALID`|The response to the operation has an invalid structure.|\n|403|`SCOPE_DENIED`|The API key lacks the `pay_system` scope.|\n|403|`WRITE_BLOCKED_READONLY_KEY`|The key is restricted to read operations.|\n|401|`TOKEN_MISSING`|The key has no configured Bitrix24 credentials.|\n\nFor common API errors, see [Error codes](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Flist)\n- [Get a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fget)\n- [Create a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fcreate)\n- [Update a pay system](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Fupdate)\n- [Pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems)\n","## List pay system handlers\n\n`GET \u002Fv1\u002Fpay-systems\u002Fhandlers`\n\nChoose a registered REST handler when creating a pay system in your Bitrix24 account.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002Fhandlers\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002Fhandlers\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002Fhandlers', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data, meta } = await response.json()\nconsole.log(data)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fpay-systems\u002Fhandlers', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data, meta } = await response.json()\nconsole.log(data)\n```\n\n## Response fields\n\n| Field | Type | Required | Description |\n|---|---|---|---|\n| `success` | boolean | yes | `true` for a successful request |\n| `data` | array | yes | List of registered REST handlers for pay systems |\n| `data[].id` | integer | no | Handler ID |\n| `data[].name` | string | no | Handler name |\n| `data[].code` | string | no | Handler code |\n| `data[].sort` | integer | no | Handler sort value |\n| `data[].description` | string | no | Handler description |\n| `data[].settings` | object \u002F array | no | Handler settings definition. The structure and nested keys depend on the handler |\n| `data[].profiles` | array | no | Handler profile definitions |\n| `meta` | object | yes | List metadata |\n| `meta.total` | integer | yes | Number of handlers in `data` |\n\nHandler fields are included in the response if they are present in the handler definition. An empty `data` array means there are no registered REST handlers.\n\n## Response example\n\nThe example shows the main handler fields. See the [response fields table](#response-fields) for the full structure.\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"code\": \"my_payment_handler\",\n      \"sort\": 100\n    },\n    {\n      \"id\": 3,\n      \"code\": \"my_qr_handler\",\n      \"sort\": 100\n    }\n  ],\n  \"meta\": {\n    \"total\": 2\n  }\n}\n```\n\n## Error response example\n\n400 — the request includes the query parameter `limit=1`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Handlers have no query parameters\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|---|---|---|\n| 400 | `INVALID_PARAMS` | The request includes query parameters. This method accepts none |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to the handlers |\n| 422 | `BITRIX_ERROR` | The operation failed in Bitrix24. See `error.message` for details |\n| 502 | `BITRIX_RESPONSE_INVALID` | The response has an invalid structure |\n| 401 | `TOKEN_MISSING` | The key has no configured Bitrix24 access tokens |\n| 403 | `SCOPE_DENIED` | The key lacks the `pay_system` scope |\n\nFor the full list of common API errors, see [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Pay systems](\u002Fdocs\u002Fentities\u002Fpay-systems)\n- [Errors](\u002Fdocs\u002Ferrors)\n",1795000360777]